Merge pull request #43 from indiehd/issue-13

Add documentation for forking and cloning the repositories
indiehd · Oct 5, 2018 · 0866859 · 0866859
2 parents efb1b22 + 03a1a65
commit 0866859
Show file tree

Hide file tree

Showing 3 changed files with 100 additions and 20 deletions.
diff --git a/DOCSREPO.md b/DOCSREPO.md
@@ -1,19 +1,41 @@
 # Docs Repository Documentation
 [![Waffle.io - Columns and their card count](https://badge.waffle.io/indiehd/docs.svg?columns=all)](https://waffle.io/indiehd/docs)
 
-## Fork The Repository
+## Qualifications
+ * Articulate content writer
+ * Patience
 
-You would fork [docs](https://github.com/indiehd/docs) if you wanted to submit changes to the documentation 
-you are currently reading.
+## Fork
+You would fork [docs](https://github.com/indiehd/docs) if you wanted to submit changes to the documentation you are 
+currently reading.
 
 It uses the [Docsify](https://docsify.js.org/#/?id=docsify) library for generating the content.
 
 Just click the `Fork` button in the top right of the repository page:
 
 ![](../images/fork_button.jpg)
 
-**Contributor Qualifications:**
- * Articulate content writer
- * Patience
-
-`Documentation under construction`
+Once forked, you will then `clone` ***YOUR*** repository to your local machine.
+
+## Clone via HTTPS
+
+?> Replace `<YOU>` with your username or organization!
+
+```
+git clone https://github.com/<YOU>/docs.git
+```
+
+## Clone via SSH
+
+*Requires a [SSH Key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/) to be 
+added to your github account*
+
+?> Replace `<YOU>` with your username or organization!
+
+```
+git clone git@github.com:<YOU>/docs.git
+```
+
+## Help
+If you are struggling and nee help, you can come chat with us on [Our Discord](home/COMMUNITY)
+
diff --git a/web-api/README.md b/web-api/README.md
@@ -2,13 +2,7 @@
 [![Waffle.io - Columns and their card count](https://badge.waffle.io/indiehd/docs.svg?columns=all)](https://waffle.io/indiehd/web-api)
 [![Build Status](https://travis-ci.org/indiehd/web-api.svg?branch=master)](https://travis-ci.org/indiehd/web-api)
 
-You would fork [web-api](https://github.com/indiehd/web-api) if you want to contribute to the server side Api. 
-
-Just click the `Fork` button in the top right of the repository page:
-
-![](../images/fork_button.jpg)
-
-**Repository Responsibilities**
+## Repository Duties
 
 * Server side processing
 * Database operations
@@ -18,9 +12,41 @@ Just click the `Fork` button in the top right of the repository page:
 * Mail (with mail templates)
 * Multi-lang support
 
-**Qualifications**
+## Qualifications
 
 * PHP (Specifically [PSR2](https://www.php-fig.org/psr/psr-2/))
 * [Laravel Framework](https://laravel.com/docs/5.7)
 * Strong understanding of [S.O.L.I.D Principles](https://medium.com/prod-io/solid-principles-takeaways-ec0825a07247)
 * Familiarity with [PhpUnit Testing](https://laravel.com/docs/5.7/testing)
+
+
+## Fork
+You would fork [web-api](https://github.com/indiehd/web-api) if you want to contribute to the server side Api. 
+
+Just click the `Fork` button in the top right of the repository page:
+
+![](../images/fork_button.jpg)
+
+Once forked, you will then `clone` ***YOUR*** repository to your local machine.
+
+## Clone via HTTPS
+
+?> Replace `<YOU>` with your username or organization!
+
+```
+git clone https://github.com/<YOU>/web-api.git
+```
+
+## Clone via SSH
+
+*Requires a [SSH Key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/) to be 
+added to your github account*
+
+?> Replace `<YOU>` with your username or organization!
+
+```
+git clone git@github.com:<YOU>/web-api.git
+```
+
+## Help
+If you are struggling and nee help, you can come chat with us on [Our Discord](home/COMMUNITY)
diff --git a/website-ui/README.md b/website-ui/README.md
@@ -10,16 +10,48 @@ Just click the `Fork` button in the top right of the repository page:
 
 ![](../images/fork_button.jpg)
 
-**Repository Responsibilities**
+## Repository Duties
 
 * Client side processing
 * Ajax calls to server Api
 * Realtime updates
 * UI/UX
- 
-**Qualifications**
+
+## Qualifications
 
 * Javascript (Specifically [ES6](https://github.com/lukehoban/es6features#readme))
 * [VueJS Framework](https://vuejs.org/v2/guide/)
 * Familiarity with [JavaScript Airbnb Style](https://github.com/airbnb/javascript/)
-* Familiarity with [ESLint](https://eslint.org/docs/user-guide/getting-started)
+* Familiarity with [ESLint](https://eslint.org/docs/user-guide/getting-started)
+
+## Fork
+You would fork [website-ui](https://github.com/indiehd/website-ui) if you want to contribute to the frontend. 
+
+Just click the `Fork` button in the top right of the repository page:
+
+![](../images/fork_button.jpg)
+
+Once forked, you will then `clone` ***YOUR*** repository to your local machine.
+
+## Clone via HTTPS
+
+?> Replace `<YOU>` with your username or organization!
+
+```
+git clone https://github.com/<YOU>/website-ui.git
+```
+
+## Clone via SSH
+
+*Requires a [SSH Key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/) to be 
+added to your github account*
+
+?> Replace `<YOU>` with your username or organization!
+
+```
+git clone git@github.com:<YOU>/website-ui.git
+```
+
+
+## Help
+If you are struggling and nee help, you can come chat with us on [Our Discord](home/COMMUNITY)