decidim 0.23.5 → 0.24.2

data/docs/customization/oauth.md

@@ -1,50 +0,0 @@
-# OAuth
-
-Decidim is both and OAuth client (via [omniauth](https://github.com/omniauth/omniauth)) and an OAuth provider (via [doorkeeper](https://github.com/doorkeeper-gem/doorkeeper)).
-
-Check the [Social Providers](https://github.com/decidim/decidim/blob/master/docs/services/social_providers.md) document to check the client configuration.
-
-## Decidim as an OAuth provider
-
-You can use your own Decidim application to log in to other applications that support OAuth 2. To do it you need to create an OAuth application from the admin panel for each client that wants to use Decidim.
-
-To create a new OAuth application you need:
-
-* Name: The name of the client application that will be shown to the user when authorizing it from your Decidim application.
-* Redirect URI: The URI where the Decidim application should redirect the user after authorizing it. It is usually where you handle the OAUth callback in your client application. If you're using `omniauth-decidim` the value should be `YOUR_APPLICATION_HOST/users/auth/decidim/callback`.
-* Organization name: The name of the organization that owns the client application.
-* Organization URL: The URL of the organization that owns the client application.
-* Organization logo: An image of the logo of the organization that owns the client application.
-
-All the organization data will be used during the authorization process so the users know to who they're giving their data.
-
-Once you've created your application you'll get the settings to setup your client.
-
-Check [omniauth-decidim](https://github.com/decidim/omniauth-decidim) in order to configure your client application.
-
-## Performing more actions on omniauth registration
-
-Some times, there is the need to perform more actions than just creating a user on registration, this is why `CreateOmniauthRegistration` command publishes a `"decidim.user.omniauth_registration` event after registration so that developers can subscribe to it and perform other actions like user verification or alike.
-
-This event comes with the following payload:
-
-* user_id: The id for the registered User.
-* identity_id: The id for the social Identity.
-* provider: The name for the social provider.
-* uid: OAuth's uid
-* email: User's email.
-* name: User's name.
-* nickname: User's nickname after being normalized.
-* avatar_url: Avatar's url, if any.
-* raw_data: The raw hash received directly from the Omniauth gem.
-
-To be notified after a registration one should subscribe to the event, in the passed block the after registration code should be implemented:
-
-```ruby
-ActiveSupport::Notifications.subscribe "decidim.user.omniauth_registration" do |name, started, finished, unique_id, data|
-  puts "the data: #{data.inspect}"
-  IdCatMobilVerificationJob.perform_later(data[:raw_data])
-end
-```
-
-It is a good practice to delegate the required implementation to a Job to bring a fastest response to the user, also it will avoid that crashes in this code to propagate to the registration process.

data/docs/customization/styles.md

@@ -1,11 +0,0 @@
-# CSS Styles with SASS
-
-One of the first things you’ll want to do after you install Decidim is applying your own corporative image. To do this, you can go to app/assets/stylesheets/application.css.sass on your generated application with your own colors. There you can override any class using CSS with SASS.
-
-In [decidim-core/app/assets/stylesheets/decidim/_variables.scss](https://github.com/decidim/decidim/blob/master/decidim-core/app/assets/stylesheets/decidim/_variables.scss) you can find the `variables` that can be overriden in your `sass`.
-
-We use [SASS, with SCSS syntax](http://sass-lang.com/guide) as CSS preprocessor.
-
-## **Accesibility**
-
-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)

data/docs/customization/texts.md

@@ -1,27 +0,0 @@
-# Custom Texts
-
-## Using custom locales
-
-You can change most of the texts through the Administration panel.
-
-If you want to change a given text that isn’t on the Administration panel, and belongs on Decidim code, you should first find out which key is being used. For instance, you want to change the home page text where it says "Let's build a more open, transparent and collaborative society.", you would search the text (using [github](https://github.com/decidim/decidim/search?utf8=%E2%9C%93&q=%22Let%27s+build+a+more+open%2C+transparent+and+collaborative+society.%22&type= ) or grep) and then you would extract that key and their parents. On this case it’d be:
-
-```yml
-en:
-  pages:
-    home:
-      footer_sub_hero:
-        footer_sub_hero_body: Let's build a more open, transparent and collaborative society.<br /> Join, participate and decide.
-```
-
-You need to create a file for this translation as [Ruby on Rails i18n documentation](http://guides.rubyonrails.org/i18n.html) says, for instance config/locales/home.en.yml, you can see a currently working example in [this PR](https://github.com/AjuntamentdeBarcelona/decidim-barcelona/pull/206).
-
-## Using external module
-
-There is an external module [decidim-term_customizer](https://github.com/mainio/decidim-module-term_customizer), according with the project README:
-
-> The module allows administrators to add "translation sets" through the admin panel which contain customized terms for any module in the system. These sets can be applied against different scopes within the system, e.g. the whole system, participatory space scope (e.g. all participatory processes or a specific participatory process) or a specific component within a participatory space.
-
-To implement this on your decidim installation follow the [documentation in the external module](https://github.com/mainio/decidim-module-term_customizer/blob/master/README.md).
-
-You can see an example in [this PR](https://github.com/decidim/metadecidim/pull/38).

data/docs/customization/users_registration_mode.md

@@ -1,17 +0,0 @@
-# Users registration mode
-
-Decidim allows organizations to choose one of the three modes related to the registration and login of users. This can be configured by the system user, in the organization manager zone.
-
-## Allow users to register and login
-
-This is the default mode. It enables the registration form and allow anyone to create a new account and log in.
-
-## Don't allow users to register, but allow existing users to login
-
-This mode disables the registration form, but allows existing users to log in. This mode could be useful for organizations with a closed census that do not want to offer other people to register.
-
-Note: if you have configured [social providers](services/social_providers.md), users will still be able to sign in with external accounts even when this mode is configured.
-
-## Access only can be done with external accounts
-
-This mode disables the registration form and the login form. With this mode, users only can access through [social providers](services/social_providers.md), so it is recommended to configure at least one of them. This can be useful when an organization needs to allow participation only to users of another application of the organization itself.

data/docs/development_guide.md

@@ -1,166 +0,0 @@
-# Developing Decidim
-
-## Create a development_app
-
-In order to start developing you will need what is called a `development_app`. This is nearly the same as a new Decidim app (that you can create with `decidim app_name`) but with a Gemfile pre-configured for local development and some other small config modifications.
-You need it in order to have a Rails application configured to lookup Decidim modules from your filesystem. This way changes in your modules will be directly observed by this `development_app`.
-
-You can create a `development_app` from inside the project's root folder with the command:
-
-```console
-git clone https://github.com/decidim/decidim.git
-cd decidim
-bundle install
-bundle exec rake development_app
-cd development_app
-```
-
-A development_app/ entry appears in the .gitignore file, so you don't have to worry about commiting the development app by mistake.
-
-On creation, this steps are automatically invoked by the generator:
-
-- create a `config/database.yml`
-- `bundle install`
-- `bin/rails decidim:upgrade`
-- `bin/rails db:migrate db:seed`
-
-If the default database.yml does not suit your needs you can always configure it at your will and run this steps manually.
-
-Once created you are ready to:
-
-- `bin/rails s`
-
-## GitFlow Branching model
-
-The Decidim respository follows the GitFlow branching model. There are good documentations on it at:
-
-- the original post: https://nvie.com/posts/a-successful-git-branching-model/
-- provided by Atlassian: https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow.
-
-This model introduces the `develop` branch as a kind of queue for new features to enter into the next release.
-
-In summary, Decidim developers that work on `feature/...` or `fix/...` branches will branch off from `develop` and must be merged back into `develop`.
-
-Then, to start a new feature branch off from `develop` in the following way:
-
-```bash
-git checkout develop
-git checkout -b feature/xxx
-```
-
-Implement the feature, and open a Pull Request as normal, but against `develop` branch. As this is the most common operation, `develop` is the default branch instead of `master`.
-
-### Naming Decidim branches
-
-We would like to have all branches following this namings:
-
-| Branch prefix | Comment |
-| --------  | -------- |
-| chore/    | Internal work. For instance, automatisms, etc. No production code change.     |
-| ci/       | For continous integration related tasks. No production code change.     |
-| deps/     | For dependency management tasks. |
-| doc/      | For changes to the documentation. |
-| feature/  | For new features for the users or for the Decidim command.  |
-| fix/      | For feature bugfixing. |
-| release/  | With MAYOR.MINOR-stable. For instance, release/0.22-stable |
-| refactor/ | For refactorings related with production code. |
-| test/     | When adding missing tests, refactoring tests, improving coverage, etc. |
-| backport/ | We only offer support for the last mayor version.  |
-
-## Git commit messages and Pull Request titles
-
-We recommend following [this guide](https://chris.beams.io/posts/git-commit/) for making good git commit messages. It also applies to Pull Request titles. The summary is:
-
-1. Separate subject from body with a blank line
-1. Limit the subject line to 50 characters
-1. Capitalize the subject line
-1. Do not end the subject line with a period
-1. Use the imperative mood in the subject line
-1. Wrap the body at 72 characters
-1. Use the body to explain what and why vs. how
-
-## During development
-
-When creating new migrations in Decidim's modules, you will need to "apply" this migrations to your development_app. The way to do this is by copying the migration from your module into the db/migrate dir of your development_app. Luckily we already have a script that automates this: it copies all missing migrations in development_app/db/migrate. The command is:
-
-```console
-bin/rails decidim:upgrade
-```
-
-Anyway we recommend re-creating your development_app every once in a while.
-
-## Useful commands
-
-### erb-lint
-
-We use erblint gem to ensure homogeneous formatting of erb files.
-
-```console
-bundle exec erblint --lint-all --autocorrect
-# shortest
-bundle exec erblint --lint-all -a
-# even shortest
-bundle exec erblint -la -a
-```
-
-### I18n
-
-We use i18n-tasks gem to keep translations ordered and without missing/unused keys.
-
-```console
-# from the root of the project
-bundle exec i18n-tasks normalize --locales en
-```
-
-### JavaScript linter
-
-[eslint](https://eslint.org/docs/user-guide/command-line-interface) and [tslint](https://palantir.github.io/tslint/) are used to ensure homogeneous formatting of JavaScript code.
-
-To lint and try to fix linting errors, run:
-
-```console
-npm run lint --fix
-```
-
-### Stylelinter
-
-[stylelint](https://stylelint.io/) is a CSS linter and fixer that helps to avoid errors and enforce consistent conventions in the stylesheets. Is an npm package, install it using:
-
-```console
-npm install -g stylelint
-```
-
-Linting a `.scss` file:
-
-```console
-stylelint [path-to-file]
-```
-
-With `--fix` option [stylelint](https://stylelint.io/user-guide/cli/#autofixing-errors) will fix as many errors as possible. The fixes are made to the actual source files. All unfixed errors will be reported.
-
-```console
-stylelint [path-to-file] --fix
-```
-
-### Rubocop
-
-RuboCop is a code analyzer tool we use at Decidim to enforce our code formatting guidelines.
-
-```console
-# Run Rubocop
-bundle exec rubocop
-# Run Rubocop and automatically correct offenses
-bundle exec rubocop -a
-```
-
-### Markdown linter
-
-This project uses [markdownlint](https://github.com/markdownlint/markdownlint) to check markdown files and flag style issues.
-
-## Good to know
-
-- There is an application with current designs at: https://decidim-design.herokuapp.com/
-
-## Testing
-
-Refer to the [testing](advanced/testing.md) guide.

data/docs/getting_started.md

@@ -1,191 +0,0 @@
-# Getting started with Decidim
-
-## What is and what isn't Decidim?
-
-Decidim is a set of Ruby on Rails engines to create a participatory democracy framework on top of a Ruby on Rails app. This system allows having Decidim code separated from custom code for each installation and still enabling easy updates.
-
-These libraries are published to Rubygems.org, so you can add Decidim to your Ruby on Rails app as external dependencies.
-
-If you want to start your own installation of Decidim, you don't need to clone this repo. Keep reading to find out how to install Decidim.
-
-## Creating your Decidim app
-
-### A. Recommended: manual installation
-
-If you know Ruby and have already worked with Ruby on Rails, you
-need to know that decidim is a gem and a command line that generates
-an application that consumes this gem 😅.
-
-The flow is: install gem, generate a Ruby on Rails app, enjoy.
-
-```console
-gem install decidim
-decidim decidim_application
-```
-
-You can see the [official manual installation tutorial](/docs/manual-installation.md),
-and also you have [another manual installation tutorial](https://github.com/Platoniq/decidim-install)
-made by the nice people of [Platoniq](http://www.platoniq.net/).
-
-### B. Using installation script [experimental]
-
-> *Please note that this is **experimental***
-
-We've made an script for Ubuntu 16.04 LTS and macos sierra 10.2.
-It's a BETA and as such you should be aware that this could break
-your environment (if you have any). It'll install rbenv, postgresql,
-nodejs and install decidim on this directory. It should take 15
-minutes depending on your network connection.
-
-```console
-wget http://get.decidim.org -O install_decidim.bash
-bash install_decidim.bash
-```
-
-Read more about the [installation script](https://github.com/alabs/decidim-install).
-
-### C. Using Docker [experimental]
-
-You can also use [docker] && [docker-compose] to develop decidim. You'll
-need to install those but in exchange you don't need to install any other
-dependency in your computer, not even Ruby!
-
-To get started, first clone the decidim repo
-
-```console
-git clone https://github.com/decidim/decidim
-```
-
-Switch to the cloned folder
-
-```console
-cd decidim
-```
-
-Then create a development application
-
-```console
-d/bundle install
-d/rake development_app
-d/rails server -b 0.0.0.0
-```
-
-In general, to use the docker development environment, change any instruction in
-the docs to use its equivalent docker binstub.  So for example, instead of
-running `bundle install`, you would run `d/bundle install`.
-
-## Initializing your app for local development
-
-You should now setup your database:
-
-```console
-bin/rails db:create db:migrate db:seed
-```
-
-This will also create some default data so you can start testing the app:
-
-* A `Decidim::System::Admin` with email `system@example.org` and password `decidim123456`, to log in at `/system`.
-* A `Decidim::Organization` named `Decidim Staging`. You probably want to change its name and hostname to match your needs.
-* A `Decidim::User` acting as an admin for the organization, with email `admin@example.org` and password `decidim123456`.
-* A `Decidim::User` that also belongs to the organization but it's a regular user, with email `user@example.org` and password `decidim123456`.
-
-This data won't be created in production environments, if you still want to do it, run: ``` $ SEED=true rails db:setup ```
-
-You can now start your server!
-
-```console
-bin/rails s
-```
-
-Visit [http://localhost:3000](http://localhost:3000) to see your app running.
-
-## Configuration & setup
-
-Decidim comes pre-configured with some safe defaults, but can be changed through the `config/initializers/decidim.rb` file in your app. Check the comments there or read the comments in [the source file](https://github.com/decidim/decidim/blob/master/decidim-core/lib/decidim/core.rb) (the part with the `config_accessor` calls) for more up-to-date info.
-
-### Scheduled tasks
-
-For Decidim to function as expected, there are some background tasks that should be scheduled to be executed regularly.
-
-- Expired *data portability* files should be removed. To do it, write a `crontab -e` line like: `0 0 * * * cd /Users/you/projects/myrailsapp && /usr/local/bin/rake RAILS_ENV=production decidim:delete_data_portability_files`
-- *Metrics* also require a cron to be computed nightly. Find more information in the [related documentation](https://github.com/decidim/decidim/blob/master/docs/advanced/metrics.md#Configuration).
-- *Open Data* is also produced nightly via a scheduled job. Find more information in the [open-data documentation](https://github.com/decidim/decidim/blob/master/docs/advanced/open-data.md).
-- Registration forms for meetings that have ended should be removed for privacy concerns. To do it, write a `crontab -e` line like: `0 0 * * * cd /Users/you/projects/myrailsapp && /usr/local/bin/rake RAILS_ENV=production decidim_meetings:clean_registration_forms`
-
-### Further configuration
-
-We also have other guides on how to configure some extra components:
-
-* [ActiveJob](https://github.com/decidim/decidim/blob/master/docs/services/activejob.md)
-* [Analytics](https://github.com/decidim/decidim/blob/master/docs/services/analytics.md): How to enable analytics
-* [Geocoding](https://github.com/decidim/decidim/blob/master/docs/services/geocoding.md): How to enable geocoding for proposals and meetings
-* [Social providers integration](https://github.com/decidim/decidim/blob/master/docs/services/social_providers.md): Enable sign up from social networks.
-
-## Deploy
-
-Once you've successfully deployed your app to your favorite platform, you'll need to create your `System` user. First you'll need to create your `Decidim::System` user in your production Ruby on Rails console:
-
-```ruby
-email = <your email>
-password = <a secure password>
-user = Decidim::System::Admin.new(email: email, password: password, password_confirmation: password)
-user.save!
-```
-
-This will create a system user with the email and password you set. We recommend using a random password generator and saving it to a password manager, so you have a more secure login.
-
-Then, visit the `/system` dashboard and login with the email and passwords you just entered and create your organization. You're done! :tada:
-
-You can check the [`decidim-system` README file](https://github.com/decidim/decidim/tree/master/decidim-system/README.md) for more info on how organizations work.
-
-### Seed data in production
-
-If you want, you can create seed data in production. Run this command in your production console:
-
-```console
-SEED=true rails db:seed
-```
-
-You'll need to login as system user and edit the host for the organization. Set it to you production host, without the protocol and the port (so if your host is `https://my.host:3001`, you need to write `my.host`).
-
-## Keeping your app up-to-date
-
-We keep releasing new versions of Decidim. In order to get the latest one, update your dependencies:
-
-```console
-bundle update decidim
-```
-
-And make sure you get all the latest migrations:
-
-```console
-bin/rails decidim:upgrade
-bin/rails db:migrate
-```
-
-You can also make sure new translations are complete for all languages in your
-application with:
-
-```console
-TARGET_BRANCH=release/0.22-stable bin/rails decidim:check_locales
-```
-
-Here the `TARGET_BRANCH` must be the same as the `decidim` dependency in your `Gemfile`.
-
-Be aware that this task might not be able to detect everything, so make sure you
-also manually check your application before upgrading.
-
-## Checklist
-
-There are several things you need to check before making your putting your application on production. See the [checklist](checklist.md).
-
-[docker]: https://docs.docker.com/engine/installation/
-[docker-compose]: https://docs.docker.com/compose/install/
-
-## Contributing
-
-We always welcome new contributors of all levels to the project. If you are not confident enough with Ruby or web development you can look for [issues](https://github.com/decidim/decidim/issues) labeled `good first issue` to start contibuting and learning the internals of the project by doing easy jobs.
-
-We also have a [developer's reference](/docs/development_guide.md) that will help you getting started with your environment and our daily commands, routines, etc.
-
-Finally, you can also find other ways of helping us on our [contribution guide](/CONTRIBUTING.md).