diff --git a/site/source/_static/images/contribution/base-repo-then-pr.png b/site/source/_static/images/contribution/base-repo-then-pr.png new file mode 100644 index 0000000..4583af8 Binary files /dev/null and b/site/source/_static/images/contribution/base-repo-then-pr.png differ diff --git a/site/source/_static/images/contribution/branches-instead.png b/site/source/_static/images/contribution/branches-instead.png new file mode 100644 index 0000000..2f4e15d Binary files /dev/null and b/site/source/_static/images/contribution/branches-instead.png differ diff --git a/site/source/_static/images/contribution/branches-then-new-pr.png b/site/source/_static/images/contribution/branches-then-new-pr.png new file mode 100644 index 0000000..7eacf56 Binary files /dev/null and b/site/source/_static/images/contribution/branches-then-new-pr.png differ diff --git a/site/source/_static/images/contribution/click-article.png b/site/source/_static/images/contribution/click-article.png new file mode 100644 index 0000000..bc58aec Binary files /dev/null and b/site/source/_static/images/contribution/click-article.png differ diff --git a/site/source/_static/images/contribution/cog-create-pr.png b/site/source/_static/images/contribution/cog-create-pr.png new file mode 100644 index 0000000..c159ed4 Binary files /dev/null and b/site/source/_static/images/contribution/cog-create-pr.png differ diff --git a/site/source/_static/images/contribution/create-pr-new-file.png b/site/source/_static/images/contribution/create-pr-new-file.png new file mode 100644 index 0000000..725ecb5 Binary files /dev/null and b/site/source/_static/images/contribution/create-pr-new-file.png differ diff --git a/site/source/_static/images/contribution/documentation-then-new-pr.png b/site/source/_static/images/contribution/documentation-then-new-pr.png new file mode 100644 index 0000000..b0fe669 Binary files /dev/null and b/site/source/_static/images/contribution/documentation-then-new-pr.png differ diff --git a/site/source/_static/images/contribution/edit-button.png b/site/source/_static/images/contribution/edit-button.png new file mode 100644 index 0000000..cae1af5 Binary files /dev/null and b/site/source/_static/images/contribution/edit-button.png differ diff --git a/site/source/_static/images/contribution/fork0.png b/site/source/_static/images/contribution/fork0.png new file mode 100644 index 0000000..2d0d572 Binary files /dev/null and b/site/source/_static/images/contribution/fork0.png differ diff --git a/site/source/_static/images/contribution/fork1.png b/site/source/_static/images/contribution/fork1.png new file mode 100644 index 0000000..4044e9e Binary files /dev/null and b/site/source/_static/images/contribution/fork1.png differ diff --git a/site/source/_static/images/contribution/github-signup.png b/site/source/_static/images/contribution/github-signup.png new file mode 100644 index 0000000..204ff67 Binary files /dev/null and b/site/source/_static/images/contribution/github-signup.png differ diff --git a/site/source/_static/images/contribution/go-back-to-documentation.png b/site/source/_static/images/contribution/go-back-to-documentation.png new file mode 100644 index 0000000..95640f0 Binary files /dev/null and b/site/source/_static/images/contribution/go-back-to-documentation.png differ diff --git a/site/source/_static/images/contribution/if-orange-field.png b/site/source/_static/images/contribution/if-orange-field.png new file mode 100644 index 0000000..e0e285a Binary files /dev/null and b/site/source/_static/images/contribution/if-orange-field.png differ diff --git a/site/source/_static/images/contribution/make-edit.png b/site/source/_static/images/contribution/make-edit.png new file mode 100644 index 0000000..c0192bf Binary files /dev/null and b/site/source/_static/images/contribution/make-edit.png differ diff --git a/site/source/_static/images/contribution/name-write-first-article.png b/site/source/_static/images/contribution/name-write-first-article.png new file mode 100644 index 0000000..ed501ab Binary files /dev/null and b/site/source/_static/images/contribution/name-write-first-article.png differ diff --git a/site/source/_static/images/contribution/new-file.png b/site/source/_static/images/contribution/new-file.png new file mode 100644 index 0000000..90687a7 Binary files /dev/null and b/site/source/_static/images/contribution/new-file.png differ diff --git a/site/source/_static/images/contribution/propose-change.png b/site/source/_static/images/contribution/propose-change.png new file mode 100644 index 0000000..e039587 Binary files /dev/null and b/site/source/_static/images/contribution/propose-change.png differ diff --git a/site/source/_static/images/contribution/propose-new-file.png b/site/source/_static/images/contribution/propose-new-file.png new file mode 100644 index 0000000..3322d11 Binary files /dev/null and b/site/source/_static/images/contribution/propose-new-file.png differ diff --git a/site/source/_static/images/contribution/select-reviewer-create-pr.png b/site/source/_static/images/contribution/select-reviewer-create-pr.png new file mode 100644 index 0000000..60ded8d Binary files /dev/null and b/site/source/_static/images/contribution/select-reviewer-create-pr.png differ diff --git a/site/source/contribute/content.rst b/site/source/contribute/content.rst index ede4dcf..5b34ba4 100644 --- a/site/source/contribute/content.rst +++ b/site/source/contribute/content.rst @@ -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` to us!) - Create audio from existing text content - -Documentation -------------- -Contribute to our `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``) \ No newline at end of file diff --git a/site/source/contribute/documentation.rst b/site/source/contribute/documentation.rst new file mode 100644 index 0000000..e772c1c --- /dev/null +++ b/site/source/contribute/documentation.rst @@ -0,0 +1,108 @@ +.. _documentation: + +Documentation +------------- + +If you would like to contribute to the documentation please follow the instructions here: + +#. Head to `Github. `_ + +#. 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. `_ + +#. 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! \ No newline at end of file diff --git a/site/source/contribute/index.rst b/site/source/contribute/index.rst index b99cce1..4471c29 100644 --- a/site/source/contribute/index.rst +++ b/site/source/contribute/index.rst @@ -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 diff --git a/site/source/user-manual/index.rst b/site/source/user-manual/index.rst index 51ec80c..2a0f741 100644 --- a/site/source/user-manual/index.rst +++ b/site/source/user-manual/index.rst @@ -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 \ No newline at end of file