split CONTRIBUTING.md from contributing/index.md

CONTRIBUTING.md will be a simplified page that links to the mkdocs contributing
page.

.pre-commit-config.yaml

@@ -141,7 +141,6 @@ repos:
         exclude: |
           (?x)^(
             .github/ISSUE_TEMPLATE/|
-            docs/CONTRIBUTING.md$|
             docs/index.md$|
             docs/license.md$
           )

CONTRIBUTING.md

@@ -1,5 +1,11 @@
 # Contributing
 
-Thank you for volunteering your time! The following is a set of guidelines for contributing to the peopledepot repository, which is hosted on GitHub.
+Thank you for volunteering your time!
 
-**Please make sure you have completed the onboarding process which includes joining the Hack for LA Slack, GitHub, and Google Drive. If you have not been onboarded, see the [Getting Started Page](https://www.hackforla.org/getting-started).** _Workshop attendees are granted a temporary exception from this requirement._
+Here are the recommended steps for contributing:
+
+1. Join the team
+1. Take an issue
+1. Fork, modify, and submit pull request
+
+Please see the [contributing section](http://hackforla.github.io/peopledepot/contributing/) for more information.

README.md

@@ -38,7 +38,7 @@ This repository uses the [GNU General Public License (v2.0)][licensing].
 
 <!-- References section -->
 
-[contributing]: ./CONTRIBUTING.md
+[contributing]: http://hackforla.github.io/peopledepot/contributing/
 [django-docs]: https://docs.djangoproject.com/
 [docker-docs]: https://www.postgresql.org/docs/
 [drf-docs]: https://www.django-rest-framework.org/tutorial/quickstart/

docs/contributing/index.md

@@ -0,0 +1,19 @@
+# Contributing
+
+Thank you for volunteering your time! The following is a set of guidelines for contributing to the peopledepot repository, which is hosted on GitHub.
+
+**Please make sure you have completed the onboarding process which includes joining the Hack for LA Slack, GitHub, and Google Drive. If you have not been onboarded, see the [Getting Started Page](https://www.hackforla.org/getting-started).** _Workshop attendees are granted a temporary exception from this requirement._
+
+- [Joining the team](team.md)
+
+- [Setting up the Developement Environment](dev_environment.md)
+
+    - [Pre-requisites](dev_environment.md#pre-requisites)
+    - [Fork the repository](dev_environment.md#fork-the-repository)
+    - [Build and run locally](dev_environment.md#build-and-run)
+
+- [Working with Issues](issues.md)
+
+- [Working with Git](git.md)
+
+- [Documentation](documentation.md)