Clean docs

This commit is contained in:
Pietro Monticone
2022-11-01 15:20:25 +01:00
parent b2cb72ae81
commit f62cd1129b
21 changed files with 63 additions and 62 deletions

View File

@@ -1,8 +1,8 @@
# 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).
The preferred 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)
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!

View File

@@ -2,11 +2,11 @@
## 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.
[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 alright.
1. Visit 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
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.

View File

@@ -2,15 +2,15 @@
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
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.
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 underhand 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
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.
4. [Clone your fork repository](https://help.github.com/articles/cloning-a-repository/) on to your computer
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
****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?

View File

@@ -48,15 +48,15 @@ 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`
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`
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 😊👌
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.
@@ -64,4 +64,4 @@ C. You get some git errors along with a `Automatic merge failed; fix conflicts a
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
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.