opendevstack / opendevstack/ods-core
Move devenv docs to Antora
@georgfedermann is already working on this.
Since Jul 7, 2020.
- Dominant language
- Shell
- Stars
- 53
- Forks
- 34
- Avg merge
- 3h 26m
- Merged PRs (30d)
- 1
Description
The devenv is currently documented mainly in https://github.com/opendevstack/ods-core/blob/master/ods-devenv/README.md. That is quite hidden - it would be good to surface it in the rendered documentation at https://www.opendevstack.org/ods-documentation. To do that, the Markdown needs to be converted to Asciidoctor, moved to docs folder and referenced somewhere from the navigation.
@georgfedermann Let me know if you need help. https://www.opendevstack.org/ods-documentation/opendevstack/3.x/contributing/documentation.html describes how the general process works.
Contributor guide
No contributing guide indexed for this repository
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.
Assessment
This issue has not been assessed yet.