GitBook: [master] 86 pages and 110 assets modified

docs/english-documentation/getting_started/README.md

@@ -0,0 +1,7 @@
+# Getting started
+
+* [Fork Consul](create.md)
+* [Configure your fork](configuration.md)
+* [Keep your fork updated](update.md)
+* [Communication](communication.md)
+

docs/english-documentation/getting_started/communication.md

@@ -0,0 +1,14 @@
+# Communication
+
+The prefered way to report any missing piece of information is [opening an issue in the project's Github repo](https://github.com/consul/docs/issues/new).
+
+For more informal communication, chat with us at [consul's gitter](https://gitter.im/consul/consul)
+
+Before doing it, **please take some time to check the** [**existing issues**](https://github.com/consul/consul/issues) **and make sure what you are about to report isn't already reported** by another person. In case someone else reported the same problem before or a similar one, and you have more details about it, you can write a comment in the issue page... a little more help can make a huge difference!
+
+In order to write a new issue, take into account these few tips to make it easy to read and comprehend:
+
+* Try to use a descriptive and to-the-point title.
+* It's a good idea to include some sections -in case they're needed- such as: steps to reproduce the bug, expected behaviour/response, actual response or screenshots.
+* Also it could be helpful to provide your operating system, browser version and installed plugins.
+

docs/english-documentation/getting_started/configuration.md

@@ -0,0 +1,13 @@
+# Configure your fork
+
+## Travis CI
+
+[Travis](https://travis-ci.org/) is a Continuous Integration service, free for OpenSource projects \(like Consul and it's forks\). It will help you check on each Pull Request if the test suite is allright.
+
+1. Visit [https://github.com/marketplace/travis-ci](https://github.com/marketplace/travis-ci) and click the "**Install it for free**" green button at the bottom of the page.
+2. Click on the "**Complete order and begin installation**" green button
+3. If you are asked to Authorize Travis CI to access your Github account, check the organization or user where you have your consul fork at the bottom and click the "**Authorize travis-ci**" button.
+4. Visit your [Travis profile](https://travis-ci.org/profile/) and enable Travis for your Consul fork in the list of repositories.
+5. Click on the sprocket icon to the right of the repository to see the builds.
+6. Check that everything is well configured by creating a test Pull Request \(editing a simple .md file could help\).
+

docs/english-documentation/getting_started/create.md

@@ -0,0 +1,20 @@
+# Fork Consul
+
+Consul git repo is hosted at Github.com, we recommend using it for your fork's repo to make things easier. But you can use any other service like Bitbucket or Gitlab if you want to, just don't forget to put a reference link back to CONSUL on the footer to comply with project's license \(GPL Affero 3\).
+
+1. [Register an user account on Github](https://github.com/join) if you don't have one
+2. [Create an Organization](https://help.github.com/articles/creating-a-new-organization-from-scratch/) on Github with the name of your city or the organization that's going to use Consul. **This is not mandatory**, but it will help undertand the fork's purpose and future contributions by other users.
+3. [Fork Consul](https://help.github.com/articles/fork-a-repo/) using the **fork** button on the top right corner at [https://github.com/consul/consul](https://github.com/consul/consul)
+4. [Clone your fork repository](https://help.github.com/articles/cloning-a-repository/) on to your computer
+
+**\*\*IMPORTANT NOTICE**: Do not fork `https://github.com/AyuntamientoMadrid/consul`, its a common mistake that leads to multiple and grave problems
+
+## Why make code public?
+
+We strongly recommend making code public for multiple reasons:
+
+* **Transparency**: It should be part of the culture of public entities that adopt Consul, as well as any organization or group.
+* **Support**: If you need technical help, both community and Consul core team will be able to understand and advice by easily seeing involved code.
+* **Collaboration**: By other professionals, citizens, etc...
+* Last but not least, Consul is distributed under the [**AGPLv3**](https://github.com/consul/consul/blob/master/LICENSE-AGPLv3.txt) **license** that commands to publish source code.
+

docs/english-documentation/getting_started/update.md

@@ -0,0 +1,70 @@
+# Keep your fork updated
+
+## Configuring your git remotes
+
+If you created your fork correctly and cloned it locally, running:
+
+```bash
+git remote -v
+```
+
+it should output something alike:
+
+> origin git@github.com:your\_user\_name/consul.git \(fetch\)  
+>  origin git@github.com:your\_user\_name/consul.git \(push\)
+
+Now we have to add CONSUL's github as upstream remote with:
+
+```bash
+git remote add upstream git@github.com:consul/consul.git
+```
+
+and to check everything is fine with
+
+```bash
+git remote -v
+```
+
+again you should get:
+
+> upstream git@github.com:consul/consul.git \(fetch\)  
+>  upstream git@github.com:consul/consul.git \(push\)  
+>  origin git@github.com:your\_user\_name/consul.git \(fetch\)  
+>  origin git@github.com:your\_user\_name/consul.git \(push\)
+
+## Pulling changes from CONSUL
+
+Start by creating a branch named **upstream** from your **master** branch to apply CONSUL changes:
+
+```bash
+git checkout master
+git pull
+git checkout -b upstream
+```
+
+Then we can fetch all changes from **consul** remote server with:
+
+```bash
+git fetch upstream
+```
+
+And then you can choose to either:
+
+A. Get all the latest changes on CONSUL's **master** branch with `git merge upstream/master`
+
+B. Just update up to an specific release tag \(so you can do incremental updates if you're more than one release behind\). For example to update up to [v0.9](https://github.com/consul/consul/releases/tag/v0.9) release just: `git merge v0.9`
+
+## Merging changes
+
+After the previous section `merge` command, there are three possible outcomes:
+
+A. You get a nice `Already up-to-date.` response. That means your fork is up to date with consul 😊👌
+
+B. You get a screen on your git configured editor showing the commit message `Merge remote-tracking branch 'upstream/master' into upstream`. That means git was able to grab latest changes from CONSUL's master branch, and it can merge them without code change conflicts. Finish the commit.
+
+C. You get some git errors along with a `Automatic merge failed; fix conflicts and then commit the result.` message. That means there are conflicts between the code changes you did and the ones done on CONSUL repository since the last time you update it. That's the main reason we strongly recommend often updates of your fork \(think at least monthly\). Resolve merge conflicts carefully and commit them.
+
+Now you can just simply push your **upstream** branch to github and create a Pull Request so you can easily check all changes going into your repo, and see your tests suite runs.
+
+Remember you can always quickly check changes that will come from CONSUL to your fork by replacing **your\_org\_name** on the url: [https://github.com/your\_org\_name/consul/compare/master...consul:master](https://github.com/your_org_name/consul/compare/master...consul:master)
+