From 3c8ca34a5e9b6517de812c2636694fa6bac19561 Mon Sep 17 00:00:00 2001 From: jmarlena Date: Sat, 23 Jan 2016 14:21:25 -0800 Subject: [PATCH 1/2] first commit with added docs folder and files --- docs/README.md | 37 +++++++++++ docs/documentation-style-guide.md | 1 + ...p-0-getting-started-with-github-and-git.md | 12 ++++ ...y-of-the-LearnOSM-site-on-your-computer.md | 63 +++++++++++++++++++ ...opy-of-learnosm-and-managing-your-branches | 0 docs/translations.md | 0 6 files changed, 113 insertions(+) create mode 100644 docs/README.md create mode 100644 docs/documentation-style-guide.md create mode 100644 docs/step-0-getting-started-with-github-and-git.md create mode 100644 docs/step-1-setting-up-a-local-copy-of-the-LearnOSM-site-on-your-computer.md create mode 100644 docs/syncing-your-local-copy-of-learnosm-and-managing-your-branches create mode 100644 docs/translations.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..d22082411 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,37 @@ +# Contributing to the LearnOSM Guide + +## Contribution Workflow + Learn how to set up GitHub & Git, set up a local copy of the LearnOSM site, make changes and submit pull requests using GitHub and Git on the command line or GitHub Desktop. + +## Contribution Guidelines + Translations, Documentation Style Guide, Formatting files with Markdown and Jekyll +__________________ + +## Contribution Workflow + +### Step 0: Getting started with GitHub & Git + - To get started you must create a GitHub account and install Git on your command line. + +### [Step 1: Setting up a local copy of the LearnOSM site on your computer]() + - To set up a local copy of the [LearnOSM](learnosm.org) site on your computer so you can preview the changes you have made, you must create a copy (or fork) of the site through your GitHub account and then add it to your computer using Git on the command line. + +### [Step 2: Syncing your local copy of LearnOSM and managing your branches](docs/syncing-your-local-copy-of-learnosm-and-managing-your-branches) + - Sync your local site with the original one and learn the best practices for preparing changes by managing your Git branches. + +### Step 3: Making changes and submitting pull requests + - Submit pull requests to the main LearnOSM site for review. + +____________ + +## Contribution Guidelines + +### Translations + - See the [Translations guide]() for more details on translating. + +### Documentation Style Guide + - See the working document in []() + +### Formatting files with Markdown and Jekyll + - Jekyll uses a front matter at the top of each Markdown file to track how to make changes. + +Improve this guide. diff --git a/docs/documentation-style-guide.md b/docs/documentation-style-guide.md new file mode 100644 index 000000000..5e1ecb235 --- /dev/null +++ b/docs/documentation-style-guide.md @@ -0,0 +1 @@ +## Documentation Style Guide diff --git a/docs/step-0-getting-started-with-github-and-git.md b/docs/step-0-getting-started-with-github-and-git.md new file mode 100644 index 000000000..c7e64139f --- /dev/null +++ b/docs/step-0-getting-started-with-github-and-git.md @@ -0,0 +1,12 @@ +## Step 0: Getting started with GitHub & Git +- To get started you must create a GitHub account and set up Git on your command line. + +### Create a GitHub account +Sign up at [GitHub](https://github.com/) for your free account if you haven't already. Check out GitHub's ["Signing up for a new GitHub account"](https://help.github.com/articles/signing-up-for-a-new-github-account/) for more details. + +### Install and set up Git +Start setting up Git by configuring your email and user name by following [GitHub's setup instructions](https://help.github.com/articles/set-up-git/). + +*Note: You only need to complete these steps once* + +### **Next Steps:** Continue to [Step 1: Setting up a local copy of the LearnOSM site on your computer](/docs/step-1-setting-up-a-local-copy-of-the-LearnOSM-site-on-your-computer) diff --git a/docs/step-1-setting-up-a-local-copy-of-the-LearnOSM-site-on-your-computer.md b/docs/step-1-setting-up-a-local-copy-of-the-LearnOSM-site-on-your-computer.md new file mode 100644 index 000000000..a92126461 --- /dev/null +++ b/docs/step-1-setting-up-a-local-copy-of-the-LearnOSM-site-on-your-computer.md @@ -0,0 +1,63 @@ +## Step 1: Setting up a local copy of the LearnOSM site on your computer + - To set up a local copy of the [LearnOSM](learnosm.org) site on your computer so you can preview the changes you have made, you must create a copy (or fork) of the site through your GitHub account and then add it to your computer using Git on the command line. + +*Note: You only need to complete these steps once* + +### Create a copy (fork) of the site through your GitHub account +1. Navigate to the LearnOSM site repository at [`https://github.com/hotosm/learnosm`](https://github.com/hotosm/learnosm) on GitHub. + +2. To create a copy of the site repository click the fork button in the right hand corner. +![fork-example](http://www.developer.com/imagesvr_ce/6467/GitHub-Pull-image001.gif) + +3. Next you should see GitHub making a copy of the main LearnOSM site repository owned by hotsom. +![fork-copy-in-action](https://help.github.com/assets/images/site/fork-a-repo.gif) + +Now, you should see your own copy or fork of the LearnOSM site repository on GitHub. + +Check out GitHub's guide on [forking](https://help.github.com/articles/fork-a-repo/) if you need more help. + +### Download your forked copy of the site to your computer +You can download your copy of the site to your computer using the command line or GitHub Desktop. Either way to preview a local copy of your site you must use the command line but cloning your site with GitHub Desktop is easier. + +#### Clone your site on the command line + +1. Find the HTTPS URL and copy it to your clipboard. +https://guides.github.com/activities/forking/ + +1. Open up your command line. + +2. Navigate to the place on your computer where you want to store your local copy of the learnosm site. In this example we will save it in a folder or directory called opensource. + - 2.1 Create a directory called "opensource" or whatever you prefer. + ``` + $ mkdir opensource + ``` + + - 2.2 Navigate into your new directory + ``` + $ cd opensource + opensource$ + ``` + +3. Download your forked copy of the site to your computer by running this command `git clone https://github.com/hotosm/learnosm.git` You should see the site download. + +If you run into any problems check out GitHub's [Cloning a repository](https://help.github.com/articles/cloning-a-repository/) guide. + +#### Clone your site sing GitHub Desktop + +1. Install GitHub Desktop and authenticate to GitHub using the "[Setting up GitHub Desktop](https://help.github.com/desktop/guides/getting-started/setting-up-github-desktop/)" guide. + +2. Save a copy of your learnosm fork by using the "[Cloning a repository from GitHub Desktop]( https://help.github.com/desktop/guides/contributing/cloning-a-repository-from-github-desktop/)" guide. + +To open your local copy of the site in the command line, right click on the learnosm repository clone in the left corner and select "open in the terminal" or "open in the command prompt." You can also open your local copy of the site in a text editor such as Atom from right clicking on your repository in GitHub Desktop. + +### Sync your local copy of the site respository with the original one at hotosm/learnosm +1. On GitHub Navigate to the original [hotosm/learnosm]() repository + +2. Copy the HTTPS URL at the top of the repository. You will use this as the upstream repository URL later on. +- For an example see step 2 of this [Sync a fork](https://help.github.com/articles/fork-a-repo/#step-3-configure-git-to-sync-your-fork-with-the-original-spoon-knife-repository) guide. + +3. If you haven not already, navigate to the place that you cloned your learnosm site on the command line. + +4. To sync your local copy with hotosm/learnosm follow these steps for [Configuring a remote for a fork]() starting with step 2 and using `https://github.com/hotosm/learnosm.git` as your upstream repository URL. + +### **Next Steps:** Continue to [Step 3: Preparing to submit changes ](/docs/step-3-setting-up-a-local-copy-of-the-LearnOSM-site-on-your-computer) diff --git a/docs/syncing-your-local-copy-of-learnosm-and-managing-your-branches b/docs/syncing-your-local-copy-of-learnosm-and-managing-your-branches new file mode 100644 index 000000000..e69de29bb diff --git a/docs/translations.md b/docs/translations.md new file mode 100644 index 000000000..e69de29bb From 8a975451c35893e6b8c81b55f9af940e85ef137f Mon Sep 17 00:00:00 2001 From: Jessica Canepa Date: Sat, 23 Jan 2016 14:27:18 -0800 Subject: [PATCH 2/2] fixed title name --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index d22082411..d0fe72fc9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# Contributing to the LearnOSM Guide +# Contributing to the LearnOSM site guide ## Contribution Workflow Learn how to set up GitHub & Git, set up a local copy of the LearnOSM site, make changes and submit pull requests using GitHub and Git on the command line or GitHub Desktop.