<html dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252">
<style>
<!--
@font-face
{font-family:Wingdings}
@font-face
{font-family:"Cambria Math"}
@font-face
{font-family:Calibri}
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0in;
margin-bottom:.0001pt;
font-size:12.0pt;
font-family:"Calibri",sans-serif}
a:link, span.MsoHyperlink
{color:#0563C1;
text-decoration:underline}
a:visited, span.MsoHyperlinkFollowed
{color:#954F72;
text-decoration:underline}
p.MsoListParagraph, li.MsoListParagraph, div.MsoListParagraph
{margin-top:0in;
margin-right:0in;
margin-bottom:0in;
margin-left:.5in;
margin-bottom:.0001pt;
font-size:12.0pt;
font-family:"Calibri",sans-serif}
p.msonormal0, li.msonormal0, div.msonormal0
{margin-right:0in;
margin-left:0in;
font-size:11.0pt;
font-family:"Calibri",sans-serif}
span.EmailStyle19
{font-family:"Calibri",sans-serif;
color:windowtext}
span.EmailStyle20
{}
span.SpellE
{}
.MsoChpDefault
{font-size:10.0pt;
font-family:"Calibri",sans-serif}
@page WordSection1
{margin:1.0in 1.0in 1.0in 1.0in}
div.WordSection1
{}
ol
{margin-bottom:0in}
ul
{margin-bottom:0in}
-->
</style><style type="text/css" id="owaParaStyle"></style>
</head>
<body lang="EN-US" link="#0563C1" vlink="#954F72" style="" fpstyle="1" ocsi="0">
<div style="direction: ltr;font-family: Tahoma;color: #000000;font-size: 10pt;">
<div class="WordSection1">
<p class="MsoNormal"><span style="font-size:11.0pt">If you are a StarlingX community member that is making changes to StarlingX code that impacts the end user documentation at
<a href="https://docs.starlingx.io" target="_blank" rel="noopener noreferrer">https://docs.starlingx.io</a>, then please, after completing your
<span class="SpellE">gerrit</span> code review, choose one of the options below to help us update the docs:</span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span></p>
<p class="MsoNormal"><span style="font-size:11.0pt">OPTION #1</span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span></p>
<ul type="disc" style="margin-top:0in">
<li class="MsoNormal" style=""><span style="font-size:11.0pt">Send an email to <a href="mailto:starlingx-discuss@lists.starlingx.io" target="_blank" rel="noopener noreferrer">
starlingx-discuss@lists.starlingx.io</a> adding the string “[DOCS] ” as a prefix on the message subject line.</span></li><li class="MsoNormal" style=""><span style="font-size:11.0pt">The email should contain:</span>
<ul type="circle" style="margin-top:0in">
<li class="MsoNormal" style=""><span style="font-size:11.0pt">Short summary of the impact to documentation.</span></li><li class="MsoNormal" style=""><span style="font-size:11.0pt">Links to any related Storyboard user stories.</span></li><li class="MsoNormal" style=""><span style="font-size:11.0pt">Links to related <span class="SpellE">
gerrit</span> code review(s).</span></li><li class="MsoNormal" style=""><span style="font-size:11.0pt">Description of new or changed functionality, such as:</span>
<ul type="square" style="margin-top:0in">
<li class="MsoNormal" style=""><span style="font-size:11.0pt">behavioral changes</span></li><li class="MsoNormal" style=""><span style="font-size:11.0pt">procedural changes</span></li><li class="MsoNormal" style=""><span style="font-size:11.0pt">CLI syntax changes</span></li><li class="MsoNormal" style=""><span style="font-size:11.0pt">Etc.</span></li></ul>
</li></ul>
</li></ul>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span></p>
<p class="MsoNormal" style="margin-left:.5in"><span style="font-size:11.0pt">The StarlingX DOCS team will then take this info and integrate it into
<a href="https://docs.starlingx.io" target="_blank" rel="noopener noreferrer">https://docs.starlingx.io</a>, update the source .<span class="SpellE">rst</span> file(s) for the doc web pages, submit a PR, and add you as a code reviewer.</span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span></p>
<p class="MsoNormal"><span style="font-size:11.0pt">OPTION #2</span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span></p>
<p class="MsoNormal" style="margin-left:.5in"><span style="font-size:11.0pt">If you’re passionate about documentation and would like to update the documentation yourself, even better.
</span></p>
<p class="MsoNormal" style="margin-left:.5in"><span style="font-size:11.0pt"> </span></p>
<p class="MsoNormal" style="margin-left:.5in"><span style="font-size:11.0pt">See the
<span class="SpellE">StarlingX</span> Documentation Contributor Guide at <a href="https://docs.starlingx.io/contributor/doc_contribute_guide.html" target="_blank" rel="noopener noreferrer">
https://docs.starlingx.io/contributor/doc_contribute_guide.html</a>. </span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span></p>
<p class="MsoNormal"><span style="font-size:11.0pt">Thanks,</span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span></p>
<p class="MsoNormal"><span style="font-size:11.0pt">The <span class="SpellE">STX</span> DOCS Team.</span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"> </span></p>
</div>
</div>
</body>
</html>