StarlingX/Developer Guide/API Documentation
Contents
Intro
StarlingX team is working in collaboration with Tech Writing team to document StarlingX APIs, this page reflects the research on what it means for StarlingX.
History
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
Both concepts (API Guide) and the ref (API Ref) need to be be written at the same time. The new OpenStack approach allows for tags to go in the code.
StarlingX API
We categorize the StarlingX APIs in 2:
- Brand New APIs from StarlingX projects
- Existing APIs from OpenStack projects
StarlingX should not document other OpenStack API's.
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
All projects in the Flock should be included. I think there is a dependency on some of the code restructuring activities that are underway, we need to make sure these activities don't collide.
