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

Update READMEs and SUMMARIES

Browse Source
This commit is contained in:
voodoorai2000
2019-04-01 21:56:12 +02:00
parent 149d4682e2
commit 73c54f5b90
6 changed files with 172 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
docs/README.md
View File

@@ -1,10 +1,78 @@
# Consul Documentation
![Logo of CONSUL](/docs/img/consul_logo.png)
This is the opensource documentation repository for [Consul](https://github.com/consul/consul), a Citizen Participation and Open Government Application
# CONSUL
* [Read English version](https://consul_docs.gitbooks.io/docs/content/en/)
* [Lee la versión en Castellano](https://consul_docs.gitbooks.io/docs/content/es/)
Citizen Participation and Open Government Application
[![Build Status](https://travis-ci.org/consul/consul.svg?branch=master)](https://travis-ci.org/consul/consul)
[![Code Climate](https://codeclimate.com/github/consul/consul/badges/gpa.svg)](https://codeclimate.com/github/consul/consul)
[![Dependency Status](https://gemnasium.com/consul/consul.svg)](https://gemnasium.com/consul/consul)
[![Coverage Status](https://coveralls.io/repos/github/consul/consul/badge.svg?branch=master)](https://coveralls.io/github/consul/consul?branch=master)
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/consul/localized.svg)](https://crowdin.com/project/consul)
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](http://www.gnu.org/licenses/agpl-3.0)
[![Accessibility conformance](https://img.shields.io/badge/accessibility-WAI:AA-green.svg)](https://www.w3.org/WAI/eval/Overview)
[![A11y issues checked with Rocket Validator](https://rocketvalidator.com/badges/checked_with_rocket_validator.svg?url=https://rocketvalidator.com)](https://rocketvalidator.com/opensource)
[![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
## 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)
## Configuration for development and test environments
**NOTE**: For more detailed instructions check the [docs](https://consul_docs.gitbooks.io/docs/content/en/getting_started/prerequisites/)
Prerequisites: install git, Ruby 2.3.2, bundler gem, Node.js and PostgreSQL (>=9.4).
```bash
git clone https://github.com/consul/consul.git
cd consul
bundle install
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml
bin/rake db:create
bin/rake db:migrate
bin/rake db:dev_seed
RAILS_ENV=test rake db:setup
```
Run the app locally:
```
bin/rails s
```
Prerequisites for testing: install ChromeDriver >= 2.33
Run the tests with:
```
bin/rspec
```
You can use the default admin user from the seeds file:
**user:** admin@consul.dev
**pass:** 12345678
But for some actions like voting, you will need a verified user, the seeds file also includes one:
**user:** verified@consul.dev
**pass:** 12345678
## Documentation
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))
## Contributions
See [CONTRIBUTING.md](CONTRIBUTING.md)
See [CONTRIBUTING.md](https://github.com/consul/consul/blob/master/CONTRIBUTING.md)

95
docs/SUMMARY.md Normal file
View File

@@ -0,0 +1,95 @@
# Summary
## ENGLISH Documentation
* [Getting started](en/getting_started/getting_started.md)
* [Fork Consul](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)
* [Installation](en/installation/introduction.md)
* [Local installation](en/installation/local_installation.md)
* [Prerequisites](en/installation/prerequisites.md)
* [Ubuntu Linux](en/installation/ubuntu.md)
* [Debian Linux](en/installation/debian.md)
* [MacOS](en/installation/macos.md)
* [Windows](en/installation/windows.md)
* [Production and Staging servers](en/installation/servers.md)
* [Installer](en/installation/installer.md)
* [Crear usuario](en/installation/create_deploy_user.md)
* [Generación de claves SSH](en/installation/generating_ssh_key.md)
* [Digital Ocean](en/installation/digital_ocean.md)
* [Heroku](en/installation/deploying-on-heroku.md)
* [Docker](en/installation/docker.md)
* [Development Mail Server](en/installation/dev_mailserver.md)
* [Basic configuration](en/installation/basic_configuration.md)
* [CONSUL Documentation and guides](en/installation/documentation_and_guides.md)
* [Customization](en/customization/customization.md)
* [Introduction](en/customization/introduction.md)
* [Texts & Translations](en/customization/translations.md)
* [Images](en/customization/images.md)
* [Views & Styles](en/customization/views_and_styles.md)
* [Javascript](en/customization/javascript.md)
* [Models](en/customization/models.md)
* [Gems](en/customization/gems.md)
* [Overwritting Application](en/customization/overwritting.md)
* [Technical Features](en/features/features.md)
* [OAuth](en/features/oauth.md)
* [GraphQL](en/features/graphql.md)
* [Recommendations](en/features/recommendations.md)
* [Open Source project](en/open_source/open_source.md)
* [Code of conduct](en/open_source/code_of_conduct.md)
* [Contributing](en/open_source/contributing.md)
* [License](es/open_source/license.md)
## SPANISH Documentation
* [Introducción](es/README.md)
* [Primeros pasos](es/getting_started/getting_started.md)
* [Crea tu fork](es/getting_started/create.md)
* [Configura tu fork](es/getting_started/configuration.md)
* [Manten tu fork actualizado](es/getting_started/update.md)
* [Comunicación](es/getting_started/communication.md)
* [Installation](es/installation/introduction.md)
* [Instalación local](es/installation/local_installation.md)
* [Prerrequisitos](en/installation/prerequisitos.md)
* [Ubuntu Linux](es/installation/ubuntu.md)
* [Debian Linux](es/installation/debian.md)
* [MacOS](es/installation/macos.md)
* [Windows](es/installation/windows.md)
* [Servidores de producción y pruebas](es/installation/servers.md)
* [Instalador](es/installation/installer.md)
* [Create a deploy user](es/installation/create_deploy_user.md)
* [Generating SSH Key](es/installation/generating_ssh_key.md)
* [Digital Ocean](es/installation/digital_ocean.md)
* [Heroku](es/installation/deploying-on-heroku.md)
* [Docker](es/installation/docker.md)
* [Servidor local de correo](es/installation/dev_mailserver.md)
* [Configuración básica](es/installation/basic_configuration.md)
* [Documentación y guías sobre CONSUL](es/installation/documentation_and_guides.md)
* [Personalización](es/customization/customization.md)
* [Introducción](es/customization/introduction.md)
* [Textos & Traducciones](es/customization/translations.md)
* [Imágenes](es/customization/images.md)
* [Vistas & Estilos](es/customization/views_and_styles.md)
* [Javascript](es/customization/javascript.md)
* [Modelos](es/customization/models.md)
* [Gemas](es/customization/gems.md)
* [Adaptar la aplicación](es/customization/overwritting.md)
* [Funcionalidades Técnicas](es/features/features.md)
* [OAuth](es/features/oauth.md)
* [GraphQL](es/features/graphql.md)
* [Recomendaciones](es/features/recommendations.md)
* [Proyecto Open Source](es/open_source/open_source.md)
* [Código de conducta](es/open_source/code_of_conduct.md)
* [Contribuciones](es/open_source/contributing.md)
* [Licencia](es/open_source/license.md)

4
docs/en/README.md
View File

@@ -1,4 +1,4 @@
![Logo of CONSUL](../consul_logo.png)
![Logo of CONSUL](../img/consul_logo.png)
# CONSUL
@@ -71,7 +71,7 @@ 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](open_source/license.md))
## Contributions

52
docs/en/SUMMARY.md
View File

@@ -1,52 +0,0 @@
# Summary
* [Introduction](README.md)
### Getting started
* [Fork Consul](forks/create.md)
* [Configure your fork](forks/configuration.md)
* [Keep your fork updated](forks/update.md)
* [Communication](forks/communication.md)
### Installation
* [Introduction](getting_started/introduction.md)
* [Prerequisites](getting_started/prerequisites/README.md)
* [Debian GNU/Linux](getting_started/prerequisites/linux.md)
* [Ubuntu Linux](getting_started/prerequisites/ubuntu.md)
* [macOS](getting_started/prerequisites/macos.md)
* [Windows](getting_started/prerequisites/windows.md)
* [Local installation](getting_started/local_installation.md)
* [Development Mail Server](getting_started/dev_mailserver.md)
* [Production and Staging servers](getting_started/servers.md)
* [Digital Ocean](getting_started/digital_ocean.md)
* [Create a deploy user](getting_started/create_deploy_user.md)
* [Generating SSH Key](getting_started/generating_ssh_key.md)
* [Heroku](getting_started/deploying-on-heroku.md)
* [Docker](getting_started/docker.md)
* [Basic configuration](getting_started/basic_configuration.md)
* [CONSUL Documentation and guides](getting_started/documentation_and_guides.md)
### Customization
* [Introduction](customization/introduction.md)
* [Templating](customization/templating.md)
* [Texts & Translations](customization/translations.md)
* [Images](customization/images.md)
* [Views & Styles](customization/views_and_styles.md)
* [Javascript](customization/javascript.md)
* [Models](customization/models.md)
* [Gems](customization/gems.md)
* [Overwritting Application](customization/overwritting.md)
* [Adding new features](customization/new_features.md)
### Technical Features
* [OAuth](features/oauth.md)
* [GraphQL](features/graphql.md)
## User Features
* [Recommendations](features/recommendations.md)
### Open Source project
* [Code of conduct](open_source/code_of_conduct.md)
* [Contributing](open_source/contributing.md)
* [Testing](open_source/testing.md)
* [Linters and conventions](open_source/conventions.md)

4
docs/es/README.md
View File

@@ -1,4 +1,4 @@
![Logotipo de CONSUL](../consul_logo.png)
![Logotipo de CONSUL](../img/consul_logo.png)
# CONSUL
@@ -72,7 +72,7 @@ La documentación de este proyecto se encuentra en https://github.com/consul/doc
## Licencia
El código de este proyecto está publicado bajo la licencia AFFERO GPL v3 (ver [LICENSE-AGPLv3.txt](LICENSE-AGPLv3.txt))
El código de este proyecto está publicado bajo la licencia AFFERO GPL v3 (ver [LICENSE-AGPLv3.txt](open_source/license.md))
## Contribuciones

52
docs/es/SUMMARY.md
View File

@@ -1,52 +0,0 @@
# Summary
* [Introducción](README.md)
### Primeros pasos
* [Crea tu fork](forks/create.md)
* [Configura tu fork](forks/configuration.md)
* [Manten tu fork actualizado](forks/update.md)
* [Comunicación](forks/communication.md)
### Instalación
* [Introducción](getting_started/introduction.md)
* [Prerrequisitos](getting_started/prerequisites/README.md)
* [Debian GNU/Linux](getting_started/prerequisites/linux.md)
* [Ubuntu Linux](getting_started/prerequisites/ubuntu.md)
* [macOS](getting_started/prerequisites/macos.md)
* [Windows](getting_started/prerequisites/windows.md)
* [Instalación local](getting_started/local_installation.md)
* [Servidor local de correo](getting_started/dev_mailserver.md)
* [Servidores de prueba y producción](getting_started/servers.md)
* [Digital Ocean](getting_started/digital_ocean.md)
* [Crear usuario](getting_started/create_deploy_user.md)
* [Generación de claves SSH](getting_started/generating_ssh_key.md)
* [Heroku](getting_started/deploying-on-heroku.md)
* [Docker](getting_started/docker.md)
* [Configuración básica](getting_started/basic_configuration.md)
* [Documentación y guías sobre CONSUL](getting_started/documentation_and_guides.md)
### Personalización
* [Introducción](customization/README.md)
* [Interfaz y diseño](customization/templating.md)
* [Textos & Traducciones](customization/translations.md)
* [Imágenes](customization/images.md)
* [Vistas & Estilos](customization/views_and_styles.md)
* [Javascript](customization/javascript.md)
* [Modelos](customization/models.md)
* [Gemas](customization/gems.md)
* [Adaptar la aplicación](customization/overwritting.md)
* [Añadir nuevas funcionalidades](customization/new_features.md)
### Funcionalidades Técnicas
* [OAuth](features/oauth.md)
* [GraphQL](features/graphql.md)
## Funcionalidades de Usuario
* [Recomendaciones](features/recommendations.md)
### Proyecto Open Source
* [Código de conducta](open_source/code_of_conduct.md)
* [Contribuciones](open_source/contributing.md)
* [Tests](open_source/testing.md)
* [Linters y convenciones](open_source/conventions.md)