-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Use BOM for Micrometer dependency examples in reference docs #5652
Conversation
Should we do this starting from |
Yes, I think we should do it in all the Antora-based docs. |
I think another option that Jonatan mentioned offline is we could go in the direction of either showing how to configure the BOM in the install snippet, or we could link to another section of the docs that talks about setting up the BOM. Then we could remove the version from individual dependency declarations and mention that it's expected to use the BOM so you don't need to declare explicit versions on dependencies. That is probably better since we do expect the version to be managed for the vast majority of users, and we do not want to encourage people to declare the version at the level of individual dependencies. @izeye would you be willing to update the pull request to that effect if you don't see any issues with that approach? |
@shakuzen Thanks for the feedback! Sounds good. I'll try to update this in that direction. By the way, did you mean to apply this to 1.13.x, not to 1.12.x? 1.12.x also seems to be Antora-based although it seems to be soon to be EOLed for OSS support. |
I should have left a comment on that. We should target and apply this to |
@shakuzen Thanks for the explanation! I switched the base branch to |
@jonatan-ivanov Looks great. Thank you! |
@izeye I talked to Tommy and we were thinking if it is better to have the BOM instructions in the in install section and everywhere else place a link to it. Tommy's guess was if we duplicate it everywhere, people might not understand and have duplicate BOM declarations. I made these changes on the PR, what do you think? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Looks good to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. I just had one suggestion on wording. Let me know what you think.
Co-authored-by: Tommy Ludwig <8924140+shakuzen@users.noreply.github.com>
This PR changes to use Micrometer version for Micrometer dependency examples in reference docs.
See gh-5093