[Starlingx-discuss] StarlingX Documentation Initial Template

[Arce Moreno, Abraham]

Dean,

Here you have the high level overview of tasks to get started with our " StarlingX Documentation".
@Hayde has raised her hand to help in this short term not time consuming assignment.

Objective: Create a first "Gold Initial Commit" based in "Stx-Docs" project including high level requirements
from OpenStack Documentation Guidelines so it can ported into the rest of our StarlingX projects.

Phase 1:
1. Learning Resources
1.1 Read "OpenStack Documentation Contributor Guide"
       https://docs.openstack.org/doc-contrib-guide/index.html
2. Initial Code
2.1 Understand existing "Stx-Docs" repository and "docs/" implementation
       https://review.openstack.org/#/q/project:openstack/stx-docs
3. Translate important topics from "OpenStack Documentation Contributor Guide" into "Stx-Docs" commits:
3.1 Project guide setup
3.2 Writing documentation
3.3 Writing style
3.4 Building documentation
3.5 Landing pages on docs.openstack.org
4. Get Final Gerrit Reviews on commits and make changes
5. Have our "Gold Initial Commit" ready

Phase 2:
Once the first interaction is done we can take another repository to test our "Gold Initial Commit"
having only modifications at the content level.

Phase 3:
With 2 interactions we are ready to easily move what we have learned and implemented in 2 projects to
the rest of our StarlingX projects.

Happy to hear your thoughts.