Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Antorra docs need to be updated with latest master #245

Closed
clemensutschig opened this issue Oct 5, 2019 · 2 comments
Closed

Antorra docs need to be updated with latest master #245

clemensutschig opened this issue Oct 5, 2019 · 2 comments
Assignees
Labels
bug Something isn't working

Comments

@clemensutschig
Copy link
Member

clemensutschig commented Oct 5, 2019

Describe the bug
Masters Readme is ahead of antorra docs

@tjaeschke fya

@clemensutschig clemensutschig added the bug Something isn't working label Oct 5, 2019
@stefanlack
Copy link
Contributor

@clemensutschig the content of https://github.com/opendevstack/ods-provisioning-app/blob/master/README.md is not shown at the page https://www.opendevstack.org/ods-documentation/ods-provisioning-app/latest/index.html.

Page https://www.opendevstack.org/ods-documentation/common/latest/documentation.html explains, how the antorra documentation is build:

The documentation is contained in the doc subdirectory of every project. Every doc directory is the root of an Antora Component. We have additional projects containing the playbook and the UI customization.

I will move / merge the content from the Readme.md file to right place at https://github.com/opendevstack/ods-provisioning-app/blob/master/docs/modules/ROOT/pages/index.adoc and I will take care, that no information is duplicated between these locations.

Finaly, if will add a short text / link to the new documentation location.

stefanlack added a commit to opendevstack/ods-documentation that referenced this issue Oct 7, 2019
stefanlack added a commit that referenced this issue Oct 7, 2019
stefanlack added a commit that referenced this issue Oct 7, 2019
* restructure documentation

* improve documentation: #245
@stefanlack
Copy link
Contributor

Done. opendevstack/ods-documentation#12

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
No open projects
Development

No branches or pull requests

2 participants