mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-05-14 02:43:43 +00:00
181 lines
9.0 KiB
HTML
181 lines
9.0 KiB
HTML
|
||
<!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>Contribute — Documentation for Clear Linux* project</title>
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/bizstyle.css?v=5283bb3d" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
|
||
|
||
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
|
||
<script src="../_static/copybutton.js?v=a56c686a"></script>
|
||
<script src="../_static/bizstyle.js"></script>
|
||
<link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/collaboration/collaboration.html" />
|
||
<link rel="icon" href="../_static/favicon.ico"/>
|
||
<link rel="author" title="About these documents" href="../about.html" />
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="Writing guide" href="writing-guide.html" />
|
||
<link rel="prev" title="FAQ" href="../FAQ/index.html" />
|
||
<meta name="viewport" content="width=device-width,initial-scale=1.0" />
|
||
<!--[if lt IE 9]>
|
||
<script src="_static/css3-mediaqueries.js"></script>
|
||
<![endif]-->
|
||
</head><body>
|
||
<div class="related" role="navigation" aria-label="Related">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="../genindex.html" title="General Index"
|
||
accesskey="I">index</a></li>
|
||
<li class="right" >
|
||
<a href="writing-guide.html" title="Writing guide"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="../FAQ/index.html" title="FAQ"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">Contribute</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="contribute">
|
||
<span id="collaboration"></span><h1>Contribute<a class="headerlink" href="#contribute" title="Link to this heading">¶</a></h1>
|
||
<p>There are multiple ways to help improve our documentation:</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="https://github.com/clearlinux/clear-linux-documentation">Contribute via GitHub</a>: Submit pull requests in the GitHub* documentation
|
||
repository.</p></li>
|
||
<li><p><a class="reference external" href="https://github.com/clearlinux/clear-linux-documentation/issues">Log an issue</a>: Enter an issue in the documentation repository for
|
||
minor issues such as typos.</p></li>
|
||
<li><p><a class="reference external" href="mailto:dev%40clearlinux.discoursemail.com">Make a suggestion</a>: Send your documentation suggestion to the dev email inbox.</p></li>
|
||
<li><p>Test documentation: Step through our guides and tutorials to verify the
|
||
instructions. <a class="reference external" href="https://github.com/clearlinux/clear-linux-documentation/issues">Log an issue</a> or <a class="reference external" href="https://github.com/clearlinux/clear-linux-documentation">submit a pull request</a> with your findings.</p></li>
|
||
</ul>
|
||
<p>All contributions must follow our <a class="reference external" href="https://clearlinux.org/community/code-of-conduct">code of conduct</a>.</p>
|
||
<section id="contribute-via-github">
|
||
<h2>Contribute via GitHub<a class="headerlink" href="#contribute-via-github" title="Link to this heading">¶</a></h2>
|
||
<p>Our documentation is hosted in GitHub and we follow the standard <a class="reference external" href="https://guides.github.com/introduction/flow/">GitHub flow</a>.
|
||
Here are the basic steps for contributing:</p>
|
||
<ol class="arabic simple">
|
||
<li><p>Clone the <a class="reference external" href="https://github.com/clearlinux/clear-linux-documentation">documentation repository</a>.</p></li>
|
||
<li><p>Create your own fork of the repository.</p></li>
|
||
<li><p>Create a branch for your contribution.</p></li>
|
||
<li><p>Add your commits.</p></li>
|
||
<li><p>Open a pull request.</p></li>
|
||
<li><p>Discuss, review, and update your contributions.</p></li>
|
||
<li><p>Once the maintainer approves, your contribution is merged and published as
|
||
part of the documentation.</p></li>
|
||
</ol>
|
||
</section>
|
||
<section id="contribution-guidelines">
|
||
<h2>Contribution guidelines<a class="headerlink" href="#contribution-guidelines" title="Link to this heading">¶</a></h2>
|
||
<p>The Clear Linux OS documentation is written using reStructuredText. Use our guidelines
|
||
and best practices to write consistent, readable documentation. If you’re writing a tutorial, review our skill levels to better target a user group.</p>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="writing-guide.html">Writing guide</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="structure-formatting.html">Structure and formatting guide</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="references">
|
||
<span id="id1"></span><h2>References<a class="headerlink" href="#references" title="Link to this heading">¶</a></h2>
|
||
<p>We use the following references for grammar, style, and formatting:</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="https://docs.microsoft.com/en-us/style-guide/welcome/">Microsoft Writing Style Guide</a></p></li>
|
||
<li><p><a class="reference external" href="https://www.merriam-webster.com/">Merriam-Webster Dictionary</a></p></li>
|
||
<li><p>The Chicago Manual of Style (15th edition), The University of Chicago Press</p></li>
|
||
<li><p>Microsoft Press Computer Dictionary, Microsoft Press</p></li>
|
||
<li><p>Read Me First!, Oracle Technical Publications</p></li>
|
||
</ul>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
<div class="clearer"></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
||
<div class="sphinxsidebarwrapper">
|
||
<p class="logo"><a href="../index.html">
|
||
<img class="logo" src="../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
|
||
</a></p>
|
||
<div>
|
||
<h3><a href="../index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Contribute</a><ul>
|
||
<li><a class="reference internal" href="#contribute-via-github">Contribute via GitHub</a></li>
|
||
<li><a class="reference internal" href="#contribution-guidelines">Contribution guidelines</a></li>
|
||
<li><a class="reference internal" href="#references">References</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
<div>
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="../FAQ/index.html"
|
||
title="previous chapter">FAQ</a></p>
|
||
</div>
|
||
<div>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="writing-guide.html"
|
||
title="next chapter">Writing guide</a></p>
|
||
</div>
|
||
<div role="note" aria-label="source link">
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/collaboration/collaboration.rst.txt"
|
||
rel="nofollow">Show Source</a></li>
|
||
</ul>
|
||
</div>
|
||
<search id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="../search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</search>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="related" role="navigation" aria-label="Related">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="../genindex.html" title="General Index"
|
||
>index</a></li>
|
||
<li class="right" >
|
||
<a href="writing-guide.html" title="Writing guide"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<a href="../FAQ/index.html" title="FAQ"
|
||
>previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">Contribute</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2022 Intel Corporation. All Rights Reserved..
|
||
Last updated on Nov 04, 2024.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
|
||
</div>
|
||
</body>
|
||
</html> |