[Starlingx-discuss] [docs] Setting up the docs.starlingx.io website

Martinez Monroy, Elio elio.martinez.monroy at intel.com
Mon Sep 3 18:28:27 UTC 2018


Sorry for my comment,

Are we considering to include some path in the site in order to upload reports?, should we open a thread for this as well?

BR

Elio

-----Original Message-----
From: Arce Moreno, Abraham [mailto:abraham.arce.moreno at intel.com] 
Sent: Monday, September 3, 2018 10:56 AM
To: Dean Troyer <dtroyer at gmail.com>
Cc: starlingx-discuss at lists.starlingx.io
Subject: Re: [Starlingx-discuss] [docs] Setting up the docs.starlingx.io website

> > > I'd like to confirm some things and ask for a bit of information:
> > > 1. The stx-docs repo will contain most of the docs.starlingx.io site?
> >
> > Also it might include a section to document the existing APIs from 
> > OpenStack projects modified by StarlingX.
> 
> api-ref is generally in-repo with its code....

Some of these API modifications fall into one of the existing OpenStack projects [0] and modifications are done at the starlingx-staging repo level [1], that was the reason we were thinking to host them under stx-docs, based in a previous analysis done [2], the latest list is as follows:

Dcmanager API v1
  - starlingx-staging/stx-distcloud
Extensions to Block Storage REST API
  - starlingx-staging/stx-python-cinderclient
Extensions to Compute REST API
  - starlingx-staging/stx-nova
Extensions to Image REST API
  - starlingx-staging/stx-glance
Extensions to Networking REST API
  - starlingx-staging/stx-neutron

Is stx-upstream repository another option to host these OpenStack modified APIs leaving stx-docs repository for doc type information?

> > Is this related to generating our documentation using tox -e 
> > [releasenotes / api-ref / doc] ?
> 
> Yes, those tox jobs are what generates the documents and the publish 
> jobs are what puts it on the web server.
> 
> The way to think about this is that it is probably best to consider 
> each repo that has something to be published as a separate sub-tree on 
> the site, with one of them (stx-docs) also being the root of the site.

stx-docs being the root of the site and every repo having its own doc/ directory so our working teams can take care of the whole documentation process including release notes and api-ref if applies, is this a correct assumption?

stx-docs [StarlingX Landing Page]
 <project>
   documentation > docs/
   api-ref > api-ref
   releasenotes > releasenotes/

> We'll put stx-specs at /specs and do similar with the other things to 
> publish here.

I will appreciate your help to feedback the patches I need to work on based on this email, the documentation projects [docs / releasenotes / api-ref] and our StarlingX repos [3] Any modification to the existing Yes / No?

Once I have approval I will take 1 day to send all the gerrit reviews.

[0] https://wiki.openstack.org/wiki/StarlingX/Developer_Guide/API_Documentation#StarlingX_API_Existing
[1] https://github.com/starlingx-staging
[2] https://wiki.openstack.org/wiki/StarlingX/Developer_Guide/API_Documentation#Analysis
[3] https://ethercalc.openstack.org/sifnpbvze9lb
_______________________________________________
Starlingx-discuss mailing list
Starlingx-discuss at lists.starlingx.io
http://lists.starlingx.io/cgi-bin/mailman/listinfo/starlingx-discuss


More information about the Starlingx-discuss mailing list