OpenLiberty / OpenLiberty/docs
Build Maven docs into the OL docs
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 14
- Forks
- 58
- Avg merge
- 4m
- Merged PRs (30d)
- 35
Description
We need to build some of the Maven docs into the OL docs. The Maven docs may first need to be converted into AsciiDoc and then assessed to determine how we want to break them up and pull them into the OL docs. We may also want to do some editing of the Maven docs before pulling them in.
See #1611 for a similar issue with Gradle docs. Consider these together.
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 with the Maven documentation in the linked OpenLiberty/ci.maven repository and compare issue #1611 for the related Gradle work. Assess what must be converted to AsciiDoc, how it should be divided and incorporated into the OL docs, and which edits are needed; done means the agreed Maven content is integrated into the OL docs.
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