micrometer-metrics / micrometer-metrics/micrometer-docs-generator
Generated docs as maven site page
- Dominant language
- Java
- Stars
- 18
- Forks
- 15
- Avg merge
- 2m
- Merged PRs (30d)
- 6
Description
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...
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.
Contributor guide
Research direction
Start by tracing how the final index.html is generated, then review the Maven site goal and how generated pages are incorporated into a site. Confirm the expected output with a Maven site build; done means the generated Micrometer documentation integrates into the Maven site rather than requiring a standalone copied file.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100