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

Generated docs as maven site page #335

Open
patpatpat123 opened this issue Jan 17, 2025 · 1 comment
Open

Generated docs as maven site page #335

patpatpat123 opened this issue Jan 17, 2025 · 1 comment
Labels
enhancement New feature or request help wanted Help on this is appreciated
Milestone

Comments

@patpatpat123
Copy link

Hello,

Just wanted to reach out with a small enhancement request.
The micrometer doc is very cool.

As of now, it seems the final index.html file is standalone.
We have a script which copies it, then forward it to our internal SRE team for instance.

Like many java springboot projects, we use maven.
Maven offers a goal called site, which builds a website.
This is what ours looks like, but there are many fancier, cooler, more beautiful, with more internal pages, etc...

Image

It would be great if the page generated by micrometer docs can directly integrate into maven site.

Rational: for projects using maven site, users are already familiar with site and usually go there for java doc and other doc.
It is a natural place to go to for observation docs.

Thank you for your time.

@shakuzen
Copy link
Member

That's a great idea. Thanks for sharing it. Would this be something you're interested in contributing as a pull request?

@shakuzen shakuzen added enhancement New feature or request help wanted Help on this is appreciated labels Jan 20, 2025
@shakuzen shakuzen added this to the 1.x milestone Jan 20, 2025
@shakuzen shakuzen changed the title [Enhancement request] micrometer doc to be merged and available as a maven site page Generated docs as maven site page Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Help on this is appreciated
Projects
None yet
Development

No branches or pull requests

2 participants