[Starlingx-discuss] REMINDER about updating STX REST API DOCUMENTATION

[Waines, Greg]

ALL StarlingX-Contributors,

This email is probably about 5 months too late ... apologies.

ATTENTION back in ~ September 2018, the StarlingX Documentation Team converted all of our StarlingX REST API Documents from those ugly wadl and yaml files into .rst / restructuredText files; basically aligning with the way all the other services in OpenStack are documenting REST APIs.  The new API DOCS (.rst files) are now located under the applicable repos (or sub-repos).

It is the responsibility of the contributor who changes / updates / creates STX REST APIs to also update the STX REST API DOCUMENTATION.

( ... again, apologies for telling you this 5 months late ... )

The HOWTO info on updating the new REST API DOCS can be found here:
https://docs.starlingx.io/contributor/api_contribute_guide.html

Greg.

p.s. If you do know that you've changed an STX API in the last 5 months and know that you have NOT done the corresponding STX API DOC change, then minimally you need to raise a StarlingX Launchpad Bug on the issue with the details of the missing changes.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.starlingx.io/pipermail/starlingx-discuss/attachments/20190110/07b1a4b5/attachment.html>