CINXE.COM

<!DOCTYPE html> <html lang="en" data-content_root="./"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <title>OpenStack Documentation Contributor Guide — Documentation Contributor Guide documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=639405c8" /> <link rel="stylesheet" type="text/css" href="_static/basic.css?v=5c69cfe2" /> <script src="_static/documentation_options.js?v=7f41d439"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Quickstart" href="quickstart.html" /> <meta name="viewport" content="width=device-width, initial-scale=1">  <link href="_static/css/bootstrap.min.css" rel="stylesheet">  <link href="_static/css/font-awesome.min.css" rel="stylesheet">  <link href="_static/css/combined.css" rel="stylesheet">  <link href="_static/css/search.css" rel="stylesheet">  <link href="_static/pygments.css" rel="stylesheet">     <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-17511903-1', 'auto'); ga('send', 'pageview'); </script>  </head><body>  <script> (function (window, document) { var loader = function () { var script = document.createElement("script"), tag = document.getElementsByTagName("script")[0]; script.src = "https://search.openstack.org/widget/embed.min.js?t="+Date.now(); tag.parentNode.insertBefore(script, tag); }; window.addEventListener ? window.addEventListener("load", loader, false) : window.attachEvent("onload", loader); })(window, document); </script> <nav class="navbar navbar-default" role="navigation"> <div class="container">  <div class="navbar-header"> <button class="navbar-toggle" data-target="#bs-example-navbar-collapse-1" data-toggle="collapse" type="button"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <div class="brand-wrapper"> <a class="navbar-brand" href="https://www.openstack.org/"></a> </div> <div class="search-icon show"><i class="fa fa-search"></i> Search</div></div> <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> <div class="search-container tiny"> <div class="openstack-search-bar" data-baseUrl="search.openstack.org" data-context="docs-openstack"></div> </div> <ul class="nav navbar-nav navbar-main show"> <li class="search-container-mobile"> <div class="openstack-search-bar" data-baseUrl="search.openstack.org" data-context="docs-openstack"></div> </li> <li>  <a href="https://www.openstack.org/software/" class="drop" id="dropdownMenuSoftware">Software <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu" role="menu" aria-labelledby="dropdownMenuSoftware"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/software/">Overview</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/software/project-navigator/openstack-components">OpenStack Components</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/software/project-navigator/sdks">SDKs</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/software/project-navigator/deployment-tools">Deployment Tools</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/assets/software/projectmap/openstack-map.pdf" target="_blank">OpenStack Map</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/software/sample-configs/">Sample Configs</a></li> </ul> </li> <li>  <a href="https://www.openstack.org/use-cases/" class="drop" id="dropdownMenuUsers">Use Cases <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu" role="menu" aria-labelledby="dropdownMenuUsers"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/">Users in Production</a></li> <li role="presentation" class="divider"></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/bare-metal/">Ironic Bare Metal</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/edge-computing/">Edge Computing</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/telecoms-and-nfv/">Telecom & NFV</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/science/">Science and HPC</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/containers/">Containers</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/enterprise/">Enterprise</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/surveys/landing">User Survey</a></li> </ul> </li> <li>  <a href="https://openinfra.dev/summit" class="drop" id="dropdownMenuEvents">Events <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu" role="menu" aria-labelledby="dropdownMenuEvents"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev/summit">OpenInfra Summit</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/ptg/">Project Teams Gathering</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/events/opendev-2020/">OpenDev</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/events/community-events/">Community Events</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/events/openstackdays">OpenStack & OpenInfra Days</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/videos/">Summit Videos</a></li> </ul> </li> <li> <a href="https://www.openstack.org/community/" class="drop" id="dropdownMenuCommunity">Community <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu" role="menu" aria-labelledby="dropdownMenuCommunity"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/community/">Welcome! Start Here</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/community/tech-committee">OpenStack Technical Committee</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/community/speakers/">Speakers Bureau</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="http://wiki.openstack.org">OpenStack Wiki</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/coa/">Get Certified (COA)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/community/jobs/">Jobs</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketing/">Marketing Resources</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/news/">Community News</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="http://superuser.openstack.org">Superuser Magazine</a></li> <li role="presentation" class="divider"></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/community/supporting-organizations/">OpenInfra Foundation Supporting Organizations</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev">OpenInfra Foundation</a></li> </ul> </li> <li> <a href="https://www.openstack.org/marketplace/" class="drop" id="dropdownMenuLearn">Marketplace <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu dropdown-hover" role="menu" aria-labelledby="dropdownMenuEvents"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/training/">Training</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/distros/">Distros & Appliances</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/public-clouds/">Public Clouds</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/hosted-private-clouds/">Hosted Private Clouds</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/remotely-managed-private-clouds/">Remotely Managed Private Clouds</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/consulting/">Consulting & Integrators</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/drivers/">Drivers</a></li> </ul> </li> <li> <a href="https://www.openstack.org/blog/">Blog</a> </li> <li> <a href="http://docs.openstack.org/">Docs</a> </li> <li class="join-nav-section">  <a href="https://openinfra.dev/join/" id="dropdownMenuJoin">Join <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu dropdown-hover" role="menu" aria-labelledby="dropdownMenuJoin" style="display: none;"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev/join/">Sign up for Foundation Membership</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev/join/">Sponsor the Foundation</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev">More about the Foundation</a></li> </ul> </li> <li>  <a href="https://www.openstack.org/Security/login/?BackURL=/home/" class="sign-in-btn">Log In</a> </li> </ul> </div> </div>  </nav> <div class="container docs-book-wrapper"> <div class="row"> <div class="col-lg-9 col-md-8 col-sm-8 col-lg-push-3 col-md-push-4 col-sm-push-4"> <div class="row docs-title"> <div class="col-lg-8"> <h1>OpenStack Documentation Contributor Guide</h1> </div> <div class="docs-actions"> <a href="quickstart.html"><i class="fa fa-angle-double-right" data-toggle="tooltip" data-placement="top" title="Next: Quickstart"></i></a> <a id="logABugLink1" href="" target="_blank" title="Found an error? Report a bug against this page"><i class="fa fa-bug" data-toggle="tooltip" data-placement="top" title="Report a Bug"></i></a> </div> </div> <div class="row"> <div class="col-lg-12"> <div class="docs-body" role="main"> <section id="openstack-documentation-contributor-guide"> <h1>OpenStack Documentation Contributor Guide<a class="headerlink" href="#openstack-documentation-contributor-guide" title="Link to this heading">¶</a></h1> <figure class="align-center"> <a class="reference internal image-reference" href="_images/doc-logo-fox.jpg"><img alt="Documentation Logo" src="_images/doc-logo-fox.jpg" style="width: 438.8px; height: 200.0px;" /> </a> </figure> <section id="abstract"> <h2>Abstract<a class="headerlink" href="#abstract" title="Link to this heading">¶</a></h2> <p>This guide provides detailed instructions on the contribution workflow and conventions to be considered by all documentation contributors. Please follow these guidelines to keep the documentation structure, style, and syntax consistent.</p> </section> <section id="contents"> <h2>Contents<a class="headerlink" href="#contents" title="Link to this heading">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a><ul> <li class="toctree-l2"><a class="reference internal" href="quickstart/first-timers.html">First timers</a></li> <li class="toctree-l2"><a class="reference internal" href="quickstart/developers.html">Developers</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="team-structure.html">Documentation team structure</a></li> <li class="toctree-l1"><a class="reference internal" href="team-vision.html">2017/2018 documentation team vision</a><ul> <li class="toctree-l2"><a class="reference internal" href="team-vision.html#objective">Objective</a></li> <li class="toctree-l2"><a class="reference internal" href="team-vision.html#background">Background</a></li> <li class="toctree-l2"><a class="reference internal" href="team-vision.html#use-cases">Use cases</a></li> <li class="toctree-l2"><a class="reference internal" href="team-vision.html#setting-expectations">Setting expectations</a></li> <li class="toctree-l2"><a class="reference internal" href="team-vision.html#content-visibility">Content visibility</a></li> <li class="toctree-l2"><a class="reference internal" href="team-vision.html#contributing-to-documentation">Contributing to documentation</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="non-native-english-speakers.html">Non-native English speakers</a><ul> <li class="toctree-l2"><a class="reference internal" href="non-native-english-speakers.html#new-contributors-with-english-as-a-second-language">New contributors with English as a second language</a></li> <li class="toctree-l2"><a class="reference internal" href="non-native-english-speakers.html#working-with-non-native-english-speakers">Working with non-native English speakers</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="blueprints-and-specs.html">Blueprints and specifications</a></li> <li class="toctree-l1"><a class="reference internal" href="project-guides.html">Project guide setup</a><ul> <li class="toctree-l2"><a class="reference internal" href="project-install-guide.html">Installation Guides</a></li> <li class="toctree-l2"><a class="reference internal" href="project-deploy-guide.html">Deployment guides</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="doc-index.html">Landing pages on docs.openstack.org</a></li> <li class="toctree-l1"><a class="reference internal" href="doc-tag.html">Governance tag documentation guidelines</a><ul> <li class="toctree-l2"><a class="reference internal" href="doc-tag.html#definition">Definition</a></li> <li class="toctree-l2"><a class="reference internal" href="doc-tag.html#guidelines">Guidelines</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="api-guides.html">OpenStack API documentation</a><ul> <li class="toctree-l2"><a class="reference internal" href="api-guides.html#source-files-for-developer-openstack-org">Source files for developer.openstack.org</a></li> <li class="toctree-l2"><a class="reference internal" href="api-guides.html#standards-for-api-reference-in-openstack">Standards for API reference in OpenStack</a></li> <li class="toctree-l2"><a class="reference internal" href="api-guides.html#versions-and-releases-for-api-reference-information">Versions and releases for API reference information</a></li> <li class="toctree-l2"><a class="reference internal" href="api-guides.html#how-to-document-your-openstack-api-service">How to document your OpenStack API service</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="doc-bugs.html">Documentation bugs</a><ul> <li class="toctree-l2"><a class="reference internal" href="doc-impact.html">DocImpact</a></li> <li class="toctree-l2"><a class="reference internal" href="doc-bugs.html#filing-a-bug">Filing a bug</a></li> <li class="toctree-l2"><a class="reference internal" href="doc-bugs.html#working-on-documentation-bugs">Working on documentation bugs</a></li> <li class="toctree-l2"><a class="reference internal" href="doc-bugs.html#working-on-documentation-stories">Working on documentation stories</a></li> <li class="toctree-l2"><a class="reference internal" href="doc-bugs.html#triaging-bugs-for-openstack-manuals">Triaging bugs for openstack-manuals</a></li> <li class="toctree-l2"><a class="reference internal" href="doc-bugs.html#bugs-for-third-party-drivers">Bugs for third-party drivers</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="writing-docs.html">Writing documentation</a><ul> <li class="toctree-l2"><a class="reference internal" href="topic-structure.html">Topic structure</a></li> <li class="toctree-l2"><a class="reference internal" href="topic-tags.html">Topic tags</a></li> <li class="toctree-l2"><a class="reference internal" href="additional-git-workflow.html">Additional Git workflow</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="writing-style.html">Writing style</a><ul> <li class="toctree-l2"><a class="reference internal" href="writing-style/general-writing-guidelines.html">General writing guidelines</a></li> <li class="toctree-l2"><a class="reference internal" href="writing-style/word-choice.html">Word choice</a></li> <li class="toctree-l2"><a class="reference internal" href="writing-style/punctuation.html">Punctuation</a></li> <li class="toctree-l2"><a class="reference internal" href="writing-style/headings.html">Headings</a></li> <li class="toctree-l2"><a class="reference internal" href="writing-style/lists.html">Lists</a></li> <li class="toctree-l2"><a class="reference internal" href="writing-style/urls.html">URLs</a></li> <li class="toctree-l2"><a class="reference internal" href="writing-style/num_and_units_of_measure.html">Numbers and units of measure</a></li> <li class="toctree-l2"><a class="reference internal" href="writing-style/openstack-components.html">OpenStack service and project names</a></li> <li class="toctree-l2"><a class="reference internal" href="writing-style/release-names.html">Release names</a></li> <li class="toctree-l2"><a class="reference internal" href="writing-style/ui-terminology.html">Standard UI terminology</a></li> <li class="toctree-l2"><a class="reference internal" href="writing-style/code-conventions.html">Code conventions</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="user-guidelines.html">OpenStack user experience and user interface guidelines</a><ul> <li class="toctree-l2"><a class="reference internal" href="ux-ui-guidelines/ux-personas.html">OpenStack personas</a></li> <li class="toctree-l2"><a class="reference internal" href="ux-ui-guidelines/gui-guidelines.html">GUI guidelines</a></li> <li class="toctree-l2"><a class="reference internal" href="ux-ui-guidelines/ui-text-guidelines.html">UI text guidelines</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="rst-conv.html">RST conventions</a><ul> <li class="toctree-l2"><a class="reference internal" href="rst-conv/general-guidelines.html">General guidelines</a></li> <li class="toctree-l2"><a class="reference internal" href="rst-conv/file-naming.html">File naming and structure</a></li> <li class="toctree-l2"><a class="reference internal" href="rst-conv/titles.html">Titles</a></li> <li class="toctree-l2"><a class="reference internal" href="rst-conv/inline-markups.html">Inline elements</a></li> <li class="toctree-l2"><a class="reference internal" href="rst-conv/lists.html">Lists</a></li> <li class="toctree-l2"><a class="reference internal" href="rst-conv/specific-info.html">Specific information blocks</a></li> <li class="toctree-l2"><a class="reference internal" href="rst-conv/source-code.html">Code samples</a></li> <li class="toctree-l2"><a class="reference internal" href="rst-conv/references.html">References</a></li> <li class="toctree-l2"><a class="reference internal" href="rst-conv/tables.html">Tables</a></li> <li class="toctree-l2"><a class="reference internal" href="rst-conv/figures.html">Figures</a></li> <li class="toctree-l2"><a class="reference internal" href="rst-conv/profiling.html">Profiling</a></li> <li class="toctree-l2"><a class="reference internal" href="rst-conv/comment.html">Comments</a></li> <li class="toctree-l2"><a class="reference internal" href="rst-conv/decorations.html">Decorations</a></li> <li class="toctree-l2"><a class="reference internal" href="rst-conv.html#useful-links">Useful links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="json-conv.html">JSON conventions</a></li> <li class="toctree-l1"><a class="reference internal" href="diagram-guidelines.html">Diagram guidelines</a><ul> <li class="toctree-l2"><a class="reference internal" href="diagram-guidelines/diagram-usage.html">Use diagrams sparingly</a></li> <li class="toctree-l2"><a class="reference internal" href="diagram-guidelines/tools.html">Tools</a></li> <li class="toctree-l2"><a class="reference internal" href="diagram-guidelines/files.html">Use recommended file formats</a></li> <li class="toctree-l2"><a class="reference internal" href="diagram-guidelines/general-guidelines.html">General guidelines</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="docs-review.html">Reviewing documentation</a><ul> <li class="toctree-l2"><a class="reference internal" href="docs-review.html#review-guidelines">Review guidelines</a></li> <li class="toctree-l2"><a class="reference internal" href="docs-review.html#repositories-and-core-team">Repositories and core team</a></li> <li class="toctree-l2"><a class="reference internal" href="docs-review.html#reviewing-a-documentation-patch">Reviewing a documentation patch</a></li> <li class="toctree-l2"><a class="reference internal" href="docs-review.html#achieving-core-reviewer-status">Achieving core reviewer status</a></li> <li class="toctree-l2"><a class="reference internal" href="docs-review.html#core-reviewer-responsibilities">Core reviewer responsibilities</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="docs-builds.html">Building documentation</a><ul> <li class="toctree-l2"><a class="reference internal" href="docs-builds.html#clone-a-repository-first">Clone a repository first</a></li> <li class="toctree-l2"><a class="reference internal" href="docs-builds.html#building-output-locally">Building output locally</a></li> <li class="toctree-l2"><a class="reference internal" href="docs-builds.html#build-jobs">Build jobs</a></li> <li class="toctree-l2"><a class="reference internal" href="docs-builds.html#building-docs-from-end-of-life-releases">Building docs from end-of-life releases</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="redirects.html">Redirecting documentation</a><ul> <li class="toctree-l2"><a class="reference internal" href="redirects.html#adding-a-htaccess-file-to-your-repo">Adding a .htaccess file to your repo</a></li> <li class="toctree-l2"><a class="reference internal" href="redirects.html#enable-detailed-redirects-for-your-project">Enable detailed redirects for your project</a></li> <li class="toctree-l2"><a class="reference internal" href="redirects.html#testing-your-redirects">Testing your redirects</a></li> <li class="toctree-l2"><a class="reference internal" href="redirects.html#optional-generating-htaccess-files-from-git">Optional: Generating .htaccess files from Git</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="doc-tools.html">Using documentation tools</a><ul> <li class="toctree-l2"><a class="reference internal" href="doc-tools/scripts.html">Scripts overview</a></li> <li class="toctree-l2"><a class="reference internal" href="doc-tools/template-generator.html">Template generator details</a></li> <li class="toctree-l2"><a class="reference internal" href="doc-tools/installation.html">Install OpenStack documentation tools</a></li> <li class="toctree-l2"><a class="reference internal" href="doc-tools/contributing.html">Contribute to OpenStack documentation tools</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="release.html">Publishing a documentation release</a><ul> <li class="toctree-l2"><a class="reference internal" href="release/taskoverview.html">Release tasks overview</a></li> <li class="toctree-l2"><a class="reference internal" href="release/taskdetail.html">Release task detail</a></li> <li class="toctree-l2"><a class="reference internal" href="release/release-tools.html">Releasing tools</a></li> </ul> </li> </ul> </div> </section> <section id="glossary"> <h2>Glossary<a class="headerlink" href="#glossary" title="Link to this heading">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="common/glossary.html">Glossary</a></li> </ul> </div> </section> <section id="search"> <h2>Search<a class="headerlink" href="#search" title="Link to this heading">¶</a></h2> <ul class="simple"> <li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li> </ul> </section> </section> </div> </div> </div> <div class="docs-actions"> <a href="quickstart.html"><i class="fa fa-angle-double-right" data-toggle="tooltip" data-placement="top" title="Next: Quickstart"></i></a> <a id="logABugLink3" href="" target="_blank" title="Found an error? Report a bug against this page"><i class="fa fa-bug" data-toggle="tooltip" data-placement="top" title="Report a Bug"></i></a> </div> <div class="row docs-byline bottom"> <div class="docs-updated">this page last updated: 2024-11-08 17:54:41</div> </div> <div class="row"> <div class="col-lg-8 col-md-8 col-sm-8 docs-license"> <a href="https://creativecommons.org/licenses/by/3.0/"> <img src="_static/images/docs/license.png" alt="Creative Commons Attribution 3.0 License"/> </a> <p> Except where otherwise noted, this document is licensed under <a href="https://creativecommons.org/licenses/by/3.0/">Creative Commons Attribution 3.0 License</a>. See all <a href="https://www.openstack.org/legal"> OpenStack Legal Documents</a>. </p> </div> <div class="col-lg-4 col-md-4 col-sm-4 docs-actions-wrapper">  <a href="#" id="logABugLink2" class="docs-footer-actions"><i class="fa fa-bug"></i> found an error? report a bug</a> </div> </div> </div> <div class="col-lg-3 col-md-4 col-sm-4 col-lg-pull-9 col-md-pull-8 col-sm-pull-8 docs-sidebar"> <div class="btn-group docs-sidebar-releases"> <button onclick="location.href='/'" class="btn docs-sidebar-home" data-toggle="tooltip" data-placement="top" title="OpenStack Docs Home"><i class="fa fa-arrow-circle-o-left"></i></button> <button type="button" data-toggle="dropdown" class="btn docs-sidebar-release-select">OpenStack Documentation<i class="fa fa-caret-down"></i></button> <ul class="dropdown-menu docs-sidebar-dropdown" role="menu"> <li role="presentation" class="dropdown-header">Guides</li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#install-guides">Install Guides</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#user-guides">User Guides</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#configuration-guides">Configuration Guides</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#ops-and-admin-guides">Operations and Administration Guides</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#api-guides">API Guides</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#contributor-guides">Contributor Guides</a></li> <li role="presentation" class="dropdown-header">Languages</li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/de/">Deutsch (German)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/fr/">Français (French)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/id/">Bahasa Indonesia (Indonesian)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/it/">Italiano (Italian)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/ja/">日本語 (Japanese)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/ko_KR/">한국어 (Korean)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/pt_BR/">Português (Portuguese)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/tr_TR/">Türkçe (Türkiye)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/zh_CN/">简体中文 (Simplified Chinese)</a></li> </ul> </div> <div class="docs-sidebar-toc"> <div class="docs-sidebar-section" id="table-of-contents"> <a href="#" class="docs-sidebar-section-title"><h4>Documentation Contributor Guide </h4></a> <ul> <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li> <li class="toctree-l1"><a class="reference internal" href="team-structure.html">Documentation team structure</a></li> <li class="toctree-l1"><a class="reference internal" href="team-vision.html">2017/2018 documentation team vision</a></li> <li class="toctree-l1"><a class="reference internal" href="non-native-english-speakers.html">Non-native English speakers</a></li> <li class="toctree-l1"><a class="reference internal" href="blueprints-and-specs.html">Blueprints and specifications</a></li> <li class="toctree-l1"><a class="reference internal" href="project-guides.html">Project guide setup</a></li> <li class="toctree-l1"><a class="reference internal" href="doc-index.html">Landing pages on docs.openstack.org</a></li> <li class="toctree-l1"><a class="reference internal" href="doc-tag.html">Governance tag documentation guidelines</a></li> <li class="toctree-l1"><a class="reference internal" href="api-guides.html">OpenStack API documentation</a></li> <li class="toctree-l1"><a class="reference internal" href="doc-bugs.html">Documentation bugs</a></li> <li class="toctree-l1"><a class="reference internal" href="writing-docs.html">Writing documentation</a></li> <li class="toctree-l1"><a class="reference internal" href="writing-style.html">Writing style</a></li> <li class="toctree-l1"><a class="reference internal" href="user-guidelines.html">OpenStack user experience and user interface guidelines</a></li> <li class="toctree-l1"><a class="reference internal" href="rst-conv.html">RST conventions</a></li> <li class="toctree-l1"><a class="reference internal" href="json-conv.html">JSON conventions</a></li> <li class="toctree-l1"><a class="reference internal" href="diagram-guidelines.html">Diagram guidelines</a></li> <li class="toctree-l1"><a class="reference internal" href="docs-review.html">Reviewing documentation</a></li> <li class="toctree-l1"><a class="reference internal" href="docs-builds.html">Building documentation</a></li> <li class="toctree-l1"><a class="reference internal" href="redirects.html">Redirecting documentation</a></li> <li class="toctree-l1"><a class="reference internal" href="doc-tools.html">Using documentation tools</a></li> <li class="toctree-l1"><a class="reference internal" href="release.html">Publishing a documentation release</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="common/glossary.html">Glossary</a></li> </ul> </div> <div class="docs-sidebar-toc"> <div class="docs-sidebar-section" id="local-table-of-contents"> <h4 class="docs-sidebar-section-title">Page Contents</h4> <ul> <li><a class="reference internal" href="#">OpenStack Documentation Contributor Guide</a><ul> <li><a class="reference internal" href="#abstract">Abstract</a></li> <li><a class="reference internal" href="#contents">Contents</a></li> <li><a class="reference internal" href="#glossary">Glossary</a></li> <li><a class="reference internal" href="#search">Search</a></li> </ul> </li> </ul> </div> </div> </div> </div> </div> </div> <footer> <div class="container"> <div class="row footer-links"> <div class="col-lg-2 col-sm-2"> <h3>OpenStack</h3> <ul> <li><a href="https://www.openstack.org/software/project-navigator/">Projects</a></li> <li><a href="https://security.openstack.org/">OpenStack Security</a></li> <li><a href="https://openstack.org/blog/">Blog</a></li> <li><a href="https://openstack.org/news/">News</a></li> </ul> </div> <div class="col-lg-2 col-sm-2"> <h3>Community</h3> <ul> <li><a href="https://www.meetup.com/pro/openinfradev/">User Groups</a></li> <li><a href="https://openstack.org/community/events/">Events</a></li> <li><a href="https://openstack.org/community/jobs/">Jobs</a></li> <li><a href="https://openinfra.dev/members/">Companies</a></li> <li><a href="https://docs.openstack.org/contributors">Contribute</a></li> </ul> </div> <div class="col-lg-2 col-sm-2"> <h3>Documentation</h3> <ul> <li><a href="https://docs.openstack.org">OpenStack Manuals</a></li> <li><a href="https://openstack.org/software/start/">Getting Started</a></li> <li><a href="https://developer.openstack.org">API Documentation</a></li> <li><a href="https://wiki.openstack.org">Wiki</a></li> </ul> </div> <div class="col-lg-2 col-sm-2"> <h3>Branding & Legal</h3> <ul> <li><a href="https://openinfra.dev/legal">Legal Docs</a></li> <li><a href="https://openstack.org/brand/">Logos & Guidelines</a></li> <li><a href="https://openinfra.dev/legal/trademark-policy">Trademark Policy</a></li> <li><a href="https://openinfra.dev/privacy-policy">Privacy Policy</a></li> <li><a href="https://docs.openstack.org/contributors/common/setup-gerrit.html#individual-contributor-license-agreement">OpenInfra CLA</a></li> </ul> </div> <div class="col-lg-4 col-sm-4"> <h3>Stay In Touch</h3> <a href="https://twitter.com/OpenStack" target="_blank" class="social-icons footer-twitter"></a> <a href="https://www.facebook.com/openinfradev" target="_blank" class="social-icons footer-facebook"></a> <a href="https://www.linkedin.com/company/open-infrastructure-foundation" target="_blank" class="social-icons footer-linkedin"></a> <a href="https://www.youtube.com/user/OpenStackFoundation" target="_blank" class="social-icons footer-youtube"></a> <p class="fine-print"> The OpenStack project is provided under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0 license</a>. Docs.openstack.org is powered by <a href="https://rackspace.com" target="_blank">Rackspace Cloud Computing</a>. </p> </div> </div> </div> </footer>  <script src="_static/js/jquery-3.2.1.min.js"></script>  <script src="_static/js/bootstrap.min.js"></script>  <script src="_static/js/navigation.js"></script>  <script src="_static/js/docs.js"></script>  <script> /* Build a description of this page including SHA, source location on git * repo, build time and the project's launchpad bug tag. Set the HREF of the * bug buttons */ var lineFeed = "%0A"; var gitURL = "Source: Can't derive source file URL"; /* there have been cases where "pagename" wasn't set; better check for it */ /* "giturl" is the URL of the source file on Git and is auto-generated by * openstackdocstheme. * * "pagename" is a standard sphinx parameter containing the name of * the source file, without extension. */ var sourceFile = "index" + ".rst"; gitURL = "Source: https://opendev.org/openstack/openstack-manuals/src/doc/doc-contrib-guide/source" + "/" + sourceFile; /* gitsha, project and bug_tag rely on variables in conf.py */ var gitSha = "SHA: 80dfc808542c91831e311efa90c16fedc0081352"; var repositoryName = "openstack/openstack-manuals"; var bugProject = "openstack-manuals"; var bugTitle = "OpenStack Documentation Contributor Guide in Documentation Contributor Guide"; var fieldTags = "doc-contrib-guide"; var useStoryboard = ""; /* "last_updated" is the build date and time. It relies on the conf.py variable "html_last_updated_fmt", which should include year/month/day as well as hours and minutes */ var buildstring = "Release: on 2024-11-08 17:54:41"; var fieldComment = encodeURI(buildstring) + lineFeed + encodeURI(gitSha) + lineFeed + encodeURI(gitURL) ; logABug(bugTitle, bugProject, fieldComment, fieldTags, repositoryName, useStoryboard); </script> </body> </html>