mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-08-26 18:36:02 +00:00
Mary Camp
c811324028
* Upleveled Contribution guidelines, edited text. Signed-off-by: MCamp859 <maryx.camp@intel.com> * Simplify doc title and sub-bullets under Contrib. guidelines per standup, 10/10/19. Closed GH-828. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
74 lines
2.4 KiB
ReStructuredText
74 lines
2.4 KiB
ReStructuredText
.. _collaboration:
|
|
|
|
Contribute
|
|
##########
|
|
|
|
There are multiple ways to help improve our documentation:
|
|
|
|
* `Contribute via GitHub`_: Submit pull requests in the GitHub\* documentation
|
|
repository.
|
|
* `Log an issue`_: Enter an issue in the documentation repository for
|
|
minor issues such as typos.
|
|
* `Make a suggestion`_: Send your documentation suggestion to the mailing list.
|
|
* Test documentation: Step through our guides and tutorials to verify the
|
|
instructions. `Log an issue`_ or `submit a pull request`_ with your findings.
|
|
|
|
All contributions must follow our `code of conduct`_.
|
|
|
|
Contribute via GitHub
|
|
*********************
|
|
|
|
Our documentation is hosted in GitHub and we follow the standard `GitHub flow`_.
|
|
Here are the basic steps for contributing:
|
|
|
|
#. Clone the `documentation repository`_.
|
|
|
|
#. Create your own fork of the repository.
|
|
|
|
#. Create a branch for your contribution.
|
|
|
|
#. Add your commits.
|
|
|
|
#. Open a pull request.
|
|
|
|
#. Discuss, review, and update your contributions.
|
|
|
|
#. Once the maintainer approves, your contribution is merged and published as
|
|
part of the documentation.
|
|
|
|
|
|
Contribution guidelines
|
|
***********************
|
|
|
|
The |CL| documentation is written using reStructuredText. Use our guidelines
|
|
and best practices to write consistent, readable documentation.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
Writing guide <writing-guide>
|
|
Structure and formatting guide <structure-formatting>
|
|
|
|
.. _references:
|
|
|
|
References
|
|
**********
|
|
|
|
We use the following references for grammar, style, and formatting:
|
|
|
|
* `Microsoft Writing Style Guide`_
|
|
* `Merriam-Webster Dictionary`_
|
|
* The Chicago Manual of Style (15th edition), The University of Chicago Press
|
|
* Microsoft Press Computer Dictionary, Microsoft Press
|
|
* Read Me First!, Oracle Technical Publications
|
|
|
|
|
|
.. _`code of conduct`: https://clearlinux.org/community/code-of-conduct
|
|
.. _Make a suggestion: https://lists.clearlinux.org/postorius/lists/dev.lists.clearlinux.org/
|
|
.. _GitHub flow: https://guides.github.com/introduction/flow/
|
|
.. _Log an issue: https://github.com/clearlinux/clear-linux-documentation/issues
|
|
.. _Contribute via GitHub: https://github.com/clearlinux/clear-linux-documentation
|
|
.. _submit a pull request: https://github.com/clearlinux/clear-linux-documentation
|
|
.. _documentation repository: https://github.com/clearlinux/clear-linux-documentation
|
|
.. _Microsoft Writing Style Guide: https://docs.microsoft.com/en-us/style-guide/welcome/
|
|
.. _Merriam-Webster Dictionary: https://www.merriam-webster.com/ |