Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a Maven coordinates section into the generated feature config docs? #7663

Open
lauracowen opened this issue Oct 31, 2024 · 2 comments
Open
Assignees
Milestone

Comments

@lauracowen
Copy link
Member

Assuming the Maven coordinates are predictable for a given feature (version number aside), can we add them to the feature config reference docs? Gradle as well, I guess, but Maven primarily.

@dmuelle dmuelle added this to the 24.0.0.12 milestone Oct 31, 2024
@dmuelle dmuelle self-assigned this Oct 31, 2024
@dmuelle
Copy link
Member

dmuelle commented Oct 31, 2024

Hi Laura- I think this needs to go to the main open liberty dev repo, since the change would have to be made to the doc generator, which is maintained by the kernel team. But Im also not sure I understand the context- do we document the cooridnates for each feature anywhere? Does the user have to supply these in the pom.xml for any feature they want to enable?

@lauracowen
Copy link
Member Author

I think the user does have to supply these in the pom.xml and I don't think it's that obvious what exactly to include.

I spoke to Alasdair about it and he says it's meant to be being added to the generator. So there may already be an issue there (I don't know) and I don't know when it's likely to get done.

The reason I raised it was because that "prepare the environment" topic includes Maven coordinates and the obvious question in getting rid of that topic would be where to put that info (the feature config info is obviously in the existing generated doc and any examples could be added if necessary). Maybe as a stop-gap, an extra section could be added with what we have for Maven coordinates for that particular feature? It's nasty but no worse than trying to document them ad hoc in "task" topics. It would also be useful from a design perspective of working out where the Maven coordinates should go in the generated docs for when the generation work does get done?

In terms of where to get the coordinates - I don't know. I would hope there is something that can generate them for each feature when that work is done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants