diff --git a/docs/README.md b/docs/README.md index 64699d05e..8a11b3a5b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -17,11 +17,11 @@ Citizen Participation and Open Government Application [![Join the chat at https://gitter.im/consul/consul](https://badges.gitter.im/consul/consul.svg)](https://gitter.im/consul/consul?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/consul/consul/issues?q=is%3Aissue+is%3Aopen+label%3APRs-welcome) -This is the opensource code repository of the eParticipation website CONSUL, originally developed for the Madrid City government eParticipation website +This is the opensource code repository of the eParticipation website CONSUL, originally developed for the Madrid City government eParticipation website. ## Current state -Development started on [2015 July 15th](https://github.com/consul/consul/commit/8db36308379accd44b5de4f680a54c41a0cc6fc6). Code was deployed to production on 2015 september 7th to [decide.madrid.es](https://decide.madrid.es). Since then new features are added often. You can take a look at the current features in [features]( http://www.decide.es/en/) or [docs](https://github.com/consul/consul/tree/master/doc) and future features in the [open issues list](https://github.com/consul/consul/issues). For current status on upcoming features go to [Roadmap](https://github.com/consul/consul/projects/6) +Development started on [2015 July 15th](https://github.com/consul/consul/commit/8db36308379accd44b5de4f680a54c41a0cc6fc6). Code was deployed to production on 2015 September 7th to [decide.madrid.es](https://decide.madrid.es). Since then new features are added often. You can take a look at the current features in [features]( http://www.decide.es/en/) or [docs](https://github.com/consul/consul/tree/master/doc) and future features in the [open issues list](https://github.com/consul/consul/issues). For current status on upcoming features go to [Roadmap](https://github.com/consul/consul/projects/6). ## Configuration for development and test environments @@ -67,12 +67,12 @@ But for some actions like voting, you will need a verified user, the seeds file ## Documentation -You can find this project documentation at https://github.com/consul/docs +You can find this project documentation at https://github.com/consul/docs. ## License -Code published under AFFERO GPL v3 (see [LICENSE-AGPLv3.txt](LICENSE-AGPLv3.txt)) +Code published under AFFERO GPL v3 (see [LICENSE-AGPLv3.txt](LICENSE-AGPLv3.txt)). ## Contributions -See [CONTRIBUTING.md](https://github.com/consul/consul/blob/master/CONTRIBUTING.md) +See [CONTRIBUTING.md](https://github.com/consul/consul/blob/master/CONTRIBUTING.md). diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 7349ac542..fb7f4c346 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -37,7 +37,7 @@ * [Models](en/customization/models.md) * [Components](en/customization/components.md) * [Gems](en/customization/gems.md) - * [Overwritting Application](en/customization/overwritting.md) + * [Overwriting Application](en/customization/overwriting.md) * [Technical Features](en/features/features.md) * [OAuth](en/features/oauth.md) @@ -89,7 +89,7 @@ * [Modelos](es/customization/models.md) * [Componentes](es/customization/components.md) * [Gemas](es/customization/gems.md) - * [Adaptar la aplicación](es/customization/overwritting.md) + * [Adaptar la aplicación](es/customization/overwriting.md) * [Funcionalidades Técnicas](es/features/features.md) * [OAuth](es/features/oauth.md) diff --git a/docs/en/README.md b/docs/en/README.md index 759f78f86..3adc60370 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -17,11 +17,11 @@ Citizen Participation and Open Government Application [![Join the chat at https://gitter.im/consul/consul](https://badges.gitter.im/consul/consul.svg)](https://gitter.im/consul/consul?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/consul/consul/issues?q=is%3Aissue+is%3Aopen+label%3APRs-welcome) -This is the opensource code repository of the eParticipation website CONSUL, originally developed for the Madrid City government eParticipation website +This is the opensource code repository of the eParticipation website CONSUL, originally developed for the Madrid City government eParticipation website. ## Current state -Development started on [2015 July 15th](https://github.com/consul/consul/commit/8db36308379accd44b5de4f680a54c41a0cc6fc6). Code was deployed to production on 2015 september 7th to [decide.madrid.es](https://decide.madrid.es). Since then new features are added often. You can take a look at the current features in [features]( http://www.decide.es/en/) or [docs](https://github.com/consul/consul/tree/master/doc) and future features in the [open issues list](https://github.com/consul/consul/issues). For current status on upcoming features go to [Roadmap](https://github.com/consul/consul/projects/6) +Development started on [2015 July 15th](https://github.com/consul/consul/commit/8db36308379accd44b5de4f680a54c41a0cc6fc6). Code was deployed to production on 2015 September 7th to [decide.madrid.es](https://decide.madrid.es). Since then new features are added often. You can take a look at the current features in [features]( http://www.decide.es/en/) or [docs](https://github.com/consul/consul/tree/master/doc) and future features in the [open issues list](https://github.com/consul/consul/issues). For current status on upcoming features go to [Roadmap](https://github.com/consul/consul/projects/6). ## Configuration for development and test environments @@ -67,12 +67,12 @@ But for some actions like voting, you will need a verified user, the seeds file ## Documentation -You can find this project documentation at https://github.com/consul/docs +You can find this project documentation at https://github.com/consul/docs. ## License -Code published under AFFERO GPL v3 (see [LICENSE-AGPLv3.txt](open_source/license.md)) +Code published under AFFERO GPL v3 (see [LICENSE-AGPLv3.txt](open_source/license.md)). ## Contributions -See [CONTRIBUTING.md](https://github.com/consul/consul/blob/master/CONTRIBUTING.md) +See [CONTRIBUTING.md](https://github.com/consul/consul/blob/master/CONTRIBUTING.md). diff --git a/docs/en/customization/customization.md b/docs/en/customization/customization.md index 75cfaa9a0..06b5984b7 100644 --- a/docs/en/customization/customization.md +++ b/docs/en/customization/customization.md @@ -8,4 +8,4 @@ * [Models](models.md) * [Components](components.md) * [Gems](gems.md) -* [Overwritting Application](overwritting.md) +* [Overwriting Application](overwriting.md) diff --git a/docs/en/customization/images.md b/docs/en/customization/images.md index 30f6e6adb..b3b297edc 100644 --- a/docs/en/customization/images.md +++ b/docs/en/customization/images.md @@ -1,6 +1,6 @@ # Images -If you want to overwrite any image, firstly you need to findout the filename, and by defaul it will be located under `app/assets/images`. For example if you want to change the header logo (`app/assets/images/logo_header.png`) you must create another file with the exact same file name under `app/assets/images/custom` folder. The images and icons that you will most likely want to change are: +If you want to overwrite any image, firstly you need to find out the filename, and by default it will be located under `app/assets/images`. For example if you want to change the header logo (`app/assets/images/logo_header.png`) you must create another file with the exact same file name under `app/assets/images/custom` folder. The images and icons that you will most likely want to change are: * apple-touch-icon-200.png * icon_home.png @@ -14,4 +14,4 @@ If you want to overwrite any image, firstly you need to findout the filename, an You'll find the city map at [`/app/assets/images/map.jpg`](https://github.com/consul/consul/blob/master/app/assets/images/map.jpg), just replace it with an image of your cities districts ([example](https://github.com/ayuntamientomadrid/consul/blob/master/app/assets/images/map.jpg)). -Afterwards we recommend you to use an online tool like http://imagemap-generator.dariodomi.de/ or https://www.image-map.net/ to generate the html coordinates to be able to generate a [image-map](https://www.w3schools.com/tags/tag_map.asp) for each of the districts. Those coordinates should be introduced on the respective Geozones at the admin geozones panel (`/admin/geozones`) +Afterwards we recommend you to use an online tool like http://imagemap-generator.dariodomi.de/ or https://www.image-map.net/ to generate the html coordinates to be able to generate a [image-map](https://www.w3schools.com/tags/tag_map.asp) for each of the districts. Those coordinates should be introduced on the respective Geozones at the admin geozones panel (`/admin/geozones`). diff --git a/docs/en/customization/introduction.md b/docs/en/customization/introduction.md index a8652caef..0548058a0 100644 --- a/docs/en/customization/introduction.md +++ b/docs/en/customization/introduction.md @@ -129,15 +129,15 @@ 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: -![Active interface translations](../../img/translations/interface_translations/active-interface-translations-en.png) +![Active interface translations](../../img/translations/interface_translations/active-interface-translations-en.png). #### Use Cases * When the translation interface is active: -As you can see in the image below translation interface has two selectors, the firt one "Select language" is to switch between enabled languages and the second one "Add language" is to add new languages to the form. Translatable fields appears with a blue background to facilitate users to distinguish between translatable and not translatable fields. Additionally interface provides a link `Remove language` to delete the current language shown at "Select language". If a user accidentally removes a translation he can recover it re-adding it to the form. +As you can see in the image below translation interface has two selectors, the first one "Select language" is to switch between enabled languages and the second one "Add language" is to add new languages to the form. Translatable fields appears with a blue background to facilitate users to distinguish between translatable and not translatable fields. Additionally interface provides a link `Remove language` to delete the current language shown at "Select language". If a user accidentally removes a translation he can recover it re-adding it to the form. This feature is visible during creation and edition of translatable resources. -![Translations inteface enabled](../../img/translations/interface_translations/translations-interface-enabled-en.png) +![Translations interface enabled](../../img/translations/interface_translations/translations-interface-enabled-en.png) * When the translation interface is disabled: When this feature is deactivated users will see standard forms without translation interface and without translation highlight. -![Translations inteface enabled](../../img/translations/interface_translations/translations-interface-disabled-en.png) +![Translations interface enabled](../../img/translations/interface_translations/translations-interface-disabled-en.png) diff --git a/docs/en/customization/overwritting.md b/docs/en/customization/overwriting.md similarity index 76% rename from docs/en/customization/overwritting.md rename to docs/en/customization/overwriting.md index 586fc30c3..3eaaca7bb 100644 --- a/docs/en/customization/overwritting.md +++ b/docs/en/customization/overwriting.md @@ -1,4 +1,4 @@ -# Overwritting application.rb +# Overwriting application.rb If you need to extend or modify the `config/application.rb` just do it at the `config/application_custom.rb` file. For example if you want to change de default language to English, just add: @@ -11,4 +11,4 @@ module Consul end ``` -Remeber that in order to see this changes live you'll need to restart the server. +Remember that in order to see this changes live you'll need to restart the server. diff --git a/docs/en/customization/views_and_styles.md b/docs/en/customization/views_and_styles.md index 911bbf088..6c7b7b5a2 100644 --- a/docs/en/customization/views_and_styles.md +++ b/docs/en/customization/views_and_styles.md @@ -26,6 +26,6 @@ Also you can check your scss files syntax with scss-lint ``` -## Accesibility +## Accessibility -To maintain accesibility level, if you add new colors use a [Color contrast checker](http://webaim.org/resources/contrastchecker/) (WCAG AA is mandatory, WCAG AAA is recommended) +To maintain accessibility level, if you add new colors use a [Color contrast checker](http://webaim.org/resources/contrastchecker/) (WCAG AA is mandatory, WCAG AAA is recommended) diff --git a/docs/en/features/globalize.md b/docs/en/features/globalize.md index 0c3bdce73..73ed06d30 100644 --- a/docs/en/features/globalize.md +++ b/docs/en/features/globalize.md @@ -77,7 +77,7 @@ params.require(:post).permit(*attributes, translation_params(params[:post])) Add the fields to the form for creating and editing the translations. Remember that, to do this, there is a function in the helper that encapsules the `Globalize.with_locale` logic in a block called `globalize(locale) do`. -The fields that are going to be translated should be named `_`, for example `title_en`, so when that information arrives to the server, it can clasify the parameters. +The fields that are going to be translated should be named `_`, for example `title_en`, so when that information arrives to the server, it can classify the parameters. Remember that, to avoid errors when using locales like `pt-BR`, `es-ES`, etc. (those whose region is specified by a '-'), we must use a function called `neutral_locale(locale)`, defined in the `GlobalizeHelper`. This function converts this type of locales in lower case and underscored, so `pt-BR` will transform in `pt_br`. This format is compatible with `globalize_accessors`, whereas the official is not because the method names like `title_pt-BR` are not allowed. When using this function, the method will call `title_pt_br` and it will not generate conflicts when comparing `pt-BR` with `pt_br`. diff --git a/docs/en/features/graphql.md b/docs/en/features/graphql.md index 3af124cbc..ea509921a 100644 --- a/docs/en/features/graphql.md +++ b/docs/en/features/graphql.md @@ -1,22 +1,23 @@ # API Documentation -* [Characteristics](#characteristics) -* [GraphQL](#graphql) -* [Making API requests](#making-api-requests) - * [Supported clients](#supported-clients) - * [GraphiQL](#graphiql) - * [Postman](#postman) - * [HTTP libraries](#http-libraries) -* [Available information](#available-information) -* [Examples of queries](#examples-of-queries) - * [Request a single record from a collection](#request-a-single-record-from-a-collection) - * [Request a complete collection](#request-a-complete-collection) - * [Pagination](#pagination) - * [Accessing several resources in a single request](#accessing-several-resources-in-a-single-request) -* [Security limitations](#security-limitations) - * [Example of too deep query](#example-of-too-deep-query) - * [Example of too complex query](#example-of-too-complex-query) -* [Code examples](#code-examples) +- [API Documentation](#api-documentation) + - [Characteristics](#characteristics) + - [GraphQL](#graphql) + - [Making API requests](#making-api-requests) + - [Supported clients](#supported-clients) + - [GraphiQL](#graphiql) + - [Postman](#postman) + - [HTTP libraries](#http-libraries) + - [Available information:](#available-information) + - [Examples of queries](#examples-of-queries) + - [Request a single record from a collection](#request-a-single-record-from-a-collection) + - [Request a complete collection](#request-a-complete-collection) + - [Pagination](#pagination) + - [Accessing several resources in a single request](#accessing-several-resources-in-a-single-request) + - [Security limitations](#security-limitations) + - [Example of too deep query](#example-of-too-deep-query) + - [Example of too complex query](#example-of-too-complex-query) + - [Code examples](#code-examples) ## Characteristics @@ -34,7 +35,7 @@ The CONSUL API uses GraphQL [http://graphql.org](http://graphql.org), the [Ruby 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. -GraphQL queries are written following a standard which ressembles to JSON, for example: +GraphQL queries are written following a standard which resembles to JSON, for example: ``` { diff --git a/docs/en/features/local_census.md b/docs/en/features/local_census.md index 1513c771f..bcd7bc39a 100644 --- a/docs/en/features/local_census.md +++ b/docs/en/features/local_census.md @@ -2,7 +2,7 @@ To provide to administrator users a way to manage the local census database through the administration panel **Settings > Manage local census**. Currently the only way to manipulate this table records is through the rails console. -Allow adiministrators users to manage this table in two different ways: +Allow administrators users to manage this table in two different ways: - **Manually**: one by one through a CRUD interface. - **Automatically**: through an importation process. diff --git a/docs/en/getting_started/communication.md b/docs/en/getting_started/communication.md index 24d9a49da..26f6c91ce 100644 --- a/docs/en/getting_started/communication.md +++ b/docs/en/getting_started/communication.md @@ -1,8 +1,8 @@ # Communication -The prefered way to report any missing piece of information is [opening an issue in the project's Github repo](https://github.com/consul/docs/issues/new). +The preferred way to report any missing piece of information is [opening an issue in the project's Github repo](https://github.com/consul/docs/issues/new). -For more informal communication, chat with us at [consul's gitter](https://gitter.im/consul/consul) +For more informal communication, chat with us at [consul's gitter](https://gitter.im/consul/consul). Before doing it, **please take some time to check the [existing issues](https://github.com/consul/consul/issues) and make sure what you are about to report isn't already reported** by another person. In case someone else reported the same problem before or a similar one, and you have more details about it, you can write a comment in the issue page... a little more help can make a huge difference! diff --git a/docs/en/getting_started/configuration.md b/docs/en/getting_started/configuration.md index e52634507..585919b38 100644 --- a/docs/en/getting_started/configuration.md +++ b/docs/en/getting_started/configuration.md @@ -2,11 +2,11 @@ ## Travis CI -[Travis](https://travis-ci.org/) is a Continuous Integration service, free for OpenSource projects (like Consul and it's forks). It will help you check on each Pull Request if the test suite is allright. +[Travis](https://travis-ci.org/) is a Continuous Integration service, free for OpenSource projects (like Consul and it's forks). It will help you check on each Pull Request if the test suite is alright. 1. Visit https://github.com/marketplace/travis-ci and click the "**Install it for free**" green button at the bottom of the page. -2. Click on the "**Complete order and begin installation**" green button +2. Click on the "**Complete order and begin installation**" green button. 3. If you are asked to Authorize Travis CI to access your Github account, check the organization or user where you have your consul fork at the bottom and click the "**Authorize travis-ci**" button. diff --git a/docs/en/getting_started/create.md b/docs/en/getting_started/create.md index b875e5f0a..a36d6f1e8 100644 --- a/docs/en/getting_started/create.md +++ b/docs/en/getting_started/create.md @@ -2,15 +2,15 @@ Consul git repo is hosted at Github.com, we recommend using it for your fork's repo to make things easier. But you can use any other service like Bitbucket or Gitlab if you want to, just don't forget to put a reference link back to CONSUL on the footer to comply with project's license (GPL Affero 3). -1. [Register an user account on Github](https://github.com/join) if you don't have one +1. [Register an user account on Github](https://github.com/join) if you don't have one. -2. [Create an Organization](https://help.github.com/articles/creating-a-new-organization-from-scratch/) on Github with the name of your city or the organization that's going to use Consul. **This is not mandatory**, but it will help undertand the fork's purpose and future contributions by other users. +2. [Create an Organization](https://help.github.com/articles/creating-a-new-organization-from-scratch/) on Github with the name of your city or the organization that's going to use Consul. **This is not mandatory**, but it will help underhand the fork's purpose and future contributions by other users. -3. [Fork Consul](https://help.github.com/articles/fork-a-repo/) using the **fork** button on the top right corner at https://github.com/consul/consul +3. [Fork Consul](https://help.github.com/articles/fork-a-repo/) using the **fork** button on the top right corner at https://github.com/consul/consul. -4. [Clone your fork repository](https://help.github.com/articles/cloning-a-repository/) on to your computer +4. [Clone your fork repository](https://help.github.com/articles/cloning-a-repository/) on to your computer. -****IMPORTANT NOTICE**: Do not fork `https://github.com/AyuntamientoMadrid/consul`, its a common mistake that leads to multiple and grave problems +****IMPORTANT NOTICE**: Do not fork `https://github.com/AyuntamientoMadrid/consul`, its a common mistake that leads to multiple and grave problems. ## Why make code public? diff --git a/docs/en/getting_started/update.md b/docs/en/getting_started/update.md index 1aff59694..1c312dd7a 100644 --- a/docs/en/getting_started/update.md +++ b/docs/en/getting_started/update.md @@ -48,15 +48,15 @@ git fetch upstream And then you can choose to either: -A. Get all the latest changes on CONSUL's **master** branch with `git merge upstream/master` +A. Get all the latest changes on CONSUL's **master** branch with `git merge upstream/master`. -B. Just update up to an specific release tag (so you can do incremental updates if you're more than one release behind). For example to update up to [v0.9](https://github.com/consul/consul/releases/tag/v0.9) release just: `git merge v0.9` +B. Just update up to an specific release tag (so you can do incremental updates if you're more than one release behind). For example to update up to [v0.9](https://github.com/consul/consul/releases/tag/v0.9) release just: `git merge v0.9`. ## Merging changes After the previous section `merge` command, there are three possible outcomes: -A. You get a nice `Already up-to-date.` response. That means your fork is up to date with consul 😊👌 +A. You get a nice `Already up-to-date.` response. That means your fork is up to date with consul 😊👌. B. You get a screen on your git configured editor showing the commit message `Merge remote-tracking branch 'upstream/master' into upstream`. That means git was able to grab latest changes from CONSUL's master branch, and it can merge them without code change conflicts. Finish the commit. @@ -64,4 +64,4 @@ C. You get some git errors along with a `Automatic merge failed; fix conflicts a Now you can just simply push your **upstream** branch to github and create a Pull Request so you can easily check all changes going into your repo, and see your tests suite runs. -Remember you can always quickly check changes that will come from CONSUL to your fork by replacing **your_org_name** on the url: https://github.com/your_org_name/consul/compare/master...consul:master +Remember you can always quickly check changes that will come from CONSUL to your fork by replacing **your_org_name** on the url: https://github.com/your_org_name/consul/compare/master...consul:master. diff --git a/docs/en/installation/deploying-on-heroku.md b/docs/en/installation/deploying-on-heroku.md index f1a4f30c1..957d710b7 100644 --- a/docs/en/installation/deploying-on-heroku.md +++ b/docs/en/installation/deploying-on-heroku.md @@ -147,7 +147,7 @@ in the file _Gemfile\_custom_, where `x.y.z` is the version defined in the `.rub bundle install ``` -to generate _Gemfile.lock_ before commiting and pushing to the server. +to generate _Gemfile.lock_ before committing and pushing to the server. ### Use Puma as a web server diff --git a/docs/en/installation/docker.md b/docs/en/installation/docker.md index b34ca20aa..eba0bab90 100644 --- a/docs/en/installation/docker.md +++ b/docs/en/installation/docker.md @@ -4,7 +4,7 @@ You can use Docker to have a local CONSUL 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 prefer not to interfer with other rails installations. +- You prefer not to interfere with other rails installations. ## Prerequisites diff --git a/docs/en/installation/installer.md b/docs/en/installation/installer.md index 9349c6a35..b9f924fdd 100644 --- a/docs/en/installation/installer.md +++ b/docs/en/installation/installer.md @@ -2,4 +2,4 @@ ## Installation notes for Production and Staging servers -Check out the [installer's README](https://github.com/consul/installer) +Check out the [installer's README](https://github.com/consul/installer). diff --git a/docs/en/installation/macos.md b/docs/en/installation/macos.md index a5ad3baab..88c2a4e1a 100644 --- a/docs/en/installation/macos.md +++ b/docs/en/installation/macos.md @@ -62,7 +62,7 @@ createdb 'your_username' If we run `psql` again we should now get access to postgres console. With `\du` you can see the current users list. -In case you want to set a password for your user you can make it throught postgres console by: +In case you want to set a password for your user you can make it through postgres console by: ``` ALTER USER your_username WITH PASSWORD 'your_password'; diff --git a/docs/en/installation/vagrant.md b/docs/en/installation/vagrant.md index 767713d53..5114fad5d 100644 --- a/docs/en/installation/vagrant.md +++ b/docs/en/installation/vagrant.md @@ -6,7 +6,7 @@ Vagrant is compatible for [Debian](/en/installation/debian.md) and [Ubuntu](/en/ ## Browser configuration -To access the application through the brower at `localhost:3000` we must forward a port and run the rails server with a binding option: +To access the application through the browser at `localhost:3000` we must forward a port and run the rails server with a binding option: ## Port forwarding Open the Vagrant configuration file: diff --git a/docs/es/customization/customization.md b/docs/es/customization/customization.md index 77f5816f8..1ff6afb9b 100644 --- a/docs/es/customization/customization.md +++ b/docs/es/customization/customization.md @@ -8,4 +8,4 @@ * [Modelos](models.md) * [Componentes](components.md) * [Gemas](gems.md) -* [Adaptar la aplicación](overwritting.md) +* [Adaptar la aplicación](overwriting.md)