OpenLiberty / OpenLiberty/docs
Updates to auto-generated doc
Open
Nobody has claimed this yet.
epic
- Dominant language
- No language data
- Stars
- 14
- Forks
- 58
- Avg merge
- 4m
- Merged PRs (30d)
- 35
Description
We have several issues open that involve updates to the auto-generated doc in OL. Most of them will require help from the development team. They're in priority order:
- Build the messages into the OL doc so that they're searchable
- Build the Liberty API/SPI into the OL docs
- Add the Maven/Gradle coordinates for the APIs
- Generate tracing group information on in server configuration doc
- Link from the configuration elements to the feature doc
- Enable cross-linking between the feature doc and the API/SPI doc
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the six linked Open Liberty issues, in the priority order listed, since this issue does not identify a file, test, or entry point. The work is complete only when the selected auto-generated documentation update is implemented and its corresponding linked issue has clear verification, but the scope spans several separate changes.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100