diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 98c1e88bb..2cd32b362 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -3,7 +3,7 @@ ## ENGLISH Documentation * [Getting started](en/getting_started/getting_started.md) - * [Fork Consul](en/getting_started/create.md) + * [Fork Consul Democracy](en/getting_started/create.md) * [Configure your fork](en/getting_started/configuration.md) * [Keep your fork updated](en/getting_started/update.md) * [Communication](en/getting_started/communication.md) @@ -26,7 +26,7 @@ * [Docker](en/installation/docker.md) * [Mail Server Configuration](en/installation/mail_server_configuration.md) * [Basic configuration](en/installation/basic_configuration.md) - * [CONSUL Documentation and guides](en/installation/documentation_and_guides.md) + * [Consul Democracy Documentation and guides](en/installation/documentation_and_guides.md) * [Customization](en/customization/customization.md) * [Introduction](en/customization/introduction.md) @@ -79,7 +79,7 @@ * [Docker](es/installation/docker.md) * [Configuración del servidor de correo](es/installation/mail_server_configuration.md) * [Configuración básica](es/installation/basic_configuration.md) - * [Documentación y guías sobre CONSUL](es/installation/documentation_and_guides.md) + * [Documentación y guías sobre Consul Democracy](es/installation/documentation_and_guides.md) * [Personalización](es/customization/customization.md) * [Introducción](es/customization/introduction.md) diff --git a/docs/en/book.json b/docs/en/book.json index 45726b068..48009ae57 100644 --- a/docs/en/book.json +++ b/docs/en/book.json @@ -1,5 +1,5 @@ { "gitbook": ">= 3.0.0", - "title": "Consul Documentation", + "title": "Consul Democracy Documentation", "description": "Citizen Participation and Open Government Application" } diff --git a/docs/en/customization/introduction.md b/docs/en/customization/introduction.md index f1b847909..0cd1fb043 100644 --- a/docs/en/customization/introduction.md +++ b/docs/en/customization/introduction.md @@ -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 diff --git a/docs/en/customization/translations.md b/docs/en/customization/translations.md index 971dc40b7..85aa21200 100644 --- a/docs/en/customization/translations.md +++ b/docs/en/customization/translations.md @@ -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. diff --git a/docs/en/features/graphql.md b/docs/en/features/graphql.md index 78b7d3862..3e5efa7c7 100644 --- a/docs/en/features/graphql.md +++ b/docs/en/features/graphql.md @@ -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 diff --git a/docs/en/features/multitenancy.md b/docs/en/features/multitenancy.md index a1c76e164..8a077c47b 100644 --- a/docs/en/features/multitenancy.md +++ b/docs/en/features/multitenancy.md @@ -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 ; @@ -38,14 +38,14 @@ GRANT CREATE ON DATABASE consul_production TO ` 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 `` 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. diff --git a/docs/en/features/oauth.md b/docs/en/features/oauth.md index 097571a2f..8f39e32c3 100644 --- a/docs/en/features/oauth.md +++ b/docs/en/features/oauth.md @@ -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/} diff --git a/docs/en/getting_started/communication.md b/docs/en/getting_started/communication.md index 26f6c91ce..41f169a72 100644 --- a/docs/en/getting_started/communication.md +++ b/docs/en/getting_started/communication.md @@ -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! diff --git a/docs/en/getting_started/configuration.md b/docs/en/getting_started/configuration.md index 63381a0ed..88f878d65 100644 --- a/docs/en/getting_started/configuration.md +++ b/docs/en/getting_started/configuration.md @@ -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 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. diff --git a/docs/en/getting_started/create.md b/docs/en/getting_started/create.md index c6e12b67e..0f4fdb0ae 100644 --- a/docs/en/getting_started/create.md +++ b/docs/en/getting_started/create.md @@ -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 +3. [Fork Consul Democracy](https://help.github.com/articles/fork-a-repo/) using the **fork** button on the top right corner at 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. diff --git a/docs/en/getting_started/getting_started.md b/docs/en/getting_started/getting_started.md index 2a5a0b5c6..ce39fb7d1 100644 --- a/docs/en/getting_started/getting_started.md +++ b/docs/en/getting_started/getting_started.md @@ -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) diff --git a/docs/en/getting_started/update.md b/docs/en/getting_started/update.md index cede402f7..7fb11fdbf 100644 --- a/docs/en/getting_started/update.md +++ b/docs/en/getting_started/update.md @@ -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: . +Remember you can always quickly check changes that will come from Consul Democracy to your fork by replacing **your_org_name** on the url: . diff --git a/docs/en/installation/basic_configuration.md b/docs/en/installation/basic_configuration.md index 3c91c7439..0f44d9111 100644 --- a/docs/en/installation/basic_configuration.md +++ b/docs/en/installation/basic_configuration.md @@ -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. diff --git a/docs/en/installation/create_deploy_user.md b/docs/en/installation/create_deploy_user.md index 48fd6c4db..dd7cb8aa7 100644 --- a/docs/en/installation/create_deploy_user.md +++ b/docs/en/installation/create_deploy_user.md @@ -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. diff --git a/docs/en/installation/debian.md b/docs/en/installation/debian.md index 4e6b249e8..20250cd91 100644 --- a/docs/en/installation/debian.md +++ b/docs/en/installation/debian.md @@ -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)!! diff --git a/docs/en/installation/deploying-on-heroku.md b/docs/en/installation/deploying-on-heroku.md index e04efb507..abf44d836 100644 --- a/docs/en/installation/deploying-on-heroku.md +++ b/docs/en/installation/deploying-on-heroku.md @@ -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: diff --git a/docs/en/installation/digital_ocean.md b/docs/en/installation/digital_ocean.md index bd02590ea..120ee91ad 100644 --- a/docs/en/installation/digital_ocean.md +++ b/docs/en/installation/digital_ocean.md @@ -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) diff --git a/docs/en/installation/docker.md b/docs/en/installation/docker.md index eba0bab90..7e90115f5 100644 --- a/docs/en/installation/docker.md +++ b/docs/en/installation/docker.md @@ -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 diff --git a/docs/en/installation/documentation_and_guides.md b/docs/en/installation/documentation_and_guides.md index 142ecf5a0..cbdf7413e 100644 --- a/docs/en/installation/documentation_and_guides.md +++ b/docs/en/installation/documentation_and_guides.md @@ -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: +There are several guides where you can read very detailed information about Consul Democracy and its possibilities. You can find them all at: -- **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. diff --git a/docs/en/installation/introduction.md b/docs/en/installation/introduction.md index 918dc3dfd..eb06c7f02 100644 --- a/docs/en/installation/introduction.md +++ b/docs/en/installation/introduction.md @@ -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. diff --git a/docs/en/installation/local_installation.md b/docs/en/installation/local_installation.md index ea6c82024..a914cf20a 100644 --- a/docs/en/installation/local_installation.md +++ b/docs/en/installation/local_installation.md @@ -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`. diff --git a/docs/en/installation/macos.md b/docs/en/installation/macos.md index 88c2a4e1a..94b914d28 100644 --- a/docs/en/installation/macos.md +++ b/docs/en/installation/macos.md @@ -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). diff --git a/docs/en/installation/mail_server_configuration.md b/docs/en/installation/mail_server_configuration.md index cb8cd4a1a..906c8287b 100644 --- a/docs/en/installation/mail_server_configuration.md +++ b/docs/en/installation/mail_server_configuration.md @@ -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 ``, ``, `` and `` with your information -* Save the file and restart your Consul application +* Save the file and restart your Consul Democracy application diff --git a/docs/en/installation/manual_installation_production.md b/docs/en/installation/manual_installation_production.md index 6de6accac..ef3d914e3 100644 --- a/docs/en/installation/manual_installation_production.md +++ b/docs/en/installation/manual_installation_production.md @@ -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 `` 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 `` with the latest version number, like 1.3.1 or 1.4.1): ``` cd repo -git archive | tar -x -f - -C ../releases/first +git archive | 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 diff --git a/docs/en/installation/ubuntu.md b/docs/en/installation/ubuntu.md index 5d6cf0d40..6de370199 100644 --- a/docs/en/installation/ubuntu.md +++ b/docs/en/installation/ubuntu.md @@ -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)! diff --git a/docs/en/installation/using-aws-s3-as-storage.md b/docs/en/installation/using-aws-s3-as-storage.md index f0223f885..cf487a363 100644 --- a/docs/en/installation/using-aws-s3-as-storage.md +++ b/docs/en/installation/using-aws-s3-as-storage.md @@ -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: diff --git a/docs/en/open_source/contributing.md b/docs/en/open_source/contributing.md index 73e7694ef..f22c5becd 100644 --- a/docs/en/open_source/contributing.md +++ b/docs/en/open_source/contributing.md @@ -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). diff --git a/docs/es/book.json b/docs/es/book.json index 7749b6377..f9047fe63 100644 --- a/docs/es/book.json +++ b/docs/es/book.json @@ -1,5 +1,5 @@ { "gitbook": ">= 3.0.0", - "title": "Documentación Consul", + "title": "Documentación Consul Democracy", "description": "Aplicación de Gobierno Abierto y Participación Ciudadana" } diff --git a/docs/es/customization/introduction.md b/docs/es/customization/introduction.md index 704ae0642..3a7a572fa 100644 --- a/docs/es/customization/introduction.md +++ b/docs/es/customization/introduction.md @@ -1,12 +1,12 @@ # Personalización -Puedes modificar CONSUL y ponerle tu propia imagen, para esto debes primero [crear tu propio fork](../getting_started/create.md). +Puedes modificar Consul Democracy y ponerle tu propia imagen, para esto debes primero [crear tu propio fork](../getting_started/create.md). -Hemos creado una estructura específica donde puedes sobreescribir y personalizar la aplicación para que puedas actualizar sin que tengas problemas al hacer merge y se sobreescriban por error tus cambios. Intentamos que CONSUL sea una aplicación Ruby on Rails lo más plain vanilla posible para facilitar el acceso de nuevas desarrolladoras. +Hemos creado una estructura específica donde puedes sobreescribir y personalizar la aplicación para que puedas actualizar sin que tengas problemas al hacer merge y se sobreescriban por error tus cambios. Intentamos que Consul Democracy sea una aplicación Ruby on Rails lo más plain vanilla posible para facilitar el acceso de nuevas desarrolladoras. ## Ficheros y directorios especiales -Para adaptar tu fork de CONSUL puedes utilizar alguno de los directorios `custom` que están en las rutas: +Para adaptar tu fork de Consul Democracy puedes utilizar alguno de los directorios `custom` que están en las rutas: * `config/locales/custom/` * `app/assets/images/custom/` @@ -79,7 +79,7 @@ Actualmente estos son todos los [idiomas disponibles](https://api.cognitive.micr ["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"] ``` -De todos los idiomas que actualmente tiene Consul definidos (`available_locales`) en `config/application.rb` el único que no está en la lista anterior y por lo tanto no se ofrece servicio de traducción es el valenciano `["val"]`. +De todos los idiomas que actualmente tiene Consul Democracy definidos (`available_locales`) en `config/application.rb` el único que no está en la lista anterior y por lo tanto no se ofrece servicio de traducción es el valenciano `["val"]`. ### Costes @@ -123,13 +123,13 @@ end ## Interfaz de traducción -Esta funcionalidad permite a los usuarios introducir contenidos dinámicos en diferentes idiomas a la vez. Cualquier usuario administrador de Consul puede activar o desactivar esta funcionalidad a través del panel de administración de la aplicación. Si desactivas esta funcionalidad (configuración de la funcionalidad por defecto) los usuarios sólo podrán introducir un idioma. +Esta funcionalidad permite a los usuarios introducir contenidos dinámicos en diferentes idiomas a la vez. Cualquier usuario administrador de Consul Democracy puede activar o desactivar esta funcionalidad a través del panel de administración de la aplicación. Si desactivas esta funcionalidad (configuración de la funcionalidad por defecto) los usuarios sólo podrán introducir un idioma. ### Activar funcionalidad Para activar la funcionalidad deberá realizar 2 pasos: -1. Ejecutar el siguiente comando `bin/rake settings:create_translation_interface_setting RAILS_ENV=production` (Este paso sólo es necesario para instalaciones de Consul existentes que incorporan esta funcionalidad, para nuevas instalaciones no es necesario) +1. Ejecutar el siguiente comando `bin/rake settings:create_translation_interface_setting RAILS_ENV=production` (Este paso sólo es necesario para instalaciones de Consul Democracy existentes que incorporan esta funcionalidad, para nuevas instalaciones no es necesario) 1. Accedediendo como usuario administrador a través del panel de administración de su aplicación a la sección **Configuración > Funcionalidades** y activando el módulo de **Interfaz de traducción** como se puede ver a continuación: ![Active interface translations](../../img/translations/interface_translations/active-interface-translations-es.png) diff --git a/docs/es/customization/translations.md b/docs/es/customization/translations.md index c18f48d37..64731968b 100644 --- a/docs/es/customization/translations.md +++ b/docs/es/customization/translations.md @@ -2,17 +2,17 @@ ## Traducciones -Actualmente Consul esta traducido total o parcialmente a multiples idiomas, visita el proyecto en [Crowdin](https://crowdin.com/project/consul) +Actualmente Consul Democracy esta traducido total o parcialmente a multiples idiomas, visita el proyecto en [Crowdin](https://crowdin.com/project/consul) -[Únete a los traductores](https://crwd.in/consul) para ayudar a completar los existentes, o contacta con nosotros a través del [gitter de consul](https://gitter.im/consul/consul) para convertirte en Revisor y validar las contribuciones de los traductores. +[Únete a los traductores](https://crwd.in/consul) para ayudar a completar los existentes, o contacta con nosotros a través del [gitter de Consul Democracy](https://gitter.im/consul/consul) para convertirte en Revisor y validar las contribuciones de los traductores. -En el caso de que tu lenguage no este presente en el proyecto de Crowdin, por favor [abre una incicencia](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) y lo añadiremos rápidamente. +En el caso de que tu lenguage no este presente en el proyecto de Crowdin, por favor [abre una incicencia](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) y lo añadiremos rápidamente. Si quieres ver las traducciones de los textos de la web, puedes encontrarlos en los ficheros formato YML disponibles en `config/locales/`. Puedes leer la [guía de internacionalización](http://guides.rubyonrails.org/i18n.html) de Ruby on Rails sobre como funciona este sistema. ## Textos personalizados -Dado que CONSUL está en evolución continua con nuevas funcionalidades, y para que mantener tu fork actualizado sea más sencillo, recomendamos no modificar los ficheros de traducciones, es una mejor idea "sobreescribirlos" usando ficheros personalizados en caso de necesidad de alterar un texto. +Dado que Consul Democracy está en evolución continua con nuevas funcionalidades, y para que mantener tu fork actualizado sea más sencillo, recomendamos no modificar los ficheros de traducciones, es una mejor idea "sobreescribirlos" usando ficheros personalizados en caso de necesidad de alterar un texto. Así pues las adaptaciones las debes poner en el directorio `config/locales/custom/`, recomendamos poner solo los textos que quieras personalizar. Por ejemplo si quieres personalizar el texto de "Ayuntamiento de Madrid, 2016" que se encuentra en el footer en todas las páginas, primero debemos ubicar en que plantilla se encuentra (`app/views/layouts/_footer.html.erb`), vemos que en el código pone lo siguiente: @@ -34,6 +34,6 @@ Si creamos el fichero `config/locales/custom/es/general.yml` y modificamos "Ayun ## Mantener tus Textos Personalizados y Lenguajes -CONSUL tiene la gema [i18n-tasks](https://github.com/glebm/i18n-tasks), es una herramienta estupenda para gestionar textos i18n. Prueba en tu consola `i18n-tasks health` para ver un reporte de estado. +Consul Democracy tiene la gema [i18n-tasks](https://github.com/glebm/i18n-tasks), es una herramienta estupenda para gestionar textos i18n. Prueba en tu consola `i18n-tasks health` para ver un reporte de estado. Si tienes un lenguaje propio diferente al Inglés, deberias añadirlo al fichero de configuración [i18n-tasks.yml para las variables `base_locale` y `locales`](https://github.com/consul/consul/blob/master/config/i18n-tasks.yml#L4-L7) de forma que los ficheros de tu idioma también sean comprobados. diff --git a/docs/es/features/graphql.md b/docs/es/features/graphql.md index 804e0cfcb..662574a79 100644 --- a/docs/es/features/graphql.md +++ b/docs/es/features/graphql.md @@ -30,7 +30,7 @@ ## GraphQL -La API de CONSUL utiliza GraphQL [http://graphql.org](https://graphql.org), en concreto la [implementación en Ruby](http://graphql-ruby.org/). Si no estás familiarizado con este tipo de APIs, es recomendable investigar un poco sobre GraphQL previamente. +La API de Consul Democracy utiliza GraphQL [http://graphql.org](https://graphql.org), en concreto la [implementación en Ruby](http://graphql-ruby.org/). Si no estás familiarizado con este tipo de APIs, es recomendable investigar un poco sobre GraphQL previamente. Una de las caracteríticas que diferencian una API REST de una GraphQL es que con esta última es posible construir *consultas personalizadas*, de forma que el servidor nos devuelva únicamente la información en la que estamos interesados. @@ -68,7 +68,7 @@ Las respuestas son en formato JSON: ## Haciendo peticiones a la API -Siguiendo las [directrices oficiales](http://graphql.org/learn/serving-over-http/), la API de CONSUL soporta los siguientes tipos de peticiones: +Siguiendo las [directrices oficiales](http://graphql.org/learn/serving-over-http/), la API de Consul Democracy soporta los siguientes tipos de peticiones: * Peticiones GET, con la consulta dentro del *query string*. * Peticiones POST diff --git a/docs/es/features/multitenancy.md b/docs/es/features/multitenancy.md index 03ac3395e..a90a55f1e 100644 --- a/docs/es/features/multitenancy.md +++ b/docs/es/features/multitenancy.md @@ -4,13 +4,13 @@ La funcionalidad denominada "multientidad" permite la gestión de varias instituciones ("entidades") independientes dentro de una misma aplicación. Por ejemplo, en nuestro caso, un usuario que se dé de alta en una entidad estará solamente dado de alta en esa entidad y sus datos no serán accesibles desde ninguna de las otras entidades. -A qué entidad accedemos se determina a partir de la URL a la que se accede con el navegador. En CONSUL se determina esta entidad a partir del subdominio de esta URL; por ejemplo, si utilizásemos el dominio `ejemplodesistemasolar.org` para gestionar los diferentes planetas del sistema solar, al acceder a `https://mercurio.ejemplodesistemasolar.org` accederíamos a los datos del planeta Mercurio mientras que al acceder a `https://venus.ejemplodesistemasolar.org` accederíamos a los datos del planeta Venus. También es posible utilizar distintos dominios por entidad (por ejemplo, `ejemplodetierra.org`). +A qué entidad accedemos se determina a partir de la URL a la que se accede con el navegador. En Consul Democracy se determina esta entidad a partir del subdominio de esta URL; por ejemplo, si utilizásemos el dominio `ejemplodesistemasolar.org` para gestionar los diferentes planetas del sistema solar, al acceder a `https://mercurio.ejemplodesistemasolar.org` accederíamos a los datos del planeta Mercurio mientras que al acceder a `https://venus.ejemplodesistemasolar.org` accederíamos a los datos del planeta Venus. También es posible utilizar distintos dominios por entidad (por ejemplo, `ejemplodetierra.org`). ## Habilitar multientidad -### Pasos preliminares tras actualizar desde la versión 1.5.0 de CONSUL +### Pasos preliminares tras actualizar desde la versión 1.5.0 de Consul Democracy -Si has actualizado una instalación de CONSUL a la versión 2.0.0 desde la versión 1.5.0, deberás realizar los siguientes pasos antes de habilitar multientidad. Estos pasos no son necesarios en nuevas instalaciones de CONSUL. +Si has actualizado una instalación de Consul Democracy a la versión 2.0.0 desde la versión 1.5.0, deberás realizar los siguientes pasos antes de habilitar multientidad. Estos pasos no son necesarios en nuevas instalaciones de Consul Democracy. Así, en primer lugar, tras subir la versión 2.0.0 al servidor de producción, tendrás que ejecutar las tareas de actualización de versión: @@ -30,7 +30,7 @@ Una vez hecho esto, deberás abrir una consola de base de datos utilizando un us sudo -u postgres psql -d consul_production ``` -Si no usaste el [instalador](https://github.com/consul/installer/) para instalar CONSUL, es posible que tengas que ejecutar las siguientes consultas de base de datos para garantizar los permisos del usuario de Rails para crear esquemas así como el acceso al esquema de extensiones compartidas: +Si no usaste el [instalador](https://github.com/consul/installer/) para instalar Consul Democracy, es posible que tengas que ejecutar las siguientes consultas de base de datos para garantizar los permisos del usuario de Rails para crear esquemas así como el acceso al esquema de extensiones compartidas: ``` CREATE SCHEMA shared_extensions AUTHORIZATION ; @@ -45,7 +45,7 @@ ALTER EXTENSION pg_trgm SET SCHEMA shared_extensions; ALTER EXTENSION unaccent SET SCHEMA shared_extensions; ``` -### Paso común a todas las instalaciones de CONSUL +### Paso común a todas las instalaciones de Consul Democracy Existen dos posibles maneras de habilitar multientidad: @@ -58,7 +58,7 @@ Tras habilitar esta opción, reinicia la aplicación. ## Gestión de entidades -Una vez habilitada la funcionalidad de multientidad y reiniciada la aplicación, aparecerá una nueva sección "Multientidad" dentro del menú "Configuración" de la administración de CONSUL. +Una vez habilitada la funcionalidad de multientidad y reiniciada la aplicación, aparecerá una nueva sección "Multientidad" dentro del menú "Configuración" de la administración de Consul Democracy. ![Nueva sección con el listado de entidades, con su nombre y dominio o subdominio](../../img/multitenancy/index-es.png) @@ -74,7 +74,7 @@ El nombre se usará como nombre del sitio por defecto para nuevas entidades. Nó El dominio o subdominio será el que la aplicación utilice para acceder a la entidad. Si tienes un dominio como `ejemplodesistemasolar.org` y quieres acceder a las entidades utilizando subdominios (como `marte.ejemplodesistemasolar.org`), elige "Utiliza un subdominio". Si estás usando un dominio diferente para la entidad (como `ejemplodemarte.org`), elige "Utiliza un dominio distinto". -Nótese que, si estás usando un dominio distinto para una entidad, tendrás que configurar tus certificados SSL, servidor web y DNS para que acepten ese dominio y apunten a tu aplicación CONSUL. +Nótese que, si estás usando un dominio distinto para una entidad, tendrás que configurar tus certificados SSL, servidor web y DNS para que acepten ese dominio y apunten a tu aplicación Consul Democracy. Al añadir una nueva entidad, se creará automáticamente un usuario con permiso de administrador para esta nueva entidad **cuyos datos de acceso serán una copia de los del administrador que crea la entidad**. Este usuario se almacenará en el esquema de base de datos de la nueva entidad, con lo que cambiar su contraseña en una entidad no cambiará su contraseña en otras entidades. @@ -82,9 +82,9 @@ Al añadir una nueva entidad, se creará automáticamente un usuario con permiso ### Certificados SSL -Para que la aplicación sea accesible utilizando conexiones seguras de HTTPS/SSL, deberás tener un certificado SSL válido para la entidad que acabas de añadir. Dado que cada institución que utiliza CONSUL tiene su propio sistema para gestionar estos certificados, conseguir un certificado para la nueva entidad variará en función del sistema que utilice tu institución. +Para que la aplicación sea accesible utilizando conexiones seguras de HTTPS/SSL, deberás tener un certificado SSL válido para la entidad que acabas de añadir. Dado que cada institución que utiliza Consul Democracy tiene su propio sistema para gestionar estos certificados, conseguir un certificado para la nueva entidad variará en función del sistema que utilice tu institución. -Si has instalado CONSUL usando el instalador y estás usando Certbot para gestionar estos certificados, tienes dos opciones. +Si has instalado Consul Democracy usando el instalador y estás usando Certbot para gestionar estos certificados, tienes dos opciones. Una opción es añadir manualmente cada certificado cada vez que creas una entidad. Por ejemplo, para añadir la entidad con subdominio `marte` al dominio `ejemplodesistemasolar.org`, ejecuta: @@ -98,7 +98,7 @@ Si vas a añadir muchos subdominios en distintos momentos, esta tarea puede resu sudo certbot certonly --manual --agree-tos --expand -d ejemplodesistemasolar.org,*.ejemplodesistemasolar.org ``` -Se te pedirá crear un registro TXT en el DNS de tu dominio con el subdominio `_acme-challenge` y con un cierto valor. También es posible que se te pida crear un archivo con un cierto nombre y un cierto contenido (normalmente en un directorio llamado `.well-known/acme-challenge`); si ese es el caso, asumiendo que estás usando los directorios por defecto de CONSUL, crea el fichero en `/home/deploy/consul/current/public/.well-known/acme-challenge/`. +Se te pedirá crear un registro TXT en el DNS de tu dominio con el subdominio `_acme-challenge` y con un cierto valor. También es posible que se te pida crear un archivo con un cierto nombre y un cierto contenido (normalmente en un directorio llamado `.well-known/acme-challenge`); si ese es el caso, asumiendo que estás usando los directorios por defecto de Consul Democracy, crea el fichero en `/home/deploy/consul/current/public/.well-known/acme-challenge/`. Después de esto, actualiza la configuración de tu servidor web (por defecto, `/etc/nginx/sites-enabled/default`) para que use el certificado que se ha generado, y reinicia el servidor web con `sudo systemctl restart nginx`. @@ -162,13 +162,13 @@ Tras editar el fichero, reinicia la aplicación. ### Mantenimiento del fichero schema.rb -Cuando CONSUL crea una entidad, utiliza el fichero `db/schema.rb` para crear un nuevo esquema de la base de datos para esta entidad. Esto significa que, si por alguna razón este fichero no contiene la misma estructura de base de datos que se generaría creando una nueva base de datos y ejecutando las migraciones con `rake db:migrate`, podría darse el caso de que diferentes entidades tuvieran diferentes tablas o columnas en sus esquemas de base de datos. Las consecuencias de esta configuración podrían ser fatales. +Cuando Consul Democracy crea una entidad, utiliza el fichero `db/schema.rb` para crear un nuevo esquema de la base de datos para esta entidad. Esto significa que, si por alguna razón este fichero no contiene la misma estructura de base de datos que se generaría creando una nueva base de datos y ejecutando las migraciones con `rake db:migrate`, podría darse el caso de que diferentes entidades tuvieran diferentes tablas o columnas en sus esquemas de base de datos. Las consecuencias de esta configuración podrían ser fatales. -Para evitarlo, recomendamos encarecidamente comprobar en tu sistema de integración continua que el fichero `db/schema.rb` que se encuentra en control de versiones es correcto. CONSUL incluye ya esta comprobación si realizas la integración continua con GitHub Actions. Contribuciones incluyendo esta comprobación en GitLab CI u otros entornos son más que bienvenidas. +Para evitarlo, recomendamos encarecidamente comprobar en tu sistema de integración continua que el fichero `db/schema.rb` que se encuentra en control de versiones es correcto. Consul Democracy incluye ya esta comprobación si realizas la integración continua con GitHub Actions. Contribuciones incluyendo esta comprobación en GitLab CI u otros entornos son más que bienvenidas. ### Estilos personalizados para cada entidad mediante CSS -Cuando la funcionalidad de multientidad está activada, CONSUL añade una clase al elemento `` para que sea posible aplicar estilos (o eventos de JavaScript) solamente en ciertas entidades. Por ejemplo, en la entidad con subdominio `urano` este elemento tendría la clase `tenant-urano`. +Cuando la funcionalidad de multientidad está activada, Consul Democracy añade una clase al elemento `` para que sea posible aplicar estilos (o eventos de JavaScript) solamente en ciertas entidades. Por ejemplo, en la entidad con subdominio `urano` este elemento tendría la clase `tenant-urano`. Así, es posible sobrescribir los estilos para una entidad específica añadiendo a alguna hoja de estilos en la carpeta `app/assets/stylesheets/custom/`: @@ -207,17 +207,17 @@ Por ejemplo, si estás escribiendo una vista personalizada del componente `admin ## Limitaciones actuales de multientidad -La funcionalidad de multientidad se incluyó por primera vez en CONSUL 2.0.0 y hay algunas cosas que todavía no están disponibles. +La funcionalidad de multientidad se incluyó por primera vez en Consul Democracy 2.0.0 y hay algunas cosas que todavía no están disponibles. ### Aplicaciones disponibles desde múltiples dominios -Es posible que permitas acceder a tu aplicación de CONSUL desde dos dominios distintos; por ejemplo, `ejemplodesistemasolar.org` y un dominio en inglés llamado `solarsystemexample.org`. +Es posible que permitas acceder a tu aplicación de Consul Democracy desde dos dominios distintos; por ejemplo, `ejemplodesistemasolar.org` y un dominio en inglés llamado `solarsystemexample.org`. En este caso, para conseguir que multientidad funcione con ambos dominios, es necesario cambiar ligeramente el código fuente de la aplicación. En concreto, hay que cambiar el método `allowed_domains` de la clase `Tenant` para que incluya ambos dominios. En la [documentación de personalización de modelos](../customization/models.md) puedes ver ejemplos de cómo personalizar métodos como este. ### Imágenes personalizadas por entidad -El panel de administración de CONSUL contiene una sección llamada "Personalizar imágenes", donde es posible personalizar algunas (aunque no todas) de las imágenes que aparecen en la aplicación. Usar esta interfaz permite tener imágenes distintas para cada entidad. +El panel de administración de Consul Democracy contiene una sección llamada "Personalizar imágenes", donde es posible personalizar algunas (aunque no todas) de las imágenes que aparecen en la aplicación. Usar esta interfaz permite tener imágenes distintas para cada entidad. A veces, sin embargo, es útil incluir ciertas imágenes bajo control de versiones. Por ejemplo, si quisiéramos usar un logo distinto para una entidad en el subdominio `neptuno`, pondríamos ese archivo en `app/assets/images/custom/tenants/neptuno/logo_header.png`. @@ -225,16 +225,16 @@ Este sistema tiene una limitación y es que solamente funcionará para imágenes ### Bases de datos en distintos servidores para cada entidad -En la versión 2.0.0 de CONSUL, los datos de todas las entidades se almacenan en la misma base de datos y por tanto no es posible usar bases de datos en distintos servidores. +En la versión 2.0.0 de Consul Democracy, los datos de todas las entidades se almacenan en la misma base de datos y por tanto no es posible usar bases de datos en distintos servidores. -En caso de que esta funcionalidad sea suficientemente solicitada, podrá incluirse en CONSUL en el futuro. Hay que tener en cuenta que la versión 2.0.0 de CONSUL utiliza Rails 6.0 y que para esta funcionalidad será necesario usar Rails 6.1 o incluso Rails 7.0. +En caso de que esta funcionalidad sea suficientemente solicitada, podrá incluirse en Consul Democracy en el futuro. Hay que tener en cuenta que la versión 2.0.0 de Consul Democracy utiliza Rails 6.0 y que para esta funcionalidad será necesario usar Rails 6.1 o incluso Rails 7.0. ### Idiomas distintos para distintas entidades En la versión 2.0.0 de COSNSUL, todas las entidades están disponibles en los mismos idiomas, con lo que no sería posible (por ejemplo) que una entidad estuviera disponible en francés y otra en alemán, sino que ambas tendrían que estar disponibles en ambos idiomas. -Implementar esta posibilidad está planeado para la versión 2.1.0 de CONSUL. +Implementar esta posibilidad está planeado para la versión 2.1.0 de Consul Democracy. ### Borrado de entidades -Dado que eliminar una entidad borraría **todos** los datos relacionados con esa entidad y no se podrían restaurar, CONSUL no ofrece la opción de eliminar una entidad ya creada desde el panel de administración y solamente permite deshabilitarlas para que no sea posible acceder a ellas. Para eliminar una entidad, utiliza la consola de Rails. +Dado que eliminar una entidad borraría **todos** los datos relacionados con esa entidad y no se podrían restaurar, Consul Democracy no ofrece la opción de eliminar una entidad ya creada desde el panel de administración y solamente permite deshabilitarlas para que no sea posible acceder a ellas. Para eliminar una entidad, utiliza la consola de Rails. diff --git a/docs/es/features/oauth.md b/docs/es/features/oauth.md index 849c1e1ba..4bd0e13ad 100644 --- a/docs/es/features/oauth.md +++ b/docs/es/features/oauth.md @@ -6,9 +6,9 @@ Puedes configurar la autenticación con servicios externos usando OAuth, por aho Para cada plataforma, sigue las instrucciones en la sección de desarrolladores de su página web. -## 2. Establece la url de tu CONSUL +## 2. Establece la url de tu Consul Democracy -Te preguntarán por la URL de autenticación de tu instalación de CONSUL, y como podrás comprobar corriendo la tarea `rake routes` en tu repositorio local: +Te preguntarán por la URL de autenticación de tu instalación de Consul Democracy, y como podrás comprobar corriendo la tarea `rake routes` en tu repositorio local: ```bash user_omniauth_authorize GET|POST /users/auth/:provider(.:format) users/omniauth_callbacks#passthru {:provider=>/twitter|facebook|google_oauth2/} diff --git a/docs/es/getting_started/communication.md b/docs/es/getting_started/communication.md index d549a4a11..d32d32cb4 100644 --- a/docs/es/getting_started/communication.md +++ b/docs/es/getting_started/communication.md @@ -1,6 +1,6 @@ # Comunicación -Para comunicar sugerencias/incidencias te animamos a [abrir una incidencia en el repositorio de Documentación de Consul](https://github.com/consul/consul/issues/new). +Para comunicar sugerencias/incidencias te animamos a [abrir una incidencia en el repositorio de Documentación de Consul Democracy](https://github.com/consul/consul/issues/new). Para comunicaciones más informales, chatea con nosotros en el [gitter de consul](https://gitter.im/consul/consul) diff --git a/docs/es/getting_started/configuration.md b/docs/es/getting_started/configuration.md index 0df5b551d..9ea9a0327 100644 --- a/docs/es/getting_started/configuration.md +++ b/docs/es/getting_started/configuration.md @@ -2,15 +2,15 @@ ## Travis CI -[Travis](https://travis-ci.org/) es un servicio de Integración Contínua, gratuito para proyectos OpenSource (como Consul y sus forks). Te ayudará a vigilar que en las Pull Requests no se rompan los tests. +[Travis](https://travis-ci.org/) es un servicio de Integración Contínua, gratuito para proyectos OpenSource (como Consul Democracy y sus forks). Te ayudará a vigilar que en las Pull Requests no se rompan los tests. 1. Visita y haz click en el botón verde "**Install it for free**"" al pie de la página. 2. Haz click en el botón verde "**Complete order and begin installation**" -3. Si se te solicita acceso a tu cuenta de Github por parte de Travis CIaccess, marca la organización o usuario bajo el cual reside tu fork de Consul y haz click en el botón "**Authorize travis-ci**". +3. Si se te solicita acceso a tu cuenta de Github por parte de Travis CIaccess, marca la organización o usuario bajo el cual reside tu fork de Consul Democracy y haz click en el botón "**Authorize travis-ci**". -4. Visita [tu perfil en Travis](https://travis-ci.org/profile/) y habilita Travis para tu fork de Consul en el listado de repositorios. +4. Visita [tu perfil en Travis](https://travis-ci.org/profile/) y habilita Travis para tu fork de Consul Democracy en el listado de repositorios. 5. Haz click en el icono de un piñón a la derecha del repositorio para ver las builds. diff --git a/docs/es/getting_started/create.md b/docs/es/getting_started/create.md index abac3c6e8..65c8d2213 100644 --- a/docs/es/getting_started/create.md +++ b/docs/es/getting_started/create.md @@ -1,12 +1,12 @@ # Crea tu fork -El repositorio git de Consul está hospedado en Github.com, recomendamos lo uses para tu fork para hacer las cosas mas fáciles. Pero puedes usar cualquier otro servicio como Bitbucket o Gitlab si deseas, pero no te olvides de poner el enlace en el footer a tu repositorio en cumplimiento con la licencia de este proyecto (GPL Affero 3). +El repositorio git de Consul Democracy está hospedado en Github.com, recomendamos lo uses para tu fork para hacer las cosas mas fáciles. Pero puedes usar cualquier otro servicio como Bitbucket o Gitlab si deseas, pero no te olvides de poner el enlace en el footer a tu repositorio en cumplimiento con la licencia de este proyecto (GPL Affero 3). 1. [Registra una cuenta de usuario en Github](https://github.com/join) si no tienes una ya. -2. [Crea una Organización](https://help.github.com/articles/creating-a-new-organization-from-scratch/) en Github con el nombre de la ciudad u organización que usará Consul. **Esto no es obligatorio**, pero ayudará a entender el propósito del fork y la colaboración de otros usuarios. +2. [Crea una Organización](https://help.github.com/articles/creating-a-new-organization-from-scratch/) en Github con el nombre de la ciudad u organización que usará Consul Democracy. **Esto no es obligatorio**, pero ayudará a entender el propósito del fork y la colaboración de otros usuarios. -3. [Forkea Consul](https://help.github.com/articles/fork-a-repo/) usando el botón de **fork** en la esquina superior derecha de +3. [Forkea Consul Democracy](https://help.github.com/articles/fork-a-repo/) usando el botón de **fork** en la esquina superior derecha de 4. [Clona el repositorio de tu fork](https://help.github.com/articles/cloning-a-repository/) en tu ordenador @@ -16,7 +16,7 @@ El repositorio git de Consul está hospedado en Github.com, recomendamos lo uses Recomendamos publicar el código por varias razones: -- **Transparencia**: Debería ser parte de la cultura de aquellas entidades públicas que adopten Consul, así como cualquier organización o grupo. -- **Soporte**: Si necesitas ayuda técnica, el resto de la comunidad o el equipo de Consul podrán entender y aconsejar mas fácilmente al ver el código implicado. +- **Transparencia**: Debería ser parte de la cultura de aquellas entidades públicas que adopten Consul Democracy, así como cualquier organización o grupo. +- **Soporte**: Si necesitas ayuda técnica, el resto de la comunidad o el equipo de Consul Democracy podrán entender y aconsejar mas fácilmente al ver el código implicado. - **Colaboración**: Por parte de otros profesionales, ciudadanos, etc... -- Por último y no menos importante, Consul se distribuye bajo la **licencia [AGPLv3](https://github.com/consul/consul/blob/master/LICENSE-AGPLv3.txt)** que obliga a publicar el codigo fuente. +- Por último y no menos importante, Consul Democracy se distribuye bajo la **licencia [AGPLv3](https://github.com/consul/consul/blob/master/LICENSE-AGPLv3.txt)** que obliga a publicar el codigo fuente. diff --git a/docs/es/getting_started/getting_started.md b/docs/es/getting_started/getting_started.md index 2a5a0b5c6..ce39fb7d1 100644 --- a/docs/es/getting_started/getting_started.md +++ b/docs/es/getting_started/getting_started.md @@ -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) diff --git a/docs/es/getting_started/update.md b/docs/es/getting_started/update.md index cb7484221..5fac43d97 100644 --- a/docs/es/getting_started/update.md +++ b/docs/es/getting_started/update.md @@ -13,7 +13,7 @@ deberías ver algo como: > origin git@github.com:your_user_name/consul.git (fetch)\ > origin git@github.com:your_user_name/consul.git (push) -Ahora debes añadir el repositorio git de CONSUL como servidor remoto con: +Ahora debes añadir el repositorio git de Consul Democracy como servidor remoto con: ```bash git remote add upstream git@github.com:consul/consul.git @@ -32,7 +32,7 @@ deberías recibir algo como: > origin git@github.com:your_user_name/consul.git (fetch)\ > origin git@github.com:your_user_name/consul.git (push) -## Obteniendo cambios de consul +## Obteniendo cambios de Consul Democracy Empieza creando una rama **upstream** a partir de tu rama **master** sobre la que trabajar: @@ -42,7 +42,7 @@ git pull git checkout -b upstream ``` -Y actualiza la información del repositorio de consul con las referencias a las ramas, tags, etc..: +Y actualiza la información del repositorio de Consul Democracy con las referencias a las ramas, tags, etc..: ```bash git fetch upstream @@ -58,12 +58,12 @@ B. Sólo actualizar hasta cierta versión (en el caso de que prefieras actualiza Tras el `merge` de la anterior sección, hay tres posibles escenarios: -A. Obtienes una respuesta `Already up-to-date.`. Eso significa que tu fork esta al dia con los cambios de CONSUL 😊👌 +A. Obtienes una respuesta `Already up-to-date.`. Eso significa que tu fork esta al dia con los cambios de Consul Democracy 😊👌 -B. Se abre una ventana del editor que tengas configurado en git, mostrando el mensaje de commit `Merge remote-tracking branch 'upstream/master' into upstream`. Esto significa que git fue capaz de mezclar los cambios de CONSUL sobre tu código sin encontrar problemas o conflictos. Termina el commit. +B. Se abre una ventana del editor que tengas configurado en git, mostrando el mensaje de commit `Merge remote-tracking branch 'upstream/master' into upstream`. Esto significa que git fue capaz de mezclar los cambios de Consul Democracy sobre tu código sin encontrar problemas o conflictos. Termina el commit. -C. Recibes mensajes de error de git junto con un `Automatic merge failed; fix conflicts and then commit the result.`. Esto significa que se han encontrado conflictos entre los cambios en tu código y los cambios que se realizaron en CONSUL desde la última vez que actualizaste tu fork. Esta es una de las principales razones para intentar mantener tu fork lo más al dia posible, realizando este proceso al menos mensualmente. Resuelve manualmente los conflictos para terminar el merge y haz un commit. +C. Recibes mensajes de error de git junto con un `Automatic merge failed; fix conflicts and then commit the result.`. Esto significa que se han encontrado conflictos entre los cambios en tu código y los cambios que se realizaron en Consul Democracy desde la última vez que actualizaste tu fork. Esta es una de las principales razones para intentar mantener tu fork lo más al dia posible, realizando este proceso al menos mensualmente. Resuelve manualmente los conflictos para terminar el merge y haz un commit. Ahora simplemente sube la rama **upstream** a github y crea un Pull Request, así podrás ver de manera sencilla todos los cambios que se han realizado en el repositorio y verás también como arranca la suite de tests. -Recuerda que siempre puedes comprobar rápidamente los cambios que tienes pendientes de integrar de CONSUL a tu fork sustituyendo **your_org_name** en la url: +Recuerda que siempre puedes comprobar rápidamente los cambios que tienes pendientes de integrar de Consul Democracy a tu fork sustituyendo **your_org_name** en la url: diff --git a/docs/es/installation/basic_configuration.md b/docs/es/installation/basic_configuration.md index aef36784f..3a4f261c8 100644 --- a/docs/es/installation/basic_configuration.md +++ b/docs/es/installation/basic_configuration.md @@ -1,8 +1,8 @@ # Configuración básica -Una vez que tengas CONSUL funcionando en el servidor, hay algunas opciones básicas de configuración que probablemente quieras definir para poder empezar a usarlo. +Una vez que tengas Consul Democracy funcionando en el servidor, hay algunas opciones básicas de configuración que probablemente quieras definir para poder empezar a usarlo. -Para ello deberás acceder a tu instalación de CONSUL a través de cualquier navegador de internet e identificarte con el usuario de administración (inicialmente es el usuario `admin@consul.dev` con la contraseña `12345678`). Una vez identificado verás en la parte superior derecha de la pantalla el enlace "Admin" que te llevará a la interfaz de administración. Desde esta interfaz puedes configurar las siguientes opciones básicas: +Para ello deberás acceder a tu instalación de Consul Democracy a través de cualquier navegador de internet e identificarte con el usuario de administración (inicialmente es el usuario `admin@consul.dev` con la contraseña `12345678`). Una vez identificado verás en la parte superior derecha de la pantalla el enlace "Admin" que te llevará a la interfaz de administración. Desde esta interfaz puedes configurar las siguientes opciones básicas: ## Parámetros de la configuración global @@ -14,7 +14,7 @@ En el menú lateral encontrarás la opción "Configuración" y posteriormente el - URL general de la web. URL principal de tu web. - Edad mínima para participar. Si utilizas un sistema de verificación de usuarios esta será la edad mínima que se exigirá a los usuarios. Sobre el sistema de verificación de usuarios hablaremos en más detalle más adelante. - Número de apoyos necesarios para aprobar una Propuesta. Si utilizas la sección de propuestas ciudadanas, puedes definir un mínimo de apoyos que necesitan las propuestas para ser consideradas. Cualquier usuario podrá crear propuestas pero solo las que lleguen a ese valor serán tenidas en cuenta. -- Cargos públicos de nivel x. CONSUL permite que algunas cuentas de usuario se marquen como "cuentas oficiales" apareciendo más resaltadas sus intervenciones en la plataforma. Esto por ejemplo se usa en una ciudad si se quieren definir cuentas para el Alcalde, los Concejales, etc. Esta opción de cargos públicos te permitirá definir la etiqueta oficial que aparece al lado de los nombres de usuario de estas cuentas de mayor importancia (nivel 1) a menor (nivel 5). +- Cargos públicos de nivel x. Consul Democracy permite que algunas cuentas de usuario se marquen como "cuentas oficiales" apareciendo más resaltadas sus intervenciones en la plataforma. Esto por ejemplo se usa en una ciudad si se quieren definir cuentas para el Alcalde, los Concejales, etc. Esta opción de cargos públicos te permitirá definir la etiqueta oficial que aparece al lado de los nombres de usuario de estas cuentas de mayor importancia (nivel 1) a menor (nivel 5). ## Categorías de las propuestas @@ -22,7 +22,7 @@ Cuando los usuarios crean propuestas en la plataforma se sugieren unas categorí ## Definición de geozonas -Las geozonas son áreas territoriales más pequeñas que la zona en la que usas CONSUL (por ejemplo los distritos en una ciudad en la que se use CONSUL). Si las activas permitirá por ejemplo que las propuestas ciudadanas se asignen a una zona concreta, o que las votaciones estén restringidas a la gente que viva en alguna zona. +Las geozonas son áreas territoriales más pequeñas que la zona en la que usas Consul Democracy (por ejemplo los distritos en una ciudad en la que se use Consul Democracy). Si las activas permitirá por ejemplo que las propuestas ciudadanas se asignen a una zona concreta, o que las votaciones estén restringidas a la gente que viva en alguna zona. En el menú lateral encontrarás la opción "Configuración" y posteriormente el submenú "Gestionar distritos". A la derecha el botón "Crear distrito" te permitirá crear nuevas geozonas. Solo el nombre es necesario para definirlas, pero podrás agregar otros datos que son útiles en ciertas secciones. Inicialmente te recomendamos que empieces definiendo sólo los nombres de las zonas. @@ -48,19 +48,19 @@ A continuación, en la parte superior de esta página accede a la pestaña "Conf ## Emails a usuarios -CONSUL envía por defecto una serie de correos electrónicos a los usuarios. Por ejemplo al crear una cuenta de usuario, al intentar recuperar la contraseña, al recibir un mensaje de otro usuario, etc. +Consul Democracy envía por defecto una serie de correos electrónicos a los usuarios. Por ejemplo al crear una cuenta de usuario, al intentar recuperar la contraseña, al recibir un mensaje de otro usuario, etc. Todos los correos que se envían puedes visualizarlos en el menú "Mensajes a usuarios" en el submenú "Emails del sistema". Ahí podrás previsualizar cada correo electrónico y ver el archivo donde está el contenido del correo por si quieres cambiarlo. ## Páginas básicas de información -CONSUL cuenta con una serie de páginas básicas de información que se mostrarán a los usuarios. Por ejemplo "Política de Privacidad", "Preguntas Frecuentes", "Felicidades acabas de crear tu cuenta de usuario", etc. +Consul Democracy cuenta con una serie de páginas básicas de información que se mostrarán a los usuarios. Por ejemplo "Política de Privacidad", "Preguntas Frecuentes", "Felicidades acabas de crear tu cuenta de usuario", etc. Puedes ver las páginas que existen por defecto y modificarlas en el menú "Contenido del sitio" en el submenú "Personalizar Páginas". ## Página principal del sitio -Al acceder a tu instalación de CONSUL los usuarios verán la página principal de la plataforma. Esta página es totalmente configurable, para que muestres el contenido que te parezca más relevante. Puedes modificarla desde el menú "Contenido del sitio" en el submenú "Homepage". +Al acceder a tu instalación de Consul Democracy los usuarios verán la página principal de la plataforma. Esta página es totalmente configurable, para que muestres el contenido que te parezca más relevante. Puedes modificarla desde el menú "Contenido del sitio" en el submenú "Homepage". Prueba a crear "Encabezados" y "Tarjetas" y a activar las diferentes funcionalidades que encontrarás debajo para ver el efecto que producen en tu página principal. @@ -68,14 +68,14 @@ Prueba a crear "Encabezados" y "Tarjetas" y a activar las diferentes funcionalid Si accedes al menú "Contenido del sitio" y al submenú "Personalizar textos" verás diferentes pestañas con una serie de textos. Estos son todos los textos que se muestran en la plataforma. Por defecto puedes utilizar los que existen, pero en cualquier momento puedes acceder a esta sección para modificar cualquiera de los textos. -Para tener más información sobre cómo añadir nuevas traducciones a tu versión de CONSUL accede a la sección "Textos y traducciones" de esta documentación. +Para tener más información sobre cómo añadir nuevas traducciones a tu versión de Consul Democracy accede a la sección "Textos y traducciones" de esta documentación. ## Canales de participación -Por defecto encontrarás en CONSUL diferentes formas de participación para los usuarios. Para empezar y familiarizarte con la plataforma te recomendamos tenerlos todos activados, pero puedes desactivar todos los que no te parezcan necesarios. Para ello accede al menú "Configuración" y posteriormente al submenú "Configuración global". En la parte superior de esta página encontrarás tres pestañas: "Configuración Global", "Funcionalidades" y "Configuración del Mapa". Accede a la segunda pestaña "Funcionalidades". +Por defecto encontrarás en Consul Democracy diferentes formas de participación para los usuarios. Para empezar y familiarizarte con la plataforma te recomendamos tenerlos todos activados, pero puedes desactivar todos los que no te parezcan necesarios. Para ello accede al menú "Configuración" y posteriormente al submenú "Configuración global". En la parte superior de esta página encontrarás tres pestañas: "Configuración Global", "Funcionalidades" y "Configuración del Mapa". Accede a la segunda pestaña "Funcionalidades". -Encontrarás diversas funcionalidades con los nombres de los diferentes canales de participación "Debates", "Propuestas", "Votaciones", "Legislación Colaborativa" y "Presupuestos Participativos". Puedes desactivar cualquiera de las funcionalidades y dejará de mostrarse en tu instalación de CONSUL. +Encontrarás diversas funcionalidades con los nombres de los diferentes canales de participación "Debates", "Propuestas", "Votaciones", "Legislación Colaborativa" y "Presupuestos Participativos". Puedes desactivar cualquiera de las funcionalidades y dejará de mostrarse en tu instalación de Consul Democracy. ### Más información y documentación detallada -Estas opciones anteriores te permitirán tener una versión básica de CONSUL que empezar a usar. Te recomendamos acceder a la sección [Documentación y guías sobre CONSUL](documentation_and_guides.md) donde podrás encontrar más documentación detallada. +Estas opciones anteriores te permitirán tener una versión básica de Consul Democracy que empezar a usar. Te recomendamos acceder a la sección [Documentación y guías sobre Consul Democracy](documentation_and_guides.md) donde podrás encontrar más documentación detallada. diff --git a/docs/es/installation/create_deploy_user.md b/docs/es/installation/create_deploy_user.md index c72d51b23..5c215667e 100644 --- a/docs/es/installation/create_deploy_user.md +++ b/docs/es/installation/create_deploy_user.md @@ -64,7 +64,7 @@ Compruebe que su usuario puede iniciar sesión escribiendo: Debería ver la página de bienvenida del servidor y un mensaje como este: ``` - jupiter@consulserver:~$ + jupiter@consuldemocracyserver:~$ ``` Note que el nombre de usuario en el prompt no es "root", sino su nombre de usuario. Así que todo está bien y ahora podemos bloquear la cuenta root del acceso externo y también dejar de permitir el acceso con contraseña para que sólo las personas con claves SSH puedan iniciar sesión. diff --git a/docs/es/installation/debian.md b/docs/es/installation/debian.md index 25602c811..6a532b7e0 100644 --- a/docs/es/installation/debian.md +++ b/docs/es/installation/debian.md @@ -39,7 +39,7 @@ apt-get install curl ## Gestor de versiones de Ruby -Las versiones de Ruby empaquetadas en repositorios oficiales no son aptas para trabajar con consul, así que debemos instalar manualmente. +Las versiones de Ruby empaquetadas en repositorios oficiales no son aptas para trabajar con Consul Democracy, así que debemos instalar manualmente. Una opción es utilizar rvm: @@ -113,7 +113,7 @@ apt-get update apt-get install postgresql-9.4 postgresql-server-dev-9.4 postgresql-contrib-9.4 ``` -Para el correcto funcionamiento de CONSUL, necesitas confgurar un usuario para tu base de datos. Como ejemplo, crearemos un usuario llamado "consul": +Para el correcto funcionamiento de Consul Democracy, necesitas confgurar un usuario para tu base de datos. Como ejemplo, crearemos un usuario llamado "consul": ``` su - postgres @@ -158,4 +158,4 @@ También tienes la opción de solo instalar ChromeDriver desde AUR. Si usas `pac pacaur -S chromedriver ``` -Ya estás listo para [instalar Consul](local_installation.md)!! +Ya estás listo para [instalar Consul Democracy](local_installation.md)!! diff --git a/docs/es/installation/deploying-on-heroku.md b/docs/es/installation/deploying-on-heroku.md index 6f839234f..bcff71a7d 100644 --- a/docs/es/installation/deploying-on-heroku.md +++ b/docs/es/installation/deploying-on-heroku.md @@ -2,7 +2,7 @@ ## Instalación manual -Este tutorial asume que ya has conseguido clonar CONSUL en tu máquina y conseguir que funcione. +Este tutorial asume que ya has conseguido clonar Consul Democracy en tu máquina y conseguir que funcione. 1. En primer lugar, necesitas crear una cuenta en [Heroku](https://www.heroku.com) si no lo has hecho ya. 2. Instala [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) e inicia sesión con: @@ -11,7 +11,7 @@ Este tutorial asume que ya has conseguido clonar CONSUL en tu máquina y consegu heroku login ``` -3. Accede a tu repositorio de CONSUL y crea una instancia +3. Accede a tu repositorio de Consul Democracy y crea una instancia ```bash cd consul @@ -28,7 +28,7 @@ Este tutorial asume que ya has conseguido clonar CONSUL en tu máquina y consegu heroku addons:create heroku-postgresql ``` - Ahora deberías tener acceso a una base de datos Postgres vacía cuya dirección se guardó automáticamente como una variable de entorno llamada _DATABASE\_URL_. CONSUL se conectará automáticamente a ella durante la instalación. + Ahora deberías tener acceso a una base de datos Postgres vacía cuya dirección se guardó automáticamente como una variable de entorno llamada _DATABASE\_URL_. Consul Democracy se conectará automáticamente a ella durante la instalación. 5. **(No es necesario)** Crea un archivo con el nombre _heroku.yml_ en la raíz del proyecto y añade el siguiente código @@ -131,7 +131,7 @@ Importante: Activa un "worker dyno" para que se envíen los correos electrónico ### Instalar rails\_12factor y especificar la versión de Ruby -**Instalar rails\_12factor sólo es útil si utilizas una versión de CONSUL anterior a la 1.0.0. La última versión utiliza Rails 5 que ya incluye los cambios.** +**Instalar rails\_12factor sólo es útil si utilizas una versión de Consul Democracy anterior a la 1.0.0. La última versión utiliza Rails 5 que ya incluye los cambios.** Como nos recomienda Heroku, puedes añadir la gema rails\_12factor y especificar la versión de Ruby a utilizar. Puedes hacerlo añadiendo: @@ -141,7 +141,7 @@ gem 'rails_12factor' ruby 'x.y.z' ``` -en el archivo _Gemfile\_custom_, donde `x.y.z` es la versión definida en el fichero `.ruby-version` del repositorio de CONSUL. No olvides ejecutar +en el archivo _Gemfile\_custom_, donde `x.y.z` es la versión definida en el fichero `.ruby-version` del repositorio de Consul Democracy. No olvides ejecutar ```bash bundle install @@ -169,7 +169,7 @@ web: bundle exec puma -C config/puma.rb ### Añadir variables de configuración desde el panel de control -Las versiones gratuita y hobby de Heroku no son suficientes para ejecutar una aplicación como CONSUL. Para optimizar el tiempo de respuesta y asegurarte de que la aplicación no se quede sin memoria, puedes [cambiar el número de "workers" e hilos](https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server#workers) que utiliza Puma. +Las versiones gratuita y hobby de Heroku no son suficientes para ejecutar una aplicación como Consul Democracy. Para optimizar el tiempo de respuesta y asegurarte de que la aplicación no se quede sin memoria, puedes [cambiar el número de "workers" e hilos](https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server#workers) que utiliza Puma. La configuración recomendada es un "worker" y tres hilos. Puedes configurarlo ejecutando estos dos comandos: diff --git a/docs/es/installation/digital_ocean.md b/docs/es/installation/digital_ocean.md index 3f6b72f4c..58afcd785 100644 --- a/docs/es/installation/digital_ocean.md +++ b/docs/es/installation/digital_ocean.md @@ -1,6 +1,6 @@ -# Instalando CONSUL en un VPS de Digital Ocean +# Instalando Consul Democracy en un VPS de Digital Ocean -Estas instrucciones le ayudaran a registrarse y comprar un servidor en Digital Ocean para instalar CONSUL. +Estas instrucciones le ayudaran a registrarse y comprar un servidor en Digital Ocean para instalar Consul Democracy. Primero necesita [registrarse](https://cloud.digitalocean.com/registrations/new) y proporcionar su información personal. @@ -40,11 +40,11 @@ Seleccione y copie todo el texto y péguelo en la ventana emergente de la siguie ![Digital Ocean New SSH Key](../../img/digital_ocean/new_ssh.png) -Tenga en cuenta que habrá dos pequeños checks verdes. Si no están ahí, vuelva a intentar copiar el texto porque probablemente omitió algo. Dé a su clave un nombre significativo, como **CONSUL_key** y haga clic en el botón "Add SSH Key" (Añadir clave SSH). +Tenga en cuenta que habrá dos pequeños checks verdes. Si no están ahí, vuelva a intentar copiar el texto porque probablemente omitió algo. Dé a su clave un nombre significativo, como **Consul_Democracy_key** y haga clic en el botón "Add SSH Key" (Añadir clave SSH). Al utilizar una clave SSH en lugar de una combinación de usuario/contraseña para acceder a su servidor, será mucho más seguro, ya que sólo alguien con la clave privada SSH puede acceder al servidor. -Ahora en la sección "Choose a hostname" cambie el valor por defecto por algo más significativo, como **consulserver** por ejemplo. +Ahora en la sección "Choose a hostname" cambie el valor por defecto por algo más significativo, como **consuldemocracyserver** por ejemplo. ![Digital Ocean hostname](../../img/digital_ocean/hostname.png) @@ -56,4 +56,4 @@ Tardará unos minutos, y al final tendrá un brillante nuevo servidor. Se verá ![Digital Ocean server](../../img/digital_ocean/server.png) -Lo siguiente es configurar CONSUL en el servidor. Por favor [leer estas instrucciones](https://github.com/consul/installer) +Lo siguiente es configurar Consul Democracy en el servidor. Por favor [leer estas instrucciones](https://github.com/consul/installer) diff --git a/docs/es/installation/docker.md b/docs/es/installation/docker.md index 477bebaca..5430e48f2 100644 --- a/docs/es/installation/docker.md +++ b/docs/es/installation/docker.md @@ -1,6 +1,6 @@ # Usando Docker para desarrollo en local -Puedes usar Docker para tener una instalación local de CONSUL si: +Puedes usar Docker para tener una instalación local de Consul Democracy si: - Estás teniendo problemas para instalar los [prerrequisitos](prerequisites.md) correctamente. - Quieres tener una instalación local rápidamente para probar o hacer una demo. @@ -100,7 +100,7 @@ POSTGRES_PASSWORD=password docker-compose run app rake db:dev_seed Pendiente de ser completado... ¡Se agradecen las Contribuciones! -## Corriendo CONSUL en local con Docker +## Corriendo Consul Democracy en local con Docker ### macOS & Linux @@ -133,15 +133,15 @@ Pendiente de ser completado... ¡Se agradecen las Contribuciones! ## ¿Tienes problemas? -Ejecute los comandos en el **directorio de CONSUL**, para borrar todas las imágenes y contenedores anteriores del Docker de CONSUL. Luego, reinicie el [proceso de instalación](#instalacion) de Docker: +Ejecute los comandos en el **directorio de Consul Democracy**, para borrar todas las imágenes y contenedores anteriores del Docker de Consul Democracy. Luego, reinicie el [proceso de instalación](#instalacion) de Docker: -1. Quitar todas las imágenes de CONSUL: +1. Quitar todas las imágenes de Consul Democracy: ```bash docker-compose down --rmi all -v --remove-orphans ``` -2. Quitar todos los contenedores de CONSUL +2. Quitar todos los contenedores de Consul Democracy ```bash docker-compose rm -f -s -v diff --git a/docs/es/installation/documentation_and_guides.md b/docs/es/installation/documentation_and_guides.md index d5628e022..ff6e3af8f 100644 --- a/docs/es/installation/documentation_and_guides.md +++ b/docs/es/installation/documentation_and_guides.md @@ -1,9 +1,9 @@ -# Documentación y guías sonbre CONSUL +# Documentación y guías sonbre Consul Democracy -Hay diversas guías donde puedes leer información muy detallada sobre CONSUL y sus posibilidades. Puedes encontrarlas todas en: +Hay diversas guías donde puedes leer información muy detallada sobre Consul Democracy y sus posibilidades. Puedes encontrarlas todas en: -- **Guía de uso de CONSUL**. En esta guía puedes ver las diferentes maneras de usar CONSUL y ejemplos de procesos de participación. -- **Guía de administración de CONSUL**. Esta guía contiene información detallada sobre la administración y gestión de CONSUL. -- **Guía de comunicación de CONSUL**. Esta guía te puede ofrecer una idea inicial de cómo planear campañas de comunicación para invitar a la gente a usar tu instalación de CONSUL. La comunicación es una cuestión clave a la hora de conseguir una participación relevante. +- **Guía de uso de Consul Democracy**. En esta guía puedes ver las diferentes maneras de usar Consul Democracy y ejemplos de procesos de participación. +- **Guía de administración de Consul Democracy**. Esta guía contiene información detallada sobre la administración y gestión de Consul Democracy. +- **Guía de comunicación de Consul Democracy**. Esta guía te puede ofrecer una idea inicial de cómo planear campañas de comunicación para invitar a la gente a usar tu instalación de Consul Democracy. La comunicación es una cuestión clave a la hora de conseguir una participación relevante. -Además de estas guías puedes acceder a la [Comunidad CONSUL](http://community.CONSULproject.org/), un espacio de debate para compartir más documentación, dudas, aprendizajes, etc. +Además de estas guías puedes acceder a la [Comunidad Consul Democracy](http://community.consulproject.org/), un espacio de debate para compartir más documentación, dudas, aprendizajes, etc. diff --git a/docs/es/installation/introduction.md b/docs/es/installation/introduction.md index 4c44fef6f..6b18a84e4 100644 --- a/docs/es/installation/introduction.md +++ b/docs/es/installation/introduction.md @@ -2,10 +2,10 @@ Estas son nuestras recomendaciones para los diferentes entornos y propósitos: -- Para configurar CONSUL para un entorno de producción, recomendamos utilizar el [instalador](https://github.com/consul/installer). +- Para configurar Consul Democracy para un entorno de producción, recomendamos utilizar el [instalador](https://github.com/consul/installer). -- Para los programadores que trabajan en un entorno de desarrollo, recomendamos instalar CONSUL en un sistema basado en UNIX (Linux o Mac) y hacer una [instalación local](local_installation.md) de CONSUL. +- Para los programadores que trabajan en un entorno de desarrollo, recomendamos instalar Consul Democracy en un sistema basado en UNIX (Linux o Mac) y hacer una [instalación local](local_installation.md) de Consul Democracy. -- Si tienes problemas para hacer una instalación local y deseas mostrar CONSUL para fines de demostración, te recomendamos que utilices [Docker](docker.md) en tu ordenador personal. +- Si tienes problemas para hacer una instalación local y deseas mostrar Consul Democracy para fines de demostración, te recomendamos que utilices [Docker](docker.md) en tu ordenador personal. - También tenemos una [Guía Heroku](deploying-on-heroku.md) que se puede utilizar para fines de demostración en un servidor remoto. diff --git a/docs/es/installation/local_installation.md b/docs/es/installation/local_installation.md index 3b16c1788..6e6e91f4e 100644 --- a/docs/es/installation/local_installation.md +++ b/docs/es/installation/local_installation.md @@ -1,8 +1,8 @@ # Instalación local -Antes de comenzar a instalar Consul, comprueba que tengas todos los [prerrequisitos](prerequisites.md) correctamente instalados. +Antes de comenzar a instalar Consul Democracy, comprueba que tengas todos los [prerrequisitos](prerequisites.md) correctamente instalados. -1. Primero, clona el [repositorio de Consul en Github](https://github.com/consul/consul/) y ve a la carpeta del proyecto: +1. Primero, clona el [repositorio de Consul Democracy en Github](https://github.com/consul/consul/) y ve a la carpeta del proyecto: ```bash git clone https://github.com/consul/consul.git @@ -66,7 +66,7 @@ bin/rspec bin/rails s ``` -¡Felicidades! Tu aplicación Consul local estará corriendo en `http://localhost:3000`. +¡Felicidades! Tu aplicación Consul Democracy local estará corriendo en `http://localhost:3000`. En caso de que quieras acceder a la aplicación local como usuario administrador existe un usuario por defecto verificado y con permisos con **nombre de usuario** `admin@consul.dev` y **contraseña** `12345678`. diff --git a/docs/es/installation/macos.md b/docs/es/installation/macos.md index c20abe8c7..8b1428936 100644 --- a/docs/es/installation/macos.md +++ b/docs/es/installation/macos.md @@ -106,4 +106,4 @@ brew install chromedriver brew install imagemagick ``` -Ahora que ya tenemos todas las dependencias instalado podemos proceder con la [instalación de Consul](local_installation.md) +Ahora que ya tenemos todas las dependencias instalado podemos proceder con la [instalación de Consul Democracy](local_installation.md) diff --git a/docs/es/installation/mail_server_configuration.md b/docs/es/installation/mail_server_configuration.md index a42ca859c..48c806d75 100644 --- a/docs/es/installation/mail_server_configuration.md +++ b/docs/es/installation/mail_server_configuration.md @@ -1,6 +1,6 @@ # Configuración del servidor de correo -Este es un ejemplo de cómo integrar un servicio de correo con Consul. +Este es un ejemplo de cómo integrar un servicio de correo con Consul Democracy. En este ejemplo usamos [Mailgun](https://www.mailgun.com/). @@ -17,7 +17,7 @@ En este ejemplo usamos [Mailgun](https://www.mailgun.com/). * Como todavía no tienes un dominio, debes pinchar en el "sandbox" que ya está creado * Recuerda las siguientes credenciales: ![Mailgun sandbox](../../img/mailserver/mailgun-sandbox.png) -## Configuración del correo en Consul +## Configuración del correo en Consul Democracy * Ve al archivo `config/secrets.yml` * Modifica las líneas en el archivo para configurar el servidor de correo: @@ -35,4 +35,4 @@ En este ejemplo usamos [Mailgun](https://www.mailgun.com/). ``` * Rellena ``, ``, `` y `` con tu información. -* Guarda el fichero y reinicia tu aplicación Consul +* Guarda el fichero y reinicia tu aplicación Consul Democracy diff --git a/docs/es/installation/manual_installation_production.md b/docs/es/installation/manual_installation_production.md index 5eb50a40c..86f57571e 100644 --- a/docs/es/installation/manual_installation_production.md +++ b/docs/es/installation/manual_installation_production.md @@ -20,7 +20,7 @@ mkdir -p shared/public/assets shared/public/system shared/public/ckeditor_assets ## Versión inicial -Crea una primera carpeta en "releases" a partir del repositorio, junto con un enlace simbólico a la versión actual (sustituye `` por el número de la última versión estable de CONSUL, como 1.3.1 o 1.4.1): +Crea una primera carpeta en "releases" a partir del repositorio, junto con un enlace simbólico a la versión actual (sustituye `` por el número de la última versión estable de Consul Democracy, como 1.3.1 o 1.4.1): ``` cd repo @@ -31,7 +31,7 @@ ln -s releases/first current ## Instalación de gemas -Instala las gemas de las que depende CONSUL: +Instala las gemas de las que depende Consul Democracy: ``` cd releases/first diff --git a/docs/es/installation/ubuntu.md b/docs/es/installation/ubuntu.md index 00b148367..4c7946a7f 100644 --- a/docs/es/installation/ubuntu.md +++ b/docs/es/installation/ubuntu.md @@ -18,7 +18,7 @@ sudo apt install git ## Gestor de versiones de Ruby -Las versiones de Ruby empaquetadas en repositorios oficiales no son aptas para trabajar con CONSUL, así que debemos instalarlo manualmente. +Las versiones de Ruby empaquetadas en repositorios oficiales no son aptas para trabajar con Consul Democracy, así que debemos instalarlo manualmente. En primer lugar, necesitamos los siguiente paquetes para poder instalar Ruby: @@ -53,7 +53,7 @@ Instala postgresql y sus dependencias de desarrollo con: sudo apt install postgresql libpq-dev ``` -Para el correcto funcionamiento de CONSUL, necesitas confgurar un usuario para tu base de datos. Como ejemplo, crearemos un usuario llamado "consul": +Para el correcto funcionamiento de Consul Democracy, necesitas confgurar un usuario para tu base de datos. Como ejemplo, crearemos un usuario llamado "consul": ```bash sudo -u postgres createuser consul --createdb --superuser --pwprompt @@ -108,4 +108,4 @@ sudo apt install chromium-chromedriver sudo ln -s /usr/lib/chromium-browser/chromedriver /usr/local/bin/ ``` -¡Ya estás listo para [instalar CONSUL](local_installation.md)! +¡Ya estás listo para [instalar Consul Democracy](local_installation.md)! diff --git a/docs/es/open_source/contributing.md b/docs/es/open_source/contributing.md index a298655d1..c714b4793 100644 --- a/docs/es/open_source/contributing.md +++ b/docs/es/open_source/contributing.md @@ -1,10 +1,10 @@ # Contribuciones -Te agradecemos que quieras colaborar contribuyendo a Consul. Aquí tienes una guía donde consultar cómo sugerir cambios y mejoras al proyecto. +Te agradecemos que quieras colaborar contribuyendo a Consul Democracy. Aquí tienes una guía donde consultar cómo sugerir cambios y mejoras al proyecto. ## Reportar un issue -Si has visto algún error en la plataforma o directamente en el código, te animamos a [abrir un issue en el repositorio en Github de Consul](https://github.com/consul/consul/issues/new). +Si has visto algún error en la plataforma o directamente en el código, te animamos a [abrir un issue en el repositorio en Github de Consul Democracy](https://github.com/consul/consul/issues/new). Antes de hacerlo, **por favor tómate un tiempo para comprobar los [issues ya existentes](https://github.com/consul/consul/issues) y asegúrate de que lo que estás a punto de reportar no ha sido reportado previamente** por otra persona. De ser así, si tienes más detalles acerca de la incidencia puedes escribir un comentario en la página del issue ‑¡un poco de ayuda puede marcar una gran diferencia! @@ -16,7 +16,7 @@ Para escribir un nuevo issue, ten en cuenta estas recomendaciones para hacerlo m ## Resolver un issue -[Los issues en Consul](https://github.com/consul/consul/issues) con la etiqueta `PRs-welcome` son funcionalidades bien definidas que están listas para ser implementadas por cualquiera que se ofrezca a ello. Por otra parte, la etiqueta `not-ready` indica las funcionalidades o cambios que aún están pendientes de concretar, por lo que recomendamos no intentar resolverlos hasta que los/as administradores/as lleguen a una resolución. +[Los issues en Consul Democracy](https://github.com/consul/consul/issues) con la etiqueta `PRs-welcome` son funcionalidades bien definidas que están listas para ser implementadas por cualquiera que se ofrezca a ello. Por otra parte, la etiqueta `not-ready` indica las funcionalidades o cambios que aún están pendientes de concretar, por lo que recomendamos no intentar resolverlos hasta que los/as administradores/as lleguen a una resolución. Te sugerimos seguir los siguientes pasos para facilitar el seguimiento de los cambios que vayas a hacer: @@ -25,15 +25,15 @@ Te sugerimos seguir los siguientes pasos para facilitar el seguimiento de los ca - Crea una rama de funcionalidad basada en la rama `master`. Para identificarla más fácilmente, puedes nombrarla con el número del issue seguido de un nombre conciso y descriptivo (por ejemplo: `123-fix_proposals_link`). - Desarrolla los cambios haciendo commits en tu nueva rama. - Asegúrate de que todos los tests pasan. Si estás extendiendo una funcionalidad o creando una nueva, considera añadir sus propios tests. -- Cuando hayas terminado, envía un **pull request** al [repositorio de Consul](https://github.com/consul/consul/) describiendo la solución que propones para ayudarnos a entenderlo. También es importante que especifiques qué issue estás resolviendo al principio de la descripción del PR (por ejemplo, `Fixes #123`). -- El equipo de Consul revisará tu PR y podrá sugerir cambios si son necesarios. Una vez esté todo bien, tus cambios serán introducidos en el proyecto :) +- Cuando hayas terminado, envía un **pull request** al [repositorio de Consul Democracy](https://github.com/consul/consul/) describiendo la solución que propones para ayudarnos a entenderlo. También es importante que especifiques qué issue estás resolviendo al principio de la descripción del PR (por ejemplo, `Fixes #123`). +- El equipo de Consul Democracy revisará tu PR y podrá sugerir cambios si son necesarios. Una vez esté todo bien, tus cambios serán introducidos en el proyecto :) > **¿Es tu primer Pull Request?** Puedes aprender cómo contribuir a un proyecto en Github siguiendo los tutoriales [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) (en inglés). ## Otras formas de contribuir -Agradecemos cualquier tipo de contribución a Consul. Incluso si no puedes contribuir al código del proyecto, puedes: +Agradecemos cualquier tipo de contribución a Consul Democracy. Incluso si no puedes contribuir al código del proyecto, puedes: - Crear issues sobre cualquier problema o error que hayas encontrado. -- Ayudar a traducir la plataforma a otros idiomas que domines en el proyecto de [Consul en Crowdin](https://crwd.in/consul). -- Ayudar con la [documentación de Consul](https://github.com/consul/docs). +- Ayudar a traducir la plataforma a otros idiomas que domines en el proyecto de [Consul Democracy en Crowdin](https://crwd.in/consul). +- Ayudar con la [documentación de Consul Democracy](https://github.com/consul/docs).