<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="Generator" content="Microsoft Word 15 (filtered medium)">
<style><!--
/* Font Definitions */
@font-face
{font-family:"Cambria Math";
panose-1:2 4 5 3 5 4 6 3 2 4;}
@font-face
{font-family:Calibri;
panose-1:2 15 5 2 2 2 4 3 2 4;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0in;
margin-bottom:.0001pt;
font-size:11.0pt;
font-family:"Calibri",sans-serif;}
a:link, span.MsoHyperlink
{mso-style-priority:99;
color:#0563C1;
text-decoration:underline;}
a:visited, span.MsoHyperlinkFollowed
{mso-style-priority:99;
color:#954F72;
text-decoration:underline;}
span.EmailStyle17
{mso-style-type:personal-compose;
font-family:"Calibri",sans-serif;
color:windowtext;}
.MsoChpDefault
{mso-style-type:export-only;
font-family:"Calibri",sans-serif;}
@page WordSection1
{size:8.5in 11.0in;
margin:1.0in 1.0in 1.0in 1.0in;}
div.WordSection1
{page:WordSection1;}
--></style><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="1026" />
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1" />
</o:shapelayout></xml><![endif]-->
</head>
<body lang="EN-US" link="#0563C1" vlink="#954F72">
<div class="WordSection1">
<p class="MsoNormal">This is a Public Service Announcement. <o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">If you are interested in contributing to the StarlingX documentation, here are the details for what you need to do.<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">The Docs team publishes a Contributor’s Guide [1] that describes the process. The documents are in a format called reStructutedText [2] which is a simple markup language. You should install the “tox” tool on your system, which you can
run in your docs repo (“# tox”) to check your changes for correctness and to see how they look – tox generates HTML files from your repo that can be found in your browser by opening
<a href="file:///\\%3cyour%20docs%20directory%3e\docs\build\html">file://<your docs directory>/docs/build/html</a>, which should look just like docs.starlingX.io. You can navigate through the links to find your changes and check them out.<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">Please let me or the Docs team know if you have any questions, and feel free to join our weekly call on Wednesdays at 12:30 Pacific (3:30 Eastern).<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">Thank you!<br>
<br>
<o:p></o:p></p>
<p class="MsoNormal"> Brucej<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">[1] <a href="https://docs.starlingx.io/contributor/doc_contribute_guide.html">
https://docs.starlingx.io/contributor/doc_contribute_guide.html</a><o:p></o:p></p>
<p class="MsoNormal">[2] <a href="http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html">
http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html</a><o:p></o:p></p>
</div>
</body>
</html>