Update references to GitHub repositories

This commit is contained in:
Javi Martín
2023-07-12 15:02:03 +02:00
parent 13c641eedc
commit 10e2a9713f
35 changed files with 75 additions and 75 deletions

View File

@@ -82,4 +82,4 @@ Code published under AFFERO GPL v3 (see [LICENSE-AGPLv3.txt](open_source/license
## Contributions
See [CONTRIBUTING.md](https://github.com/consul/consul/blob/master/CONTRIBUTING.md).
See [CONTRIBUTING.md](https://github.com/consuldemocracy/consuldemocracy/blob/master/CONTRIBUTING.md)

View File

@@ -12,6 +12,6 @@ If you want to overwrite any image, firstly you need to find out the filename, a
## City Map
You'll find the city map at [`/app/assets/images/map.jpg`](https://github.com/consul/consul/blob/master/app/assets/images/map.jpg), just replace it with an image of your cities districts ([example](https://github.com/ayuntamientomadrid/consul/blob/master/app/assets/images/map.jpg)).
You'll find the city map at [`/app/assets/images/map.jpg`](https://github.com/consuldemocracy/consuldemocracy/blob/master/app/assets/images/map.jpg), just replace it with an image of your cities districts ([example](https://github.com/ayuntamientomadrid/consul/blob/master/app/assets/images/map.jpg)).
Afterwards we recommend you to use an online tool like <http://imagemap-generator.dariodomi.de/> or <https://www.image-map.net/> to generate the html coordinates to be able to generate a [image-map](https://www.w3schools.com/tags/tag_map.asp) for each of the districts. Those coordinates should be introduced on the respective Geozones at the admin geozones panel (`/admin/geozones`).

View File

@@ -6,7 +6,7 @@ Currently, Consul Democracy is totally or partially translated to multiple langu
Please [join the translators](https://crwd.in/consul) to help us complete existing ones, or contact us through [Consul Democracy's gitter](https://gitter.im/consul/consul) to become a proofreader and validate translators' contributions.
If your language isn't already present in the Crowdin project, please [open an issue](https://github.com/consul/consul/issues/new?title=New language&body=Hello I would like to have my language INSERT YOUR LANGUAGE NAME added to Consul Democracy) and we'll set it up in a breeze.
If your language isn't already present in the Crowdin project, please [open an issue](https://github.com/consuldemocracy/consuldemocracy/issues/new?title=New language&body=Hello I would like to have my language INSERT YOUR LANGUAGE NAME added to Consul Democracy) and we'll set it up in a breeze.
If you want to check existing translations of the user-facing texts you can find them organized in YML files under `config/locales/` folder. Take a look at the official Ruby on Rails [internationalization guide](http://guides.rubyonrails.org/i18n.html) to better understand the translations system.
@@ -35,4 +35,4 @@ In order to customize it, you should create a new file `config/locales/custom/es
Consul Democracy has the [i18n-tasks](https://github.com/glebm/i18n-tasks) gem, it's an awesome helping tool to manage i18n translations. Just check `i18n-tasks health` for a nice report.
If you have a custom language different than English, you should add it to the [i18n-tasks.yml config file both `base_locale` and `locales`](https://github.com/consul/consul/blob/master/config/i18n-tasks.yml#L4-L7) variables so your language files will be checked as well.
If you have a custom language different than English, you should add it to the [i18n-tasks.yml config file both `base_locale` and `locales`](https://github.com/consuldemocracy/consuldemocracy/blob/master/config/i18n-tasks.yml#L4-L7) variables so your language files will be checked as well.

View File

@@ -428,4 +428,4 @@ The response:
## Code examples
The [doc/api/examples](https://github.com/consul/consul/tree/master/doc/api/examples/ruby) directory contains examples of code to access the API.
The [doc/api/examples](https://github.com/consuldemocracy/consuldemocracy/tree/master/doc/api/examples/ruby) directory contains examples of code to access the API.

View File

@@ -30,7 +30,7 @@ Next, open a database console with a user having permission to create and manage
sudo -u postgres psql -d consul_production
```
If you didn't use the [installer](https://github.com/consul/installer/) to install Consul Democracy, you might need to execute a couple of queries to make sure the Rails database user has permission to create schemas and the shared extensions schema has the right permissions:
If you didn't use the [installer](https://github.com/consuldemocracy/installer/) to install Consul Democracy, you might need to execute a couple of queries to make sure the Rails database user has permission to create schemas and the shared extensions schema has the right permissions:
```
CREATE SCHEMA shared_extensions AUTHORIZATION <replace_with_rails_database_username>;
@@ -178,7 +178,7 @@ This way, it'll be possible to overwrite the default styles for just this tenant
}
```
To easily change the default colors on a specific tenant, you can use CSS variables; their usage is documented in the [app/assets/stylesheets/custom/tenants.scss](https://github.com/consul/consul/blob/master/app/assets/stylesheets/custom/tenants.scss) file. For example, to make the brand colors green on the tenant with the `uranus` subdomain, write:
To easily change the default colors on a specific tenant, you can use CSS variables; their usage is documented in the [app/assets/stylesheets/custom/tenants.scss](https://github.com/consuldemocracy/consuldemocracy/blob/master/app/assets/stylesheets/custom/tenants.scss) file. For example, to make the brand colors green on the tenant with the `uranus` subdomain, write:
```
.tenant-uranus {

View File

@@ -1,10 +1,10 @@
# Communication
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).
The preferred way to report any missing piece of information is [opening an issue in the project's Github repo](https://github.com/consuldemocracy/docs/issues/new).
For more informal communication, chat with us at [Consul Democracy'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!
Before doing it, **please take some time to check the [existing issues](https://github.com/consuldemocracy/consuldemocracy/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:

View File

@@ -6,7 +6,7 @@ Consul Democracy git repo is hosted at Github.com, we recommend using it for you
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.
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/consul/consul>
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>
4. [Clone your fork repository](https://help.github.com/articles/cloning-a-repository/) on to your computer.
@@ -19,4 +19,4 @@ We strongly recommend making code public for multiple reasons:
- **Transparency**: It should be part of the culture of public entities that adopt Consul Democracy, as well as any organization or group.
- **Support**: If you need technical help, both community and Consul Democracy 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 Democracy is distributed under the **[AGPLv3](https://github.com/consul/consul/blob/master/LICENSE-AGPLv3.txt) license** that commands to publish source code.
- Last but not least, Consul Democracy is distributed under the **[AGPLv3](https://github.com/consuldemocracy/consuldemocracy/blob/master/LICENSE-AGPLv3.txt) license** that commands to publish source code.

View File

@@ -10,13 +10,13 @@ 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)
> origin git@github.com:your_user_name/consuldemocracy.git (fetch)\
> origin git@github.com:your_user_name/consuldemocracy.git (push)
Now we have to add Consul Democracy's github as upstream remote with:
```bash
git remote add upstream git@github.com:consul/consul.git
git remote add upstream git@github.com:consuldemocracy/consuldemocracy.git
```
and to check everything is fine with
@@ -27,10 +27,10 @@ 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)
> upstream git@github.com:consuldemocracy/consuldemocracy.git (fetch)\
> upstream git@github.com:consuldemocracy/consuldemocracy.git (push)\
> origin git@github.com:your_user_name/consuldemocracy.git (fetch)\
> origin git@github.com:your_user_name/consuldemocracy.git (push)
## Pulling changes from Consul Democracy
@@ -52,7 +52,7 @@ And then you can choose to either:
A. Get all the latest changes on Consul Democracy'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/consuldemocracy/consuldemocracy/releases/tag/v0.9) release just: `git merge v0.9`.
## Merging changes
@@ -66,4 +66,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 Democracy 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 Democracy to your fork by replacing **your_org_name** on the url: <https://github.com/your_org_name/consuldemocracy/compare/master...consuldemocracy:master>.

View File

@@ -1,6 +1,6 @@
# Create a deploy user
[The installer](https://github.com/consul/installer) by default connects as the `root` user only to create a `deploy` user. This `deploy` user is the one who installs all libraries. If you do not have `root` access, please ask your system administrator to follow these instructions to create a user manually.
[The installer](https://github.com/consuldemocracy/installer) by default connects as the `root` user only to create a `deploy` user. This `deploy` user is the one who installs all libraries. If you do not have `root` access, please ask your system administrator to follow these instructions to create a user manually.
You could create a user called `deploy` or any other name. As as example, we are going to create a user named `jupiter`.

View File

@@ -14,7 +14,7 @@ This tutorial assumes that you have already managed to clone Consul Democracy on
3. Go to your Consul Democracy repository and instantiate the process
```bash
cd consul
cd consuldemocracy
heroku create your-app-name
```

View File

@@ -56,4 +56,4 @@ It will take a few minutes, and at the end you will have a shiny new server. It
![Digital Ocean server](../../img/digital_ocean/server.png)
Next to setup Consul Democracy in the server check the [installer's README](https://github.com/consul/installer)
Next to setup Consul Democracy in the server check the [installer's README](https://github.com/consuldemocracy/installer)

View File

@@ -64,8 +64,8 @@ If you encounter the "WSL 2 installation incomplete" error:
Clone the repo on your computer and enter the folder:
```bash
git clone https://github.com/consul/consul.git
cd consul
git clone https://github.com/consuldemocracy/consuldemocracy.git
cd consuldemocracy
```
### macOS & Linux

View File

@@ -2,4 +2,4 @@
## Installation notes for Production and Staging servers
Check out the [installer's README](https://github.com/consul/installer).
Check out the [installer's README](https://github.com/consuldemocracy/installer).

View File

@@ -2,7 +2,7 @@
These are our recommendations for the different environments and purposes:
- To setup Consul Democracy for a production environment we recommend using the [installer](https://github.com/consul/installer).
- To setup Consul Democracy for a production environment we recommend using the [installer](https://github.com/consuldemocracy/installer).
- For developers working on a Consul Democracy fork we recommend using a UNIX based system (Linux or Mac) and installing Consul Democracy [locally system wide](local_installation.md).

View File

@@ -2,11 +2,11 @@
Before installing Consul Democracy and having it up and running make sure you all [prerequisites](prerequisites.md) installed.
1. First, clone the [Consul Democracy Github repository](https://github.com/consul/consul/) and enter the project folder:
1. First, clone the [Consul Democracy Github repository](https://github.com/consuldemocracy/consuldemocracy/) and enter the project folder:
```bash
git clone https://github.com/consul/consul.git
cd consul
git clone https://github.com/consuldemocracy/consuldemocracy.git
cd consuldemocracy
```
2. Install the Ruby version we need with your Ruby version manager. Here are some examples:

View File

@@ -1,6 +1,6 @@
# Manual installation for production
**WARNING:** This method is *not recommended* and not officially supported, since you should use the [installer](https://github.com/consul/installer) instead. Use this method if the installer isn't an option and you can already deal with PostgreSQL, puma or passenger, NGNIX and SSL (with letsencrypt, for instance).
**WARNING:** This method is *not recommended* and not officially supported, since you should use the [installer](https://github.com/consuldemocracy/installer) instead. Use this method if the installer isn't an option and you can already deal with PostgreSQL, puma or passenger, NGNIX and SSL (with letsencrypt, for instance).
This guide assumes you've already [installed all the necessary packages](prerequisites.md) on your system.
@@ -13,7 +13,7 @@ First, create the main folder, clone the repo to a repo directory, and create th
```
mkdir consul
cd consul
git clone --mirror https://github.com/consul/consul.git repo
git clone --mirror https://github.com/consuldemocracy/consuldemocracy.git repo
mkdir releases shared
mkdir shared/log shared/tmp shared/config shared/public shared/storage
mkdir -p shared/public/assets shared/public/system shared/public/ckeditor_assets shared/public/machine_learning/data

View File

@@ -4,9 +4,9 @@ We appreciate you want to help us by contributing to Consul Democracy. Here's a
## Reporting an issue
If you have seen anything wrong in the platform performance or directly in the code, we encourage you to [open an issue in the Consul Democracy Github repository](https://github.com/consul/consul/issues/new).
If you have seen anything wrong in the platform performance or directly in the code, we encourage you to [open an issue in the Consul Democracy Github repository](https://github.com/consuldemocracy/consuldemocracy/issues/new).
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, if you have more details about it you can write a comment in the issue page -a little more help can make a huge difference!
Before doing it, **please take some time to check the [existing issues](https://github.com/consuldemocracy/consuldemocracy/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, if 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:
@@ -16,7 +16,7 @@ In order to write a new issue, take into account these few tips to make it easy
## Resolving an issue
[Issues in Consul Democracy](https://github.com/consul/consul/issues) labeled with `PRs-welcome` are well defined features ready to be implemented by whoever wants to do it. In the other hand, the `not-ready` label marks features or changes not well defined yet or subject to an internal decision, so we recommend not to try to resolve them until the admins come to a resolution.
[Issues in Consul Democracy](https://github.com/consuldemocracy/consuldemocracy/issues) labeled with `PRs-welcome` are well defined features ready to be implemented by whoever wants to do it. In the other hand, the `not-ready` label marks features or changes not well defined yet or subject to an internal decision, so we recommend not to try to resolve them until the admins come to a resolution.
We suggest to follow these steps to keep a good track of the changes you're about to make:
@@ -25,7 +25,7 @@ We suggest to follow these steps to keep a good track of the changes you're abou
- Create a feature branch based on the `master` branch. To make it easier to identify, you can name it with the issue number followed by a concise and descriptive name (e.g. `123-fix_proposals_link`).
- Work in your branch committing there your changes.
- Make sure all tests are passing. In case you're extending or creating a new feature, consider adding its own specs.
- Once you've finished, send a **pull request** to the [Consul Democracy repository](https://github.com/consul/consul/) describing your solution to help us understand it. It's also important to tell what issue you're addressing, so specify it in the pull request description's first line (e.g. `Fixes #123`).
- Once you've finished, send a **pull request** to the [Consul Democracy repository](https://github.com/consuldemocracy/consuldemocracy/) describing your solution to help us understand it. It's also important to tell what issue you're addressing, so specify it in the pull request description's first line (e.g. `Fixes #123`).
- Our core team will review your PR and suggest changes if necessary. If everything looks good, your changes will be merged :)
> **Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
@@ -36,4 +36,4 @@ We'll appreciate any kind of contribution to Consul Democracy. Even if you can't
- Create issues about any problem or error you've encountered.
- Help translate the platform to other languages you master at [Consul Democracy's Crowdin](https://crwd.in/consul).
- Help with [Consul Democracy's documentation](https://github.com/consul/docs).
- Help with [Consul Democracy's documentation](https://github.com/consuldemocracy/docs).