consul/nairobi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update getting started and create instructions

Browse Source
This commit is contained in:
taitus
2024-08-12 13:36:44 +02:00
parent 888d1c9fad
commit 6f692abdf8
6 changed files with 21 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/en/getting_started/create.md
View File

@@ -1,16 +1,14 @@
# Creating your fork
# Create your fork
Consul Democracy 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 Democracy on the footer to comply with project's license (GPL Affero 3).
Consul Democracy 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 Democracy on the footer to comply with project's license (AGPLv3).
1. [Register an user account on Github](https://github.com/join) if you don't have one.
1. [Register a user account on Github](https://github.com/signup) 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 Democracy. **This is not mandatory**, but it will help understand the fork's purpose and future contributions by other users.
2. [Create an Organization](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch) on Github with the name of your city or the organization that's going to use Consul Democracy. **This is not mandatory**, but it will help understand the fork's purpose and future contributions by other users.
3. [Fork Consul Democracy](https://help.github.com/articles/fork-a-repo/) using the **fork** button on the top right corner at <https://github.com/consuldemocracy/consuldemocracy>
3. [Fork Consul Democracy](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) using the **fork** button on the top right corner at <https://github.com/consuldemocracy/consuldemocracy>
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`, it's a common mistake that leads to multiple and grave problems.
4. [Clone your fork repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) on to your computer.
## Why make code public?

2
docs/en/getting_started/getting_started.md
View File

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