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

Update application name

Browse Source 
Note that, in order to have some consistency, we're always writing
"Consul Democracy", instead of using capital letters sometimes (but not
always), like we did until now.
This commit is contained in:
Javi Martín
2023-07-10 19:51:02 +02:00
parent 68d0ffe5ec
commit 13c641eedc
52 changed files with 240 additions and 240 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/book.json
View File

@@ -1,5 +1,5 @@
{
"gitbook": ">= 3.0.0",
"title": "Consul Documentation",
"title": "Consul Democracy Documentation",
"description": "Citizen Participation and Open Government Application"
}

12
docs/en/customization/introduction.md
View File

@@ -1,12 +1,12 @@
# Customization
You can modify your own CONSUL to have your custom visual style, but first you'll have to [create your own fork from](../getting_started/create.md).
You can modify your own Consul Democracy to have your custom visual style, but first you'll have to [create your own fork from](../getting_started/create.md).
We've created an specific structure where you can overwrite and customize the application in a way that will let you keep updating it from CONSUL's main repository, without having conflicts on code merging or risking loosing your customization changes. We try to make CONSUL as vanilla as possible to help other developers onboard the codebase.
We've created an specific structure where you can overwrite and customize the application in a way that will let you keep updating it from Consul Democracy's main repository, without having conflicts on code merging or risking loosing your customization changes. We try to make Consul Democracy as vanilla as possible to help other developers onboard the codebase.
## Special Folders and Files
In order to customize your CONSUL fork, you'll make use of some `custom` folders on the following paths:
In order to customize your Consul Democracy fork, you'll make use of some `custom` folders on the following paths:
* `config/locales/custom/`
* `app/assets/images/custom/`
@@ -79,7 +79,7 @@ Currently these are all the [available languages](https://api.cognitive.microsof
["af", "am", "ar", "as", "az", "ba", "bg", "bn", "bo", "bs", "ca", "cs", "cy", "da", "de", "dv", "el", "en", "es", "et", "eu", "fa", "fi", "fil", "fj", "fo", "fr", "fr-CA", "ga", "gl", "gu", "ha", "he", "hi", "hr", "hsb", "ht", "hu", "hy", "id", "ig", "ikt", "is", "it", "iu", "iu-Latn", "ja", "ka", "kk", "km", "kmr", "kn", "ko", "ku", "ky", "ln", "lo", "lt", "lug", "lv", "lzh", "mg", "mi", "mk", "ml", "mn-Cyrl", "mn-Mong", "mr", "ms", "mt", "mww", "my", "nb", "ne", "nl", "nso", "nya", "or", "otq", "pa", "pl", "prs", "ps", "pt", "pt-PT", "ro", "ru", "run", "rw", "sk", "sl", "sm", "sn", "so", "sq", "sr-Cyrl", "sr-Latn", "st", "sv", "sw", "ta", "te", "th", "ti", "tk", "tlh-Latn", "tlh-Piqd", "tn", "to", "tr", "tt", "ty", "ug", "uk", "ur", "uz", "vi", "xh", "yo", "yua", "yue", "zh-Hans", "zh-Hant", "zu"]
```
Of all the languages that Consul currently has defined (`available_locales`) in `config/application.rb` the only one that is not listed above and therefore no translation service is offered is Valencian `["val"]`.
Of all the languages that Consul Democracy currently has defined (`available_locales`) in `config/application.rb` the only one that is not listed above and therefore no translation service is offered is Valencian `["val"]`.
### Pricing
@@ -129,8 +129,8 @@ The aim of this feature is to allow users the introduction of dynamic contents i
To activate this feature you must follow 2 steps:
1. Execute the following command `bin/rake settings:create_translation_interface_setting RAILS_ENV=production` (This is only required for already existing intallations, for new consul installations this step is not needed).
2. Accessing as administrator user to the administration panel of your Consul application to the section **Configuration > Features** and activating the feature called **Translation Interface** as you can see next:
1. Execute the following command `bin/rake settings:create_translation_interface_setting RAILS_ENV=production` (This is only required for already existing intallations, for new Consul Democracy installations this step is not needed).
2. Accessing as administrator user to the administration panel of your Consul Democracy application to the section **Configuration > Features** and activating the feature called **Translation Interface** as you can see next:
![Active interface translations](../../img/translations/interface_translations/active-interface-translations-en.png)
### Use Cases

10
docs/en/customization/translations.md
View File

@@ -2,17 +2,17 @@
## Translations
Currently, CONSUL is totally or partially translated to multiple languages. You can find the translations at the [Crowdin project](https://crowdin.com/project/consul).
Currently, Consul Democracy is totally or partially translated to multiple languages. You can find the translations at the [Crowdin project](https://crowdin.com/project/consul).
Please [join the translators](https://crwd.in/consul) to help us complete existing ones, or contact us through [CONSUL's gitter](https://gitter.im/consul/consul) to become a proofreader and validate translators' contributions.
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) 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/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 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.
## Custom Texts
Since CONSUL is always evolving with new features, and in order to make your fork easier to be updated, we strongly recommend translation files not to be modified, but instead "overwritten" with custom translation files in case a text needs to be customized for you.
Since Consul Democracy is always evolving with new features, and in order to make your fork easier to be updated, we strongly recommend translation files not to be modified, but instead "overwritten" with custom translation files in case a text needs to be customized for you.
So if you just want to change some of the existing texts, you can just drop your changes at the `config/locales/custom/` folder. We strongly recommend to include only those texts that you want to change instead of a whole copy of the original file. For example if you want to customize the text "Ayuntamiento de Madrid, 2016" that appears on every page's footer, firstly you want to locate where it's used (`app/views/layouts/_footer.html.erb`) and look at the locale identifier inside the code:
@@ -33,6 +33,6 @@ In order to customize it, you should create a new file `config/locales/custom/es
## Maintaining your Custom Texts & Languages
CONSUL 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.
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.

4
docs/en/features/graphql.md
View File

@@ -30,7 +30,7 @@
## GraphQL
The CONSUL API uses GraphQL [http://graphql.org](http://graphql.org), the [Ruby implementation](http://graphql-ruby.org/), to be specific. If you're not familiar with this kind of APIs, it's recommended to make some research about GraphQL before.
The Consul Democracy API uses GraphQL [http://graphql.org](http://graphql.org), the [Ruby implementation](http://graphql-ruby.org/), to be specific. If you're not familiar with this kind of APIs, it's recommended to make some research about GraphQL before.
One of the characteristics that differentiates a REST API from a GraphQL one is that with the last one it's possible for the client to build its own *custom queries*, so the server will only return information in which we're interested.
@@ -68,7 +68,7 @@ Responses are formatted in JSON:
## Making API requests
Following [the official recommendations](http://graphql.org/learn/serving-over-http/), the CONSUL API supports the following kind of requests:
Following [the official recommendations](http://graphql.org/learn/serving-over-http/), the Consul Democracy API supports the following kind of requests:
* GET requests, with the query inside the *query string*.
* POST requests

46
docs/en/features/multitenancy.md
View File

@@ -4,13 +4,13 @@
The multitenancy feature allows managing several independent institutions ("tenants") using the same application. For example, in our case, a user who signs up for a certain tenant will only be able to sign in on that tenant, and that user's data won't be available from any other tenant.
Which tenant we're accessing depends on the URL we're using in the browser to access the application. In CONSUL, the current tenant is established by the subdomain used in this URL. For example, if we used the domain `solarsystemexample.org` to manage the planets in the Solar System, using the URL `https://mercury.solarsystemexample.org` we'd access data from the planet Mercury while using the URL `https://venus.solarsystemexample.org` we'd access data from the planet Venus. It's also be possible to use different domains per tenant (for example, `earthexample.org`).
Which tenant we're accessing depends on the URL we're using in the browser to access the application. In Consul Democracy, the current tenant is established by the subdomain used in this URL. For example, if we used the domain `solarsystemexample.org` to manage the planets in the Solar System, using the URL `https://mercury.solarsystemexample.org` we'd access data from the planet Mercury while using the URL `https://venus.solarsystemexample.org` we'd access data from the planet Venus. It's also be possible to use different domains per tenant (for example, `earthexample.org`).
## Enabling multitenancy
### Preliminary steps after upgrading from CONSUL version 1.5.0
### Preliminary steps after upgrading from Consul Democracy version 1.5.0
If you're upgrading a CONSUL installation to version 2.0.0 from version 1.5.0, you'll have to follow these steps before enabling multitenancy. These steps aren't necessary on new CONSUL installations.
If you're upgrading a Consul Democracy installation to version 2.0.0 from version 1.5.0, you'll have to follow these steps before enabling multitenancy. These steps aren't necessary on new Consul Democracy installations.
First, after deploying version 2.0.0 to your production server, execute the release tasks:
@@ -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, 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/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:
```
CREATE SCHEMA shared_extensions AUTHORIZATION <replace_with_rails_database_username>;
@@ -38,14 +38,14 @@ GRANT CREATE ON DATABASE consul_production TO <replace_with_rails_database_usern
GRANT usage ON SCHEMA shared_extensions TO public;
```
Whether or not you installed CONSUL with the installer, run:
Whether or not you installed Consul Democracy with the installer, run:
```
ALTER EXTENSION pg_trgm SET SCHEMA shared_extensions;
ALTER EXTENSION unaccent SET SCHEMA shared_extensions;
```
### Common step for all CONSUL installations
### Common step for all Consul Democracy installations
There are two possible ways to enable multitenancy:
@@ -58,13 +58,13 @@ After enabling this option, restart the application.
## Managing tenants
Once multitenancy has been enabled and the application has been restarted, you'll see a new "Multitenancy" section inside the "Settings" menu in the CONSUL admin panel.
Once multitenancy has been enabled and the application has been restarted, you'll see a new "Multitenancy" section inside the "Settings" menu in the Consul Democracy admin panel.
![New section with the list of tenants, with their name and domain or subdomain](../../img/multitenancy/index-en.png)
This section will only be available from the "main" tenant (the one which is created by default). It will not be possible to add/edit tenants by accessing the admin section of any other tenant.
Since removing a tenant would delete **all** its associated data, making it impossible to restore it, CONSUL doesn't allow deleting a tenant using the admin panel. However, it's possible to disable a tenant so it cannot be accessed.
Since removing a tenant would delete **all** its associated data, making it impossible to restore it, Consul Democracy doesn't allow deleting a tenant using the admin panel. However, it's possible to disable a tenant so it cannot be accessed.
The interface to manage tenants is very simple, needing just a name and a domain or subdomain.
@@ -74,7 +74,7 @@ The name will be used to set the default site name for new tenants. Note that, o
The domain or subdomain will be used to access this tenant. If you've got a domain like `solarsystemexample.org` and would like to access tenants using subdomains (like `mars.solarsystemexample.org`), choose "Use a subdomain". If you're using a different domain for the tenant (like `marsexample.org`), choose "Use a different domain".
Note that, if you use a different domain for a tenant, you'll have to configure your SSL certificates, web server and DNS so they support that domain and point to your CONSUL application.
Note that, if you use a different domain for a tenant, you'll have to configure your SSL certificates, web server and DNS so they support that domain and point to your Consul Democracy application.
When adding a new tenant, an admin user **copying the same login data as the administrator creating the tenant** will be automatically created. Note this user is stored in the database schema of the new tenant, so changing their password in one tenant won't change their password in any other tenants.
@@ -82,9 +82,9 @@ When adding a new tenant, an admin user **copying the same login data as the adm
### SSL certificates
In order to make it possible to access the application using secure HTTPS/SSL connections, you'll need a valid SSL certificate for the tenant you've just added. Since every institution using CONSUL has a different system to manage these certificates, getting a valid SSL certificate for the new tenant will need a different process depending on the way your institution manages these certificates.
In order to make it possible to access the application using secure HTTPS/SSL connections, you'll need a valid SSL certificate for the tenant you've just added. Since every institution using Consul Democracy has a different system to manage these certificates, getting a valid SSL certificate for the new tenant will need a different process depending on the way your institution manages these certificates.
If you've installed CONSUL using the installer and are using Certbot to manage these certificates, you have two options.
If you've installed Consul Democracy using the installer and are using Certbot to manage these certificates, you have two options.
One option would be adding each certificate manually every time you create a tenant. For example, in orer to add a tenant using the `mars` subdomain in the `solarsystemexample.org` domain, run:
@@ -98,7 +98,7 @@ If you're going to add many subdomains at different times, this task can be tedi
sudo certbot certonly --manual --agree-tos --expand -d solarsystemexample.org,*.solarsystemexample.org
```
You'll be asked to create a DNS TXT record with the subdomain `_acme-challenge` on your domain, with a certain value. You might also be asked to create a file with a certain name containing a certain content (usually in a `.well-known/acme-challenge` folder); if that's the case, assuming you're using CONSUL's default folders, create it in `/home/deploy/consul/current/public/.well-known/acme-challenge/`.
You'll be asked to create a DNS TXT record with the subdomain `_acme-challenge` on your domain, with a certain value. You might also be asked to create a file with a certain name containing a certain content (usually in a `.well-known/acme-challenge` folder); if that's the case, assuming you're using Consul Democracy's default folders, create it in `/home/deploy/consul/current/public/.well-known/acme-challenge/`.
After doing so, update your web server configuration file (by default `/etc/nginx/sites-enabled/default`) so it uses the generated certificate, and restart the web server with `sudo systemctl restart nginx`.
@@ -162,13 +162,13 @@ After editing this file, restart the application.
### Maintenance of the schema.rb file
When CONSUL creates a tenant, it loads the content of the `db/schema.rb` file to create a new database schema for the new tenant. This means that if for some reason this file doesn't contain the same database structure you'd get by creating a new database and running the migrations with `rake db:migrate`, you could end up with different database table or columns on different tenants. This could result in a disastrous situation.
When Consul Democracy creates a tenant, it loads the content of the `db/schema.rb` file to create a new database schema for the new tenant. This means that if for some reason this file doesn't contain the same database structure you'd get by creating a new database and running the migrations with `rake db:migrate`, you could end up with different database table or columns on different tenants. This could result in a disastrous situation.
In order to avoid it, we recommend checking the integrity of the `db/schema.rb` file in your continuous integration system. If you're doing continuous intergration using GitHub Actions, you can use the workflow already included in CONSUL. Pull requests adding this check on GitLab CI or other continuous intergration environments are welcome.
In order to avoid it, we recommend checking the integrity of the `db/schema.rb` file in your continuous integration system. If you're doing continuous intergration using GitHub Actions, you can use the workflow already included in Consul Democracy. Pull requests adding this check on GitLab CI or other continuous intergration environments are welcome.
### Using custom styles for a tenant with CSS
When the multitenancy feature is enabled, CONSUL adds a class to the `<html>` element, making it possible to apply styles (or JavaScript events) to just a specific tenant. For example, the tenant with the `uranus` subdomain would have the `tenant-uranus` class.
When the multitenancy feature is enabled, Consul Democracy adds a class to the `<html>` element, making it possible to apply styles (or JavaScript events) to just a specific tenant. For example, the tenant with the `uranus` subdomain would have the `tenant-uranus` class.
This way, it'll be possible to overwrite the default styles for just this tenant by creating a new stylesheet in the `app/assets/stylesheets/custom/` folder:
@@ -207,17 +207,17 @@ For example, if you're writing a custom `admin/action_component` component view
## Current limitations of multitenancy
The multitenancy feature was first included in CONSUL 2.0.0 and there are a few things that are still missing.
The multitenancy feature was first included in Consul Democracy 2.0.0 and there are a few things that are still missing.
### Applications which can be accessed from multiple domains
You might have a CONSUL application which can be accessed from two different domains; for example, `solarsystemexample.org` and a domain in Spanish named `ejemplodesistemasolar.org`.
You might have a Consul Democracy application which can be accessed from two different domains; for example, `solarsystemexample.org` and a domain in Spanish named `ejemplodesistemasolar.org`.
In this case, the source code needs to be changed a little so multitenancy works with both domains. In particular, the `allowed_domains` method in the `Tenant` class needs to be changed in order to include both domains. See the [models customization documentation](../customization/models.md) for examples on how to customize methods like this one.
### Custom images per tenant
The administration panel in CONSUL contains a "Custom images" section, where you can customize some (but not all) images appearing in the application. Using this interface allows having different images per tenant.
The administration panel in Consul Democracy contains a "Custom images" section, where you can customize some (but not all) images appearing in the application. Using this interface allows having different images per tenant.
Sometimes it's useful to have a certain image under version control, though. For instance, if we'd like to use a different logo for a tenant with the `neptune` subdomain, we'd put that file under `app/assets/images/custom/tenants/neptune/logo_header.png`.
@@ -225,16 +225,16 @@ However, this will only work for images which can already be configured through
### Databases on different servers for different tenants
In CONSUL 2.0.0, data from all tenants is stored in the same database and so it isn't possible to use several databases on different servers.
In Consul Democracy 2.0.0, data from all tenants is stored in the same database and so it isn't possible to use several databases on different servers.
If this feature is requested often, it'll be possible to include it in CONSUL in the future. However, CONSUL 2.0.0 uses Rails 6.0 and this feature will require upgrading to Rails 6.1 or even Rails 7.0.
If this feature is requested often, it'll be possible to include it in Consul Democracy in the future. However, Consul Democracy 2.0.0 uses Rails 6.0 and this feature will require upgrading to Rails 6.1 or even Rails 7.0.
### Different languages per tenant
In CONSUL 2.0.0, every tenant is available in the same languages, so it wouldn't be possible (for instance) to enable French in one tenant and German in a different one; you'd have to enable both languages in both tenants.
In Consul Democracy 2.0.0, every tenant is available in the same languages, so it wouldn't be possible (for instance) to enable French in one tenant and German in a different one; you'd have to enable both languages in both tenants.
Implementing this feature is planned for CONSUL 2.1.0.
Implementing this feature is planned for Consul Democracy 2.1.0.
### Deleting tenants
Since removing a tenant would delete **all** its associated data, making it impossible to restore it, CONSUL doesn't allow deleting tenants using the admin panel and only allows disabling them so they cannot be accessed. To completely delete a tenant, use the Rails console.
Since removing a tenant would delete **all** its associated data, making it impossible to restore it, Consul Democracy doesn't allow deleting tenants using the admin panel and only allows disabling them so they cannot be accessed. To completely delete a tenant, use the Rails console.

4
docs/en/features/oauth.md
View File

@@ -6,9 +6,9 @@ You can configure authentication services with external OAuth suppliers, right n
For each platform, go to their developers section and follow their guides to create an app.
## 2. Set your CONSUL's url
## 2. Set your Consul Democracy's url
They'll ask you for your CONSUL's auth URL, and as you can see running `rake routes` at your CONSUL repo locally:
They'll ask you for your Consul Democracy's auth URL, and as you can see running `rake routes` at your Consul Democracy repo locally:
```bash
user_omniauth_authorize GET|POST /users/auth/:provider(.:format) users/omniauth_callbacks#passthru {:provider=>/twitter|facebook|google_oauth2/}

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

@@ -2,7 +2,7 @@
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 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!

6
docs/en/getting_started/configuration.md
View File

@@ -2,15 +2,15 @@
## 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 alright.
[Travis](https://travis-ci.org/) is a Continuous Integration service, free for OpenSource projects (like Consul Democracy and its 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.
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.
3. If you are asked to Authorize Travis CI to access your Github account, check the organization or user where you have your Consul Democracy 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.
4. Visit your [Travis profile](https://travis-ci.org/profile/) and enable Travis for your Consul Democracy fork in the list of repositories.
5. Click on the sprocket icon to the right of the repository to see the builds.

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

@@ -1,12 +1,12 @@
# Creating your fork
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).
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).
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 understand 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 Democracy. **This is not mandatory**, but it will help understand 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 Democracy](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.
@@ -16,7 +16,7 @@ Consul git repo is hosted at Github.com, we recommend using it for your fork's r
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.
- **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 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/consul/consul/blob/master/LICENSE-AGPLv3.txt) license** that commands to publish source code.

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

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

18
docs/en/getting_started/update.md
View File

@@ -13,7 +13,7 @@ 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:
Now we have to add Consul Democracy's github as upstream remote with:
```bash
git remote add upstream git@github.com:consul/consul.git
@@ -32,9 +32,9 @@ again you should get:
> origin git@github.com:your_user_name/consul.git (fetch)\
> origin git@github.com:your_user_name/consul.git (push)
## Pulling changes from CONSUL
## Pulling changes from Consul Democracy
Start by creating a branch named **upstream** from your **master** branch to apply CONSUL changes:
Start by creating a branch named **upstream** from your **master** branch to apply Consul Democracy changes:
```bash
git checkout master
@@ -42,7 +42,7 @@ git pull
git checkout -b upstream
```
Then we can fetch all changes from **consul** remote server with:
Then we can fetch all changes from the **Consul Democracy** remote server with:
```bash
git fetch upstream
@@ -50,7 +50,7 @@ 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 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`.
@@ -58,12 +58,12 @@ B. Just update up to an specific release tag (so you can do incremental updates
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 Democracy 😊👌.
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.
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 Democracy'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.
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 Democracy 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>.
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>.

20
docs/en/installation/basic_configuration.md
View File

@@ -1,6 +1,6 @@
# Basic Configuration
Once you have CONSUL running on the server, there are some basic configuration options that you probably want to define in order to start using it. To do this you will need to open your CONSUL installation through any internet browser and log in with the administration user \(initially it is the `admin@consul.dev` user with the password `12345678`\).
Once you have Consul Democracy running on the server, there are some basic configuration options that you probably want to define in order to start using it. To do this you will need to open your Consul Democracy installation through any internet browser and log in with the administration user \(initially it is the `admin@consul.dev` user with the password `12345678`\).
Once you have logged in you will see on the top right of the screen the "Admin" link that will take you to the administration interface. From this interface you can configure the following basic options:
@@ -14,7 +14,7 @@ In the side menu you will find the option "Settings" and then the submenu "Globa
* Main URL. Main URL of your website
* Minimum age needed to participate. If you use a user verification system this will be the minimum age that users will be required to be. The user verification system will be discussed in more detail later.
* Number of supports necessary for approval of a Proposal. If you use the citizen proposals section, you can define a minimum number of supports that the proposals need in order to be considered. Any user will be able to create proposals but only those that reach that value will be taken into account.
* Level x public official . CONSUL allows some user accounts to be marked as "official accounts" and their interventions on the platform are highlighted. This for example is used in a city if you want to define accounts for the Mayor, Councillors, etc. This public official option will allow you to define the official label that appears next to the user names of these accounts from most important \(level 1\) to least \(level 5\).
* Level x public official. Consul Democracy allows some user accounts to be marked as "official accounts" and their interventions on the platform are highlighted. This for example is used in a city if you want to define accounts for the Mayor, Councillors, etc. This public official option will allow you to define the official label that appears next to the user names of these accounts from most important \(level 1\) to least \(level 5\).
## Categories of proposals
@@ -22,7 +22,7 @@ When users create proposals on the platform, a few general categories are sugges
## Definition of Geozones
Geozones are smaller territorial areas than the area in which you use CONSUL \(e.g. districts in a city in which CONSUL is used\). If the geozones are activated, it will allow for example that the citizen proposals are assigned to a specific area, or that the votings are restricted to people living in some area.
Geozones are smaller territorial areas than the area in which you use Consul Democracy \(e.g. districts in a city in which Consul Democracy is used\). If the geozones are activated, it will allow for example that the citizen proposals are assigned to a specific area, or that the votings are restricted to people living in some area.
In the side menu you will find the option "Settings" and then the submenu "Manage geozones". To the right the button "Create geozone" will allow you to create new geozones. Only the name is necessary to define them, but you can add other data that are useful in certain sections. Initially we recommend that you start by defining only the names of the zones.
@@ -47,19 +47,19 @@ Then, at the top of this page, go to the "Map configuration" tab. If everything
## Emails to users
CONSUL sends a series of emails to users by default. For example when creating a user account, trying to recover a password, receiving a message from another user, etc.
Consul Democracy sends a series of emails to users by default. For example when creating a user account, trying to recover a password, receiving a message from another user, etc.
All emails sent can be viewed in the menu "Messages to users" in the submenu "System Emails". There you will be able to preview each email and see the file where the content of the email is in case you want to change it.
## Basic information pages
CONSUL has a number of basic information pages that will be shown to users, e.g. "Privacy Policy", "Frequently Asked Questions", "Congratulations you have just created your user account", etc.
Consul Democracy has a number of basic information pages that will be shown to users, e.g. "Privacy Policy", "Frequently Asked Questions", "Congratulations you have just created your user account", etc.
You can see the pages that exist by default and modify them in the menu "Site Content" in the submenu "Custom Pages".
## Main page of the site
When users open your CONSUL installation they will see the home page of the platform. This page is fully configurable, so that you can show the content that seems most relevant to you. You can modify it from the menu "Site content" in the submenu "Homepage".
When users open your Consul Democracy installation they will see the home page of the platform. This page is fully configurable, so that you can show the content that seems most relevant to you. You can modify it from the menu "Site content" in the submenu "Homepage".
Try creating "Headers" and "Cards" and activating the different functionalities you will find below to see the effect they have on your homepage.
@@ -67,14 +67,14 @@ Try creating "Headers" and "Cards" and activating the different functionalities
If you access the menu "Site content" and the submenu "Custom information texts" you will see different tabs with a series of texts. These are all the texts displayed on the platform. By default you can use the existing ones, but at any time you can access this section to modify any of the texts.
For more information on how to add new translations to your version of CONSUL access the "Texts and translations" section of this documentation.
For more information on how to add new translations to your version of Consul Democracy access the "Texts and translations" section of this documentation.
## Channels of participation
By default you will find in CONSUL different ways of participation for users. To begin with and familiarise yourself with the tool, we recommend that you have all of them activated, but you can deactivate the ones that do not seem necessary to you. To do this, go to the "Settings" menu and then to the "Global Settings" submenu. At the top of this page you will find three tabs: "Configuration settings", "Features", "Map configuration". Go to the second tab "Features".
By default you will find in Consul Democracy different ways of participation for users. To begin with and familiarise yourself with the tool, we recommend that you have all of them activated, but you can deactivate the ones that do not seem necessary to you. To do this, go to the "Settings" menu and then to the "Global Settings" submenu. At the top of this page you will find three tabs: "Configuration settings", "Features", "Map configuration". Go to the second tab "Features".
You will find different functionalities with the names of the different participation channels "Debates", "Proposals", "Voting", "Collaborative Legislation" and "Participatory Budgets". You can deactivate any of the functionalities and it will no longer be shown in your CONSUL installation.
You will find different functionalities with the names of the different participation channels "Debates", "Proposals", "Voting", "Collaborative Legislation" and "Participatory Budgets". You can deactivate any of the functionalities and it will no longer be shown in your Consul Democracy installation.
### More information and detailed documentation
These options above will allow you to have a basic version of CONSUL to start using. We recommend that you access the [CONSUL Documentation and Guides](documentation_and_guides.md) section where you can find more detailed documentation.
These options above will allow you to have a basic version of Consul Democracy to start using. We recommend that you access the [Consul Democracy Documentation and Guides](documentation_and_guides.md) section where you can find more detailed documentation.

2
docs/en/installation/create_deploy_user.md
View File

@@ -62,7 +62,7 @@ Test that your user can log in by typing:
You should see the server welcome page and a prompt like this:
```
jupiter@consulserver:~$
jupiter@consuldemocracyserver:~$
```
Note the username at the prompt is not "root", but your username. So everything is fine and we can now block the root account from outside access and also stop allowing password access so only people with SSH keys can log in.

4
docs/en/installation/debian.md
View File

@@ -39,7 +39,7 @@ apt-get install curl
## Ruby version manager
Ruby versions packaged in official repositories are not suitable to work with consul, so we'll have to install it manually.
Ruby versions packaged in official repositories are not suitable to work with Consul Democracy, so we'll have to install it manually.
One possible tool is rvm:
@@ -160,4 +160,4 @@ You also have the option of just installing ChromeDriver from AUR. If you use `p
pacaur -S chromedriver
```
Now you're ready to go get Consul [installed](local_installation.md)!!
Now you're ready to go get Consul Democracy [installed](local_installation.md)!!

12
docs/en/installation/deploying-on-heroku.md
View File

@@ -2,7 +2,7 @@
## Manual deployment
This tutorial assumes that you have already managed to clone CONSUL on your machine and gotten it to work.
This tutorial assumes that you have already managed to clone Consul Democracy on your machine and gotten it to work.
1. First, create a [Heroku](https://www.heroku.com) account if it isn't already done.
2. Install the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) and sign in using
@@ -11,7 +11,7 @@ This tutorial assumes that you have already managed to clone CONSUL on your mach
heroku login
```
3. Go to your CONSUL repository and instantiate the process
3. Go to your Consul Democracy repository and instantiate the process
```bash
cd consul
@@ -28,7 +28,7 @@ This tutorial assumes that you have already managed to clone CONSUL on your mach
heroku addons:create heroku-postgresql
```
You should now have access to an empty Postgres database whose address was automatically saved as an environment variable named _DATABASE\_URL_. CONSUL will automatically connect to it when deployed.
You should now have access to an empty Postgres database whose address was automatically saved as an environment variable named _DATABASE\_URL_. Consul Democracy will automatically connect to it when deployed.
5. **(Not needed)** Add a file name _heroku.yml_ at the root of your project and paste the following in it
@@ -131,7 +131,7 @@ Important: Turn on one worker dyno so that emails get sent.
### Install rails\_12factor and specify the Ruby version
**The rails\_12factor is only useful if you use a version of CONSUL older than 1.0.0. The latter uses Rails 5 which includes the changes.**
**The rails\_12factor is only useful if you use a version of Consul Democracy older than 1.0.0. The latter uses Rails 5 which includes the changes.**
As recommended by Heroku, you can add the gem rails\_12factor and specify the version of Ruby you want to use. You can do so by adding
@@ -141,7 +141,7 @@ gem 'rails_12factor'
ruby 'x.y.z'
```
in the file _Gemfile\_custom_, where `x.y.z` is the version defined in the `.ruby-version` file in the CONSUL repository. Don't forget to run
in the file _Gemfile\_custom_, where `x.y.z` is the version defined in the `.ruby-version` file in the Consul Democracy repository. Don't forget to run
```bash
bundle install
@@ -169,7 +169,7 @@ web: bundle exec puma -C config/puma.rb
### Add configuration variables to tune your app from the dashboard
The free and hobby versions of Heroku are barely enough to run an app like CONSUL. To optimise the response time and make sure the app doesn't run out of memory, you can [change the number of workers and threads](https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server#workers) that Puma uses.
The free and hobby versions of Heroku are barely enough to run an app like Consul Democracy. To optimise the response time and make sure the app doesn't run out of memory, you can [change the number of workers and threads](https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server#workers) that Puma uses.
My recommended settings are one worker and three threads. You can set it by running these two commands:

10
docs/en/installation/digital_ocean.md
View File

@@ -1,6 +1,6 @@
# Installing CONSUL on a Digital Ocean VPS
# Installing Consul Democracy on a Digital Ocean VPS
These instructions will help you register and buy a server in Digital Ocean to install CONSUL.
These instructions will help you register and buy a server in Digital Ocean to install Consul Democracy.
First you need to [sign up](https://cloud.digitalocean.com/registrations/new) and provide your personal information.
@@ -40,11 +40,11 @@ Select and copy all the text and paste it in the pop-up window like this:
![Digital Ocean New SSH Key](../../img/digital_ocean/new_ssh.png)
Please note that there will be two little green checks. If they are not there, retry copying the text because you probably left something out. Give your key a meaningful name, like **CONSUL_key** and click "Add SSH Key" button.
Please note that there will be two little green checks. If they are not there, retry copying the text because you probably left something out. Give your key a meaningful name, like **Consul_Democracy_key** and click "Add SSH Key" button.
By using an SSH key instead of a user/password combination to access your server, it will be much more secure, as only someone with the private SSH key can access the server.
Now in the "Choose a hostname" section change the default for something more meaningful, like **consulserver** for example.
Now in the "Choose a hostname" section change the default for something more meaningful, like **consuldemocracyserver** for example.
![Digital Ocean hostname](../../img/digital_ocean/hostname.png)
@@ -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 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/consul/installer)

12
docs/en/installation/docker.md
View File

@@ -1,9 +1,9 @@
# Using Docker for local development
You can use Docker to have a local CONSUL installation for development if:
You can use Docker to have a local Consul Democracy installation for development if:
- You're having troubles having [prerequisites](prerequisites.md) installed.
- You want to do a quick local installation just to try CONSUL or make a demo.
- You want to do a quick local installation just to try Consul Democracy or make a demo.
- You prefer not to interfere with other rails installations.
## Prerequisites
@@ -100,7 +100,7 @@ POSTGRES_PASSWORD=password docker-compose run app rake db:dev_seed
Pending to be completed... Contributions Welcome!
## Running local CONSUL with Docker
## Running local Consul Democracy with Docker
### macOS & Linux
@@ -133,15 +133,15 @@ Pending to be completed... Contributions Welcome!
## Having trouble?
Run these commands at **Consul's directory**, to erase all your previous Consul's Docker images and containers. Then restart the Docker [installation process](#installation):
Run these commands at **Consul Democracy's directory**, to erase all your previous Consul Democracy's Docker images and containers. Then restart the Docker [installation process](#installation):
1. Remove all CONSUL images:
1. Remove all Consul Democracy images:
```bash
docker-compose down --rmi all -v --remove-orphans
```
2. Remove all CONSUL containers
2. Remove all Consul Democracy containers
```bash
docker-compose rm -f -s -v

12
docs/en/installation/documentation_and_guides.md
View File

@@ -1,9 +1,9 @@
# CONSUL Documentation and guides
# Consul Democracy Documentation and guides
There are several guides where you can read very detailed information about CONSUL and its possibilities. You can find them all at: <http://consulproject.org/en/#documentation>
There are several guides where you can read very detailed information about Consul Democracy and its possibilities. You can find them all at: <http://consulproject.org/en/#documentation>
- **CONSUL Use Guide**. In this guide you can see different ways to use CONSUL and examples of participation processes.
- **CONSUL Administration Guide**. This guide contains detailed information on the administration and management of CONSUL.
- **CONSUL Communication Guide**. This guide can give you an initial idea of how to plan communication campaigns to invite people to use your CONSUL platform. Communication is a key issue in getting relevant participation and engagement.
- **Consul Democracy Use Guide**. In this guide you can see different ways to use Consul Democracy and examples of participation processes.
- **Consul Democracy Administration Guide**. This guide contains detailed information on the administration and management of Consul Democracy.
- **Consul Democracy Communication Guide**. This guide can give you an initial idea of how to plan communication campaigns to invite people to use your Consul Democracy platform. Communication is a key issue in getting relevant participation and engagement.
In addition to these guides you can access the [CONSUL Community](http://community.consulproject.org/), a discussion space to share more documentation, questions, learning, etc.
In addition to these guides you can access the [Consul Democracy Community](http://community.consulproject.org/), a discussion space to share more documentation, questions, learning, etc.

6
docs/en/installation/introduction.md
View File

@@ -2,10 +2,10 @@
These are our recommendations for the different environments and purposes:
- To setup CONSUL 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/consul/installer).
- For developers working on a CONSUL fork we recommend using a UNIX based system (Linux or Mac) and installing CONSUL [locally system wide](local_installation.md).
- 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).
- If you run into problems configuring CONSUL locally system wide and would like to show CONSUL for demo purposes we recommend using [Docker](docker.md) in a local machine.
- If you run into problems configuring Consul Democracy locally system wide and would like to show Consul Democracy for demo purposes we recommend using [Docker](docker.md) in a local machine.
- We also have a [Heroku guide](deploying-on-heroku.md) which can be used for demo purposes in a remote server.

6
docs/en/installation/local_installation.md
View File

@@ -1,8 +1,8 @@
# Local installation
Before installing Consul and having it up and running make sure you all [prerequisites](prerequisites.md) installed.
Before installing Consul Democracy and having it up and running make sure you all [prerequisites](prerequisites.md) installed.
1. First, clone the [Consul Github repository](https://github.com/consul/consul/) and enter the project folder:
1. First, clone the [Consul Democracy Github repository](https://github.com/consul/consul/) and enter the project folder:
```bash
git clone https://github.com/consul/consul.git
@@ -66,7 +66,7 @@ bin/rspec
bin/rails s
```
Congratulations! Your local Consul application will be running now at `http://localhost:3000`.
Congratulations! Your local Consul Democracy application will be running now at `http://localhost:3000`.
In case you want to access the local application as admin, a default user verified and with admin permissions was created by the seed files with **username** `admin@consul.dev` and **password** `12345678`.

2
docs/en/installation/macos.md
View File

@@ -100,4 +100,4 @@ brew install chromedriver
brew install imagemagick
```
Now that we have all the dependencies installed we can go ahead and [install Consul](local_installation.md).
Now that we have all the dependencies installed we can go ahead and [install Consul Democracy](local_installation.md).

6
docs/en/installation/mail_server_configuration.md
View File

@@ -1,6 +1,6 @@
# Mail Server Configuration
This is an example of how to integrate a mailing service with Consul.
This is an example of how to integrate a mailing service with Consul Democracy.
In this example we use [Mailgun](https://www.mailgun.com/).
@@ -17,7 +17,7 @@ In this example we use [Mailgun](https://www.mailgun.com/).
* Since you don't have a domain yet, you should click in the sandbox that is already created
* Remember the following credentials: ![Mailgun sandbox](../../img/mailserver/mailgun-sandbox.png)
## Consul mailing configuration
## Consul Democracy mailing configuration
* Go to the `config/secrets.yml` file
* Change the lines on the file to configure the mail server under the section `staging`, `preproduction` or `production`, depending on your setup:
@@ -35,4 +35,4 @@ In this example we use [Mailgun](https://www.mailgun.com/).
```
* Fill `<smtp address>`, `<domain>`, `<user_name>` and `<password>` with your information
* Save the file and restart your Consul application
* Save the file and restart your Consul Democracy application

6
docs/en/installation/manual_installation_production.md
View File

@@ -21,18 +21,18 @@ mkdir -p shared/public/assets shared/public/system shared/public/ckeditor_assets
## Initial release
Extract from the repo the first release to the respective directory, and create the symbolic link of the current release (replace `<latest_consul_stable_version>` with the latest version number, like 1.3.1 or 1.4.1):
Extract from the repo the first release to the respective directory, and create the symbolic link of the current release (replace `<latest_consuldemocracy_stable_version>` with the latest version number, like 1.3.1 or 1.4.1):
```
cd repo
git archive <latest_consul_stable_version> | tar -x -f - -C ../releases/first
git archive <latest_consuldemocracy_stable_version> | tar -x -f - -C ../releases/first
cd ..
ln -s releases/first current
```
## Gems installation
Install the gems CONSUL depends on:
Install the gems Consul Democracy depends on:
```
cd releases/first

4
docs/en/installation/ubuntu.md
View File

@@ -18,7 +18,7 @@ sudo apt install git
## Ruby version manager
Ruby versions packaged in official repositories are not suitable to work with CONSUL, so we'll have to install it manually.
Ruby versions packaged in official repositories are not suitable to work with Consul Democracy, so we'll have to install it manually.
First, we need to install Ruby's development dependencies:
@@ -108,4 +108,4 @@ sudo apt install chromium-chromedriver
sudo ln -s /usr/lib/chromium-browser/chromedriver /usr/local/bin/
```
Now you're ready to go [get CONSUL installed](local_installation.md)!
Now you're ready to go [get Consul Democracy installed](local_installation.md)!

12
docs/en/installation/using-aws-s3-as-storage.md
View File

@@ -1,8 +1,8 @@
# Using AWS S3 as file storage
While CONSUL keeps most of its data in a PostgreSQL database, all the files such as documents or images have to be stored elsewhere.
While Consul Democracy keeps most of its data in a PostgreSQL database, all the files such as documents or images have to be stored elsewhere.
To take care of them, CONSUL uses the [Paperclip gem](https://github.com/thoughtbot/paperclip) (Warning: this gem is now deprecated and CONSUL will probably migrate to ActiveStorage in the future. Check that this is not already the case before using this guide).
To take care of them, Consul Democracy uses the [Paperclip gem](https://github.com/thoughtbot/paperclip) (Warning: this gem is now deprecated and Consul Democracy will probably migrate to ActiveStorage in the future. Check that this is not already the case before using this guide).
By default, the attachments are stored on the filesystem. However, with services such as Heroku, there is no persistent storage which means that these files are periodically erased.
@@ -16,7 +16,7 @@ First, add the following line in your *Gemfile_custom*
gem 'aws-sdk-s3', '~> 1'
```
Make sure to have a recent version of paperclip (CONSUL is currently using 5.2.1, which doesn't recognize *aws-sdk-s3*). In your Gemfile, the line should be:
Make sure to have a recent version of paperclip (Consul Democracy is currently using 5.2.1, which doesn't recognize *aws-sdk-s3*). In your Gemfile, the line should be:
```
gem 'paperclip', '~> 6.1.0'
@@ -26,7 +26,7 @@ Run `bundle install` to apply your changes.
## Adding your credentials in *secrets.yml*
This guide will assume that you have an Amazon account configured to use S3 and that you created a bucket for your instance of CONSUL. It is highly recommended to use a different bucket for each instance (production, preproduction, staging).
This guide will assume that you have an Amazon account configured to use S3 and that you created a bucket for your instance of Consul Democracy. It is highly recommended to use a different bucket for each instance (production, preproduction, staging).
You will need the following information:
@@ -35,9 +35,9 @@ You will need the following information:
- the **hostname** of the S3 bucket (`s3.eu-central-1.amazonaws.com` for Francfort, for example)
- an **access key id** and a **secret access key** with read/write permission to that bucket
**WARNING:** It is recommended to create IAM users that will only have read/write permission to the bucket you want to use for that specific instance of CONSUL.
**WARNING:** It is recommended to create IAM users that will only have read/write permission to the bucket you want to use for that specific instance of Consul Democracy.
Once you have these pieces of information, you can save them as environment variables of the instance running CONSUL. In this tutorial, we save them respectively as *AWS_S3_BUCKET*, *AWS_S3_REGION*, *AWS_S3_HOSTNAME*, *AWS_ACCESS_KEY_ID* and *AWS_SECRET_ACCESS_KEY*.
Once you have these pieces of information, you can save them as environment variables of the instance running Consul Democracy. In this tutorial, we save them respectively as *AWS_S3_BUCKET*, *AWS_S3_REGION*, *AWS_S3_HOSTNAME*, *AWS_ACCESS_KEY_ID* and *AWS_SECRET_ACCESS_KEY*.
Add the following block in your *secrets.yml* file:

14
docs/en/open_source/contributing.md
View File

@@ -1,10 +1,10 @@
# Contributing
We appreciate you want to help us by contributing to Consul. Here's a guide we made describing how to contribute changes to the project.
We appreciate you want to help us by contributing to Consul Democracy. Here's a guide we made describing how to contribute changes to the project.
## 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 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/consul/consul/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!
@@ -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](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/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.
We suggest to follow these steps to keep a good track of the changes you're about to make:
@@ -25,15 +25,15 @@ 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 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/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`).
- 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).
## Other ways of contributing
We'll appreciate any kind of contribution to Consul. Even if you can't contribute to it coding, you still can:
We'll appreciate any kind of contribution to Consul Democracy. Even if you can't contribute to it coding, you still can:
- Create issues about any problem or error you've encountered.
- Help translate the platform to other languages you master at [Consul's Crowdin](https://crwd.in/consul).
- Help with [Consul's documentation](https://github.com/consul/docs).
- 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).