micronaut-projects / micronaut-projects/micronaut-data

Unresolved reference: Repository

Open
#3,258 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: docs
Dominant language
Java
Stars
482
Forks
229
Avg merge
1d 7h
Merged PRs (30d)
32

Description

### Expected Behavior

I'm trying to add micronaut-data to an existing project. The docs say to add the following to gradle, which doesn't work:
```kotlin
annotationProcessor("io.micronaut.data:micronaut-data-processor")
```

I'm getting the error `Unresolved reference: Repository` when I try to add the `@Repository` annotation to an interface. The docs mention a runtime dependency, but they don't tell what it is. This is basic stuff guys, I shouldn't have to do an hour of research to figure out all of the required packages, this needs to be in the docs. The docs seem to assume that you're going to regenerate a new micronaut starter project every time, which isn't convenient at all.

After further research, it looks like there are a variety of possible dependencies scattered throughout the docs. These should all be moved to up at the top under the `Build Configuration` heading, and it should be clearly stated that you have to install one of them. As a user, I should be able to install micronaut-data and start using it quickly, without having to read and understand the entire documentation. There needs to be a "getting started" section that clearly states what you need to do to install it and get started, just like most other libraries.

### Actual Behaviour

The docs should correctly state how to install micronaut-data.

### Steps To Reproduce

_No response_

### Environment Information

_No response_

### Example Application

_No response_

### Version

Latest

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the micronaut-data documentation's Build Configuration content and the dependency examples scattered through the docs. First compare the documented annotationProcessor setup with the runtime dependencies needed for the @Repository example. Done means a newcomer can find a getting-started section, identify the required dependency options, and install micronaut-data without reading the full documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, kotlin
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.