add instructions and images (#292)
* add instructions and images * make last instruction clearer * move to proper location * move to better location * change article to page * add description for documentation * anchor * fix link
BIN
site/source/_static/images/contribution/base-repo-then-pr.png
Normal file
|
After Width: | Height: | Size: 488 KiB |
BIN
site/source/_static/images/contribution/branches-instead.png
Normal file
|
After Width: | Height: | Size: 1.6 MiB |
BIN
site/source/_static/images/contribution/branches-then-new-pr.png
Normal file
|
After Width: | Height: | Size: 1.3 MiB |
BIN
site/source/_static/images/contribution/click-article.png
Normal file
|
After Width: | Height: | Size: 1.4 MiB |
BIN
site/source/_static/images/contribution/cog-create-pr.png
Normal file
|
After Width: | Height: | Size: 552 KiB |
BIN
site/source/_static/images/contribution/create-pr-new-file.png
Normal file
|
After Width: | Height: | Size: 1.4 MiB |
|
After Width: | Height: | Size: 1.1 MiB |
BIN
site/source/_static/images/contribution/edit-button.png
Normal file
|
After Width: | Height: | Size: 1.1 MiB |
BIN
site/source/_static/images/contribution/fork0.png
Normal file
|
After Width: | Height: | Size: 1.7 MiB |
BIN
site/source/_static/images/contribution/fork1.png
Normal file
|
After Width: | Height: | Size: 1.2 MiB |
BIN
site/source/_static/images/contribution/github-signup.png
Normal file
|
After Width: | Height: | Size: 3.2 MiB |
|
After Width: | Height: | Size: 1.3 MiB |
BIN
site/source/_static/images/contribution/if-orange-field.png
Normal file
|
After Width: | Height: | Size: 1.6 MiB |
BIN
site/source/_static/images/contribution/make-edit.png
Normal file
|
After Width: | Height: | Size: 410 KiB |
|
After Width: | Height: | Size: 292 KiB |
BIN
site/source/_static/images/contribution/new-file.png
Normal file
|
After Width: | Height: | Size: 1.6 MiB |
BIN
site/source/_static/images/contribution/propose-change.png
Normal file
|
After Width: | Height: | Size: 954 KiB |
BIN
site/source/_static/images/contribution/propose-new-file.png
Normal file
|
After Width: | Height: | Size: 867 KiB |
|
After Width: | Height: | Size: 529 KiB |
@@ -42,14 +42,3 @@ Online A/V content is incredibly powerful. Whether you are a professional creat
|
||||
- Philosophical or technical concepts
|
||||
- Interviews / conversations (Please :ref:`Reach out<contact>` to us!)
|
||||
- Create audio from existing text content
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
Contribute to our `Documentation <https://github.com/Start9Labs/documentation>`_. A large percentage of fixes and updates come from our community.
|
||||
|
||||
- Fix a typo
|
||||
- Add or improve an FAQ or guide
|
||||
- Request a how-to or explanation
|
||||
- Make a general suggestion
|
||||
|
||||
.. tip:: You can find a link to submit a fix or report an issue near the top-right of each page (labeled ``Contribute``)
|
||||
108
site/source/contribute/documentation.rst
Normal file
@@ -0,0 +1,108 @@
|
||||
.. _documentation:
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
If you would like to contribute to the documentation please follow the instructions here:
|
||||
|
||||
#. Head to `Github. <https://github.com>`_
|
||||
|
||||
#. Create an account if you don't have one already:
|
||||
|
||||
.. figure:: /_static/images/contribution/github-signup.png
|
||||
:width: 60%
|
||||
|
||||
#. Head to `Start9's documentation repo. <https://github.com/start9labs/documentation>`_
|
||||
|
||||
#. Fork the repository by clicking here:
|
||||
|
||||
.. figure:: /_static/images/contribution/fork0.png
|
||||
:width: 60%
|
||||
|
||||
#. Click "Create fork"
|
||||
|
||||
.. figure:: /_static/images/contribution/fork1.png
|
||||
:width: 60%
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Editing an existing page:
|
||||
|
||||
#. Click through the relevant directory, find the find the article you'd like to edit and select it:
|
||||
|
||||
.. figure:: /_static/images/contribution/click-article.png
|
||||
:width: 60%
|
||||
|
||||
#. Click on the edit button:
|
||||
|
||||
.. figure:: /_static/images/contribution/edit-button.png
|
||||
:width: 60%
|
||||
|
||||
#. Make your edit:
|
||||
|
||||
.. figure:: /_static/images/contribution/make-edit.png
|
||||
:width: 60%
|
||||
|
||||
#. Describe your changes in the first field, click "Create new branch for this commit and start a pull request," name the branch in the second field and click "Propose changes"
|
||||
|
||||
.. figure:: /_static/images/contribution/propose-change.png
|
||||
:width: 60%
|
||||
|
||||
#. Click "documentation":
|
||||
|
||||
.. figure:: /_static/images/contribution/go-back-to-documentation.png
|
||||
:width: 60%
|
||||
|
||||
#. Click "new pull request" by the side of the branch you just created:
|
||||
|
||||
.. figure:: /_static/images/contribution/documentation-then-new-pr.png
|
||||
:width: 60%
|
||||
|
||||
#. Now ensure that the base repository is Start9Labs/documentation, then click the cog on the right and select someone from the Start9 team to review your PR then finally click "Create pull request".
|
||||
|
||||
|
||||
.. figure:: /_static/images/contribution/base-repo-then-pr.png
|
||||
:width: 60%
|
||||
|
||||
#. If you are unable to request review you can still click "Create pull request" - once reviewed we will either suggest changes or approve it if no changes are necessary. If we reject your PR we will try to offer an explanation of why the PR was not needed.
|
||||
|
||||
Thank you for contributing to Start9's documentation!
|
||||
|
||||
.. group-tab:: Creating a new page:
|
||||
|
||||
#. Click "Add file" and then "Create new file":
|
||||
|
||||
.. figure:: /_static/images/contribution/new-file.png
|
||||
:width: 60%
|
||||
|
||||
#. Name and enter the contents of your first article:
|
||||
|
||||
.. figure:: /_static/images/contribution/name-write-first-article.png
|
||||
:width: 60%
|
||||
|
||||
#. Describe your article in the first field, click "Create new branch for this commit and start a pull request," name the branch in the second field and click "Propose new file"
|
||||
|
||||
.. figure:: /_static/images/contribution/propose-new-file.png
|
||||
:width: 60%
|
||||
|
||||
#. Now click "documentation" and you will likely see this "Compare and pull request" button - if so click it and head to the next step:
|
||||
|
||||
.. figure:: /_static/images/contribution/if-orange-field.png
|
||||
:width: 60%
|
||||
|
||||
#. If you don't see that button click "branches" instead then click "New pull request" next to the branch you created:
|
||||
|
||||
.. figure:: /_static/images/contribution/branches-instead.png
|
||||
:width: 60%
|
||||
|
||||
.. figure:: /_static/images/contribution/branches-then-new-pr.png
|
||||
:width: 60%
|
||||
|
||||
#. Now ensure that the base repository is Start9Labs/documentation, then click the cog on the right and select someone from the Start9 team to review your PR then finally click "Create pull request".
|
||||
|
||||
.. figure:: /_static/images/contribution/cog-create-pr.png
|
||||
:width: 60%
|
||||
|
||||
#. If you are unable to request review you can still click "Create pull request" - once reviewed we will either suggest changes or approve it if no changes are necessary. If we reject your PR we will try to offer an explanation of why the PR was not needed.
|
||||
|
||||
Thank you for contributing to Start9's documentation!
|
||||
@@ -30,6 +30,15 @@ Contribute
|
||||
|
||||
Help guide community members that are early in their sovereign journey.
|
||||
|
||||
.. topic-box::
|
||||
:title: Documentation
|
||||
:link: documentation
|
||||
:icon: scylla-icon scylla-icon--docs
|
||||
:class: large-4
|
||||
:anchor: Edit
|
||||
|
||||
Modify or add to our documentation.
|
||||
|
||||
.. topic-box::
|
||||
:title: Decentralize the Ecosystem
|
||||
:link: decentralize
|
||||
@@ -59,5 +68,6 @@ Contribute
|
||||
|
||||
content
|
||||
provide-support
|
||||
documentation
|
||||
decentralize
|
||||
promote
|
||||
|
||||
@@ -25,4 +25,4 @@ Welcome to the embassyOS user manual. Here you will discover all that your Embas
|
||||
ssh
|
||||
alt-marketplaces
|
||||
device-guides/index
|
||||
upgrade-hardware/index
|
||||
upgrade-hardware/index
|
||||