[Starlingx-discuss] [DOCS] Providing input to the docs.starlingx.io documentation
If you are a StarlingX community member that is making changes to StarlingX code that impacts the end user documentation at https://docs.starlingx.io, then please, after completing your gerrit code review, choose one of the options below to help us update the docs: OPTION #1 * Send an email to starlingx-discuss@lists.starlingx.io<mailto:starlingx-discuss@lists.starlingx.io> adding the string “[DOCS] ” as a prefix on the message subject line. * The email should contain: * Short summary of the impact to documentation. * Links to any related Storyboard user stories. * Links to related gerrit code review(s). * Description of new or changed functionality, such as: * behavioral changes * procedural changes * CLI syntax changes * Etc. The StarlingX DOCS team will then take this info and integrate it into https://docs.starlingx.io, update the source .rst file(s) for the doc web pages, submit a PR, and add you as a code reviewer. OPTION #2 If you’re passionate about documentation and would like to update the documentation yourself, even better. See the StarlingX Documentation Contributor Guide at https://docs.starlingx.io/contributor/doc_contribute_guide.html. Thanks, The STX DOCS Team.
participants (1)
-
Tullis, Michael L