[Starlingx-discuss] StarlingX API Documentation

Arce Moreno, Abraham abraham.arce.moreno at intel.com
Fri Aug 3 16:39:24 UTC 2018

A new goal in collaboration with our Tech Writing team is to document StarlingX APIs, 
so we did an initial research on what it means for StarlingX so your feedback is
highly appreciated.
[ OpenStack :: API ]

For this activity we are initially be considering from API Documentation 2 separate
efforts for each project:

  - API Guide .. the concepts in the API
  - API Ref .. a reference for the API

Can we prioritize one over the other?

[ StarlingX :: API ]

It seems we can categorize the StarlingX APIs in 2:

  - Brand New APIs from StarlingX projects
  - Existing APIs from OpenStack projects

[ StarlingX :: API :: Brand New ]

The projects falling into this category are the following:

  - [0] NFVI Orchestration
  - [1] High Availability/Process Monitoring/Service Management
  - [2] StarlingX System Configuration Management
  - [3] Horizon plugins for new StarlingX services
  - [4] Installation/Update/Patching/Backup/Restore

Can we considered all the above to be included in this API documentation effort? 
Are we missing any other?

[ StarlingX :: API :: Existing ]

All projects living under our starlingx-staging github organization [5] with
upstream contributions [6] e.g. horizon, ceilometer, etc.

We have not gone through a deeper review if we are modifying/adding
new calls into the OpenStack projects however if we are and we need to document

- There is official OpenStack <Project> API documentation, we can make references 
  to them for the existing calls
- What about the modifications/additions? Should we document them? 
  What is the best place for this? We were talking in our weekly call about stx-docs
  is a good place for things without a repo, is this a good example?
- Any easy way besides "find + grep" to get where those API modifications are happening?

[ StarlingX :: API :: Unit Tests]

OpenStack projects includes Unit Tests. Is this something we also need to consider
for our StarlingX Bran New APIs?

[0] http://git.openstack.org/cgit/openstack/stx-nfv/
[1] http://git.openstack.org/cgit/openstack/stx-ha/
[2] http://git.openstack.org/cgit/openstack/stx-config/
[3] http://git.openstack.org/cgit/openstack/stx-gui/
[4] http://git.openstack.org/cgit/openstack/stx-update/
[5] https://github.com/starlingx-staging
[6] http://git.openstack.org/cgit/openstack/stx-upstream/tree/openstack

More information about the Starlingx-discuss mailing list