[Starlingx-discuss] StarlingX Documentation Initial Template

Arce Moreno, Abraham abraham.arce.moreno at intel.com
Thu Aug 9 05:38:19 UTC 2018


Thanks Greg, Dean!

> > ( I’m assuming that it will NOT be API documentation, I see
> > discussions on that elsewhere.  And would be located at
> > https://developer.openstack.org/api-ref/starlingx/ ??? )
> 
> The actual location has not been finalized yet.  I imagine it to be something
> like docs.starlingx.io.

Taking stx-metal as our initial repository, please find both patches to review:

    [0] [Doc] OpenStack Documentation Contributor Guide 
    [1] [Doc] OpenStack API Reference Guide

Under Documentation and Infrastructure Sub-project [2] I  am
pointing to 2 wiki pages to document our analysis, learnings, tasks and
updates:

    [3] StarlingX/Documentation
    [4] StarlingX/Developer_Guide/API_Documentation

I will work on enabling API Guide and Release Notes for stx-metal to
to enable the "gold commit pack" to easily take to the rest of the projects where
needed.

> > so I’ll volunteer on being a core reviewer for this StarlingX
> > Documentation ... please add me to the appropriate email lists.
> 
> You're on it!  We are trying really hard to stay on a single list and use subject
> tags for filtering.

Welcome Greg!

[0] https://review.openstack.org/#/c/590094
[1] https://review.openstack.org/#/c/590097
[2] https://wiki.openstack.org/wiki/StarlingX/Docs_and_Infra
[3] https://wiki.openstack.org/wiki/StarlingX/Documentation
[4] https://wiki.openstack.org/wiki/StarlingX/Developer_Guide/API_Documentation




More information about the Starlingx-discuss mailing list