search

opendevstack / ods-core

The core of OpenDevStack - infrastructure setup based on Atlassian tools, Jenkins, Nexus, SonarQube and shared images
Apache License 2.0
47 stars 34 forks source link

Move devenv docs to Antora #695

Open michaelsauter opened 4 years ago

michaelsauter commented 4 years ago

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.

georgfedermann commented 4 years ago

will look into it today

michaelsauter commented 4 years ago

@georgfedermann No stress, just wanted to note it down :)