Skip to content

Document the ssl info contribution #45568

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

Open
wilkinsona opened this issue May 15, 2025 · 3 comments
Open

Document the ssl info contribution #45568

wilkinsona opened this issue May 15, 2025 · 3 comments
Labels
type: documentation A documentation update
Milestone

Comments

@wilkinsona
Copy link
Member

wilkinsona commented May 15, 2025

It should be documented in https://docs.spring.io/spring-boot/api/rest/actuator/info.html.

@wilkinsona wilkinsona added this to the 3.3.x milestone May 15, 2025
@wilkinsona wilkinsona added the type: documentation A documentation update label May 15, 2025
@wilkinsona wilkinsona modified the milestones: 3.3.x, 3.4.x May 15, 2025
@ElectScholar
Copy link

Hello!

I'm very interested in Spring Boot and have been looking for opportunities to learn more about the codebase and contribute to the project. I came across this task and was wondering if it would be a good starting point for a new contributor like me.

I've read through the Contributing.adoc and I’d love the chance to help out and hope to become a valuable contributor to the project.

Thanks for your time.

@wilkinsona
Copy link
Member Author

wilkinsona commented May 17, 2025

Thanks very much for the offer, @ElectScholar.

I'm not sure how suitable this issue might be. If you're looking for an issue that's straightforward or where more guidance is available, keep an eye out for those labelled with status: ideal-for-contribution An issue that a contributor can help us with .

That said, if you want to give this one a shot, you're welcome to do so. It'll require changes to InfoEndpointDocumentationTests to declare an SslInfoContributor and use Spring REST Docs to produce documentation snippets describing its output. Those snippets can then be included in the documentation for the info endpoint.

Please let us know if you decide to give this a try so that we can assign the issue to you and avoid any duplication of effort.

@ElectScholar
Copy link

Ok for now I will take your word for it and continue to search for other tasks. Thanks again!

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

No branches or pull requests

2 participants