jakartaee / jakartaee/common-annotations-api

DataSourceDefinition docs are confusing

Open
#151 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
67
Forks
42
PR merge metrics
No merged PRs in 30d

Description

https://jakarta.ee/specifications/platform/11/apidocs/jakarta/annotation/sql/datasourcedefinition:

> In the above example, the databaseName, user and serverName properties were specified as part of the url property and using the corresponding annotation elements. This should be avoided.

There is no example above it.

Also, the correct way to configure a data source in production, e.g., without specifying credentials, should be discussed. Saying "here is how the annotation can be used, don't use it like that" doesn't help much. Tell the user how it *should* be used.

> If the properties annotation element is used and contains a DataSource property that was also specified using the corresponding annotation element, the annotation element value takes precedence. For example:
>
> This would result in the following values being used when configuring the DataSource:

There is no example here either.

> Examples:
>
> Using a URL:
>
> An example lookup of the DataSource from an Jakarta Enterprise Beans:

There's nothing here either.

Looks like your `@snippet` tags aren't being rendered.

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

Start with the DataSourceDefinition API documentation at the linked Jakarta EE URL and inspect how its @snippet tags are rendered in this repository. Add the missing examples, explain a production configuration without embedded credentials, and clarify the precedence behavior; done means the examples and guidance are visible and accurate in the generated documentation.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.