Merge pull request #2 from pdurbin/6017-docs

simplify the quick fix steps #6017

doc/sphinx-guides/source/developers/documentation.rst

@@ -8,16 +8,34 @@ Documentation
 Quick Fix
 -----------
 
-If you find a typo or a small error in the documentation you can easily fix it using GitHub.
-
-- Fork the repository
-- Go to [your GitHub username]/dataverse/doc/sphinx-guides/source and access the file you would like to fix
-- Switch to the branch that is currently under development
-- Click the *Edit* button in the upper-right corner and fix the error
-- Enter a description for the changes you have done on the *Commit changes* form
-- Select option  *Create a new branch for this commit and start a pull request*
-- Enter patch name (refer to http://guides.dataverse.org/en/latest/developers/version-control.html > *Create a New Branch off the develop Branch*) and click button *Propose file change*
-- Submit a pull request to the original (upstream) repo using procedure depicted in https://help.github.com/en/articles/creating-a-pull-request-from-a-fork
+If you find a typo or a small error in the documentation you can fix it using GitHub's online web editor. Generally speaking, we will be following https://help.github.com/en/articles/editing-files-in-another-users-repository
+
+- Navigate to https://github.com/IQSS/dataverse/tree/develop/doc/sphinx-guides/source where you will see folders for each of the guides:
+
+  - `admin`_
+  - `api`_
+  - `developers`_
+  - `installation`_
+  - `user`_
+
+- Find the file you want to edit under one of the folders above.
+- Click the pencil icon in the upper-right corner. If this is your first contribution to Dataverse, the hover text over the pencil icon will say "Fork this project and edit this file".
+- Make changes to the file and preview them.
+- In the **Commit changes** box, enter a description of the changes you have made and click **Propose file change**.
+- Under the **Write** tab, delete the long welcome message and write a few words about what you fixed.
+- Click **Create Pull Request**.
+
+That's it! Thank you for your contribution! Your pull request will be added manually to the main Dataverse project board at https://github.com/orgs/IQSS/projects/2 and will go through code review and QA before it is merged into the "develop" branch. Along the way, developers might suggest changes or make them on your behalf. One your pull request has been merged you will be listed as a contributor at https://github.com/IQSS/dataverse/graphs/contributors
+
+Please see https://github.com/IQSS/dataverse/pull/5857 for an example of a quick fix that was merged (the "Files changed" tab shows how a typo was fixed).
+
+If you would like to read more about the Dataverse project's use of GitHub, please see the :doc:`version-control` section. For bug fixes and features we request that you create an issue before making a pull request but this is not at all necessary for quick fixes to the documentation.
+
+.. _admin: https://github.com/IQSS/dataverse/tree/develop/doc/sphinx-guides/source/admin
+.. _api: https://github.com/IQSS/dataverse/tree/develop/doc/sphinx-guides/source/api
+.. _developers: https://github.com/IQSS/dataverse/tree/develop/doc/sphinx-guides/source/developers
+.. _installation: https://github.com/IQSS/dataverse/tree/develop/doc/sphinx-guides/source/installation
+.. _user: https://github.com/IQSS/dataverse/tree/develop/doc/sphinx-guides/source/user
 
 Other Changes (Sphinx)
 ----------------------