From 21e3dcf7bf650353c74aa4a9ae27ab01afee08f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mar=C3=ADa=20Checa?= Date: Wed, 16 Aug 2017 18:26:33 +0200 Subject: [PATCH] Gitbook first attempt Added english and spanish translations, first version of the summary and local installation guide. --- docs/.gitignore | 1 + docs/LANGS.md | 4 +++ docs/README.md | 2 -- docs/en/README.md | 12 ++++++++ docs/en/SUMMARY.md | 25 +++++++++++++++ docs/en/book.json | 5 +++ docs/en/customization/new_features.md | 1 + docs/en/customization/overwritting.md | 1 + docs/en/customization/templating.md | 1 + docs/en/customization/translations.md | 1 + docs/en/forks/communication.md | 1 + docs/en/forks/create.md | 1 + docs/en/forks/update.md | 1 + docs/en/installation/README.md | 42 ++++++++++++++++++++++++++ docs/en/open_source/code_of_conduct.md | 1 + docs/en/open_source/contributing.md | 1 + docs/en/open_source/conventions.md | 1 + docs/en/open_source/testing.md | 1 + docs/en/recomendations/README.md | 1 + docs/en/servers/README.md | 1 + docs/es/README.md | 12 ++++++++ docs/es/SUMMARY.md | 25 +++++++++++++++ docs/es/book.json | 5 +++ docs/es/customization/new_features.md | 1 + docs/es/customization/overwritting.md | 1 + docs/es/customization/templating.md | 1 + docs/es/customization/translations.md | 1 + docs/es/forks/communication.md | 1 + docs/es/forks/create.md | 1 + docs/es/forks/update.md | 1 + docs/es/installation/README.md | 42 ++++++++++++++++++++++++++ docs/es/open_source/code_of_conduct.md | 1 + docs/es/open_source/contributing.md | 1 + docs/es/open_source/conventions.md | 1 + docs/es/open_source/testing.md | 1 + docs/es/recomendations/README.md | 1 + docs/es/servers/README.md | 1 + 37 files changed, 199 insertions(+), 2 deletions(-) create mode 100644 docs/.gitignore create mode 100644 docs/LANGS.md delete mode 100644 docs/README.md create mode 100644 docs/en/README.md create mode 100644 docs/en/SUMMARY.md create mode 100644 docs/en/book.json create mode 100644 docs/en/customization/new_features.md create mode 100644 docs/en/customization/overwritting.md create mode 100644 docs/en/customization/templating.md create mode 100644 docs/en/customization/translations.md create mode 100644 docs/en/forks/communication.md create mode 100644 docs/en/forks/create.md create mode 100644 docs/en/forks/update.md create mode 100644 docs/en/installation/README.md create mode 100644 docs/en/open_source/code_of_conduct.md create mode 100644 docs/en/open_source/contributing.md create mode 100644 docs/en/open_source/conventions.md create mode 100644 docs/en/open_source/testing.md create mode 100644 docs/en/recomendations/README.md create mode 100644 docs/en/servers/README.md create mode 100644 docs/es/README.md create mode 100644 docs/es/SUMMARY.md create mode 100644 docs/es/book.json create mode 100644 docs/es/customization/new_features.md create mode 100644 docs/es/customization/overwritting.md create mode 100644 docs/es/customization/templating.md create mode 100644 docs/es/customization/translations.md create mode 100644 docs/es/forks/communication.md create mode 100644 docs/es/forks/create.md create mode 100644 docs/es/forks/update.md create mode 100644 docs/es/installation/README.md create mode 100644 docs/es/open_source/code_of_conduct.md create mode 100644 docs/es/open_source/contributing.md create mode 100644 docs/es/open_source/conventions.md create mode 100644 docs/es/open_source/testing.md create mode 100644 docs/es/recomendations/README.md create mode 100644 docs/es/servers/README.md diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..e43b0f988 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +.DS_Store diff --git a/docs/LANGS.md b/docs/LANGS.md new file mode 100644 index 000000000..692910c73 --- /dev/null +++ b/docs/LANGS.md @@ -0,0 +1,4 @@ +# Languages + +* [English](en/) +* [Español](es/) diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index b850f306b..000000000 --- a/docs/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# docs -Consul documentation diff --git a/docs/en/README.md b/docs/en/README.md new file mode 100644 index 000000000..d708e5531 --- /dev/null +++ b/docs/en/README.md @@ -0,0 +1,12 @@ +# Consul Documentation +[![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) +[![Coverage Status](https://coveralls.io/repos/github/consul/consul/badge.svg?branch=master)](https://coveralls.io/github/consul/consul?branch=master) +[![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) + +[![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) + +# Licensing +Code published under AFFERO GPL v3 (see [LICENSE-AGPLv3.txt](https://github.com/consul/consul/blob/master/LICENSE-AGPLv3.txt)). diff --git a/docs/en/SUMMARY.md b/docs/en/SUMMARY.md new file mode 100644 index 000000000..40c76c804 --- /dev/null +++ b/docs/en/SUMMARY.md @@ -0,0 +1,25 @@ +# Summary + +* [Introduction](README.md) + +### Getting started +* [Local installation](installation/README.md) +* [Production and Test servers](servers/README.md) +* [Recomendations](recomendations/README.md) + +### Customization +* [Templating](customization/templating.md) +* [Translations](customization/translations.md) +* [Overwritting](customization/overwritting.md) +* [Adding new features](customization/new_features.md) + +### Your Consul +* [Creating your fork](forks/create.md) +* [Keeping your fork updated](forks/update.md) +* [Communication](forks/communication.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) diff --git a/docs/en/book.json b/docs/en/book.json new file mode 100644 index 000000000..45726b068 --- /dev/null +++ b/docs/en/book.json @@ -0,0 +1,5 @@ +{ + "gitbook": ">= 3.0.0", + "title": "Consul Documentation", + "description": "Citizen Participation and Open Government Application" +} diff --git a/docs/en/customization/new_features.md b/docs/en/customization/new_features.md new file mode 100644 index 000000000..215d586ca --- /dev/null +++ b/docs/en/customization/new_features.md @@ -0,0 +1 @@ +# Adding new features diff --git a/docs/en/customization/overwritting.md b/docs/en/customization/overwritting.md new file mode 100644 index 000000000..898986935 --- /dev/null +++ b/docs/en/customization/overwritting.md @@ -0,0 +1 @@ +# Overwritting diff --git a/docs/en/customization/templating.md b/docs/en/customization/templating.md new file mode 100644 index 000000000..1bee59f2e --- /dev/null +++ b/docs/en/customization/templating.md @@ -0,0 +1 @@ +# Templating diff --git a/docs/en/customization/translations.md b/docs/en/customization/translations.md new file mode 100644 index 000000000..26b0d9944 --- /dev/null +++ b/docs/en/customization/translations.md @@ -0,0 +1 @@ +# Translations diff --git a/docs/en/forks/communication.md b/docs/en/forks/communication.md new file mode 100644 index 000000000..f54a2ad5c --- /dev/null +++ b/docs/en/forks/communication.md @@ -0,0 +1 @@ +# Communication diff --git a/docs/en/forks/create.md b/docs/en/forks/create.md new file mode 100644 index 000000000..1d6ca1546 --- /dev/null +++ b/docs/en/forks/create.md @@ -0,0 +1 @@ +# Creating your fork diff --git a/docs/en/forks/update.md b/docs/en/forks/update.md new file mode 100644 index 000000000..ee89a825a --- /dev/null +++ b/docs/en/forks/update.md @@ -0,0 +1 @@ +# Keeping your fork updated diff --git a/docs/en/installation/README.md b/docs/en/installation/README.md new file mode 100644 index 000000000..a6a087610 --- /dev/null +++ b/docs/en/installation/README.md @@ -0,0 +1,42 @@ +# Local installation + +Before installing Consul and having it up and running make sure you have [Ruby 2.3.2](https://www.ruby-lang.org/en/news/2016/11/15/ruby-2-3-2-released/) installed in your local environment. + +1. First, clone the [Consul Github repository](https://github.com/consul/consul/): + + ``` + git clone https://github.com/consul/consul.git + ``` + +2. Go to the project folder and install the gems stack using [Bundler](http://bundler.io/): + ``` + cd consul + bundle install + ``` + +3. Copy the environment example configuration files inside new readable ones: + + ``` + cp config/database.yml.example config/database.yml + cp config/secrets.yml.example config/secrets.yml + ``` + +4. Run the following [Rake tasks](https://github.com/ruby/rake) to fill your local database with the minimum data to run the application: + + ``` + bin/rake db:setup + bin/rake db:dev_seed + RAILS_ENV=test rake db:setup + ``` + +5. Now you have all set, run the application: + + ``` + rails s + ``` + + Congratulations! Your local Consul application will be running now at `http://localhost:3000`. + +In case you want to access the local application as admin, a default user with admin permissions was created by the seed files with **username** `admin@consul.dev` and **password** `12345678`. + +If you need an specific user to perform actions such as voting, a default verified user is also available with **username** `verified@consul.dev` and **password** `12345678`. diff --git a/docs/en/open_source/code_of_conduct.md b/docs/en/open_source/code_of_conduct.md new file mode 100644 index 000000000..2fe822c77 --- /dev/null +++ b/docs/en/open_source/code_of_conduct.md @@ -0,0 +1 @@ +# Code of conduct diff --git a/docs/en/open_source/contributing.md b/docs/en/open_source/contributing.md new file mode 100644 index 000000000..854139a31 --- /dev/null +++ b/docs/en/open_source/contributing.md @@ -0,0 +1 @@ +# Contributing diff --git a/docs/en/open_source/conventions.md b/docs/en/open_source/conventions.md new file mode 100644 index 000000000..ded288c8b --- /dev/null +++ b/docs/en/open_source/conventions.md @@ -0,0 +1 @@ +# Linters and conventions diff --git a/docs/en/open_source/testing.md b/docs/en/open_source/testing.md new file mode 100644 index 000000000..f00b526a9 --- /dev/null +++ b/docs/en/open_source/testing.md @@ -0,0 +1 @@ +# Testing diff --git a/docs/en/recomendations/README.md b/docs/en/recomendations/README.md new file mode 100644 index 000000000..14f651981 --- /dev/null +++ b/docs/en/recomendations/README.md @@ -0,0 +1 @@ +# Recomendations diff --git a/docs/en/servers/README.md b/docs/en/servers/README.md new file mode 100644 index 000000000..52317d866 --- /dev/null +++ b/docs/en/servers/README.md @@ -0,0 +1 @@ +# Production and Test servers diff --git a/docs/es/README.md b/docs/es/README.md new file mode 100644 index 000000000..f9a075692 --- /dev/null +++ b/docs/es/README.md @@ -0,0 +1,12 @@ +# Documentación Consul +[![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) +[![Coverage Status](https://coveralls.io/repos/github/consul/consul/badge.svg?branch=master)](https://coveralls.io/github/consul/consul?branch=master) +[![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) + +[![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) + +# Licencia +Código publicado bajo licencia AFFERO GPL v3 (ver [LICENSE-AGPLv3.txt](https://github.com/consul/consul/blob/master/LICENSE-AGPLv3.txt)). diff --git a/docs/es/SUMMARY.md b/docs/es/SUMMARY.md new file mode 100644 index 000000000..422d40526 --- /dev/null +++ b/docs/es/SUMMARY.md @@ -0,0 +1,25 @@ +# Summary + +* [Introducción](README.md) + +### Primeros pasos +* [Instalación local](installation/README.md) +* [Servidores de prueba y producción](servers/README.md) +* [Recomendaciones](recomendations/README.md) + +### Personalización +* [Interfaz y diseño](customization/templating.md) +* [Idiomas](customization/translations.md) +* [Adaptar la aplicación](customization/overwritting.md) +* [Añadir nuevas funcionalidades](customization/new_features.md) + +### Tu Consul +* [Crea tu fork](forks/create.md) +* [Manten tu fork actualizado](forks/update.md) +* [Comunicación](forks/communication.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) diff --git a/docs/es/book.json b/docs/es/book.json new file mode 100644 index 000000000..7749b6377 --- /dev/null +++ b/docs/es/book.json @@ -0,0 +1,5 @@ +{ + "gitbook": ">= 3.0.0", + "title": "Documentación Consul", + "description": "Aplicación de Gobierno Abierto y Participación Ciudadana" +} diff --git a/docs/es/customization/new_features.md b/docs/es/customization/new_features.md new file mode 100644 index 000000000..2be65a165 --- /dev/null +++ b/docs/es/customization/new_features.md @@ -0,0 +1 @@ +# Añadir nuevas funcionalidades diff --git a/docs/es/customization/overwritting.md b/docs/es/customization/overwritting.md new file mode 100644 index 000000000..32cead74b --- /dev/null +++ b/docs/es/customization/overwritting.md @@ -0,0 +1 @@ +# Adaptar la aplicación diff --git a/docs/es/customization/templating.md b/docs/es/customization/templating.md new file mode 100644 index 000000000..547948671 --- /dev/null +++ b/docs/es/customization/templating.md @@ -0,0 +1 @@ +# Interfaz y diseño diff --git a/docs/es/customization/translations.md b/docs/es/customization/translations.md new file mode 100644 index 000000000..db3f3f4ba --- /dev/null +++ b/docs/es/customization/translations.md @@ -0,0 +1 @@ +# Idiomas diff --git a/docs/es/forks/communication.md b/docs/es/forks/communication.md new file mode 100644 index 000000000..aaebe32ff --- /dev/null +++ b/docs/es/forks/communication.md @@ -0,0 +1 @@ +# Comunicación diff --git a/docs/es/forks/create.md b/docs/es/forks/create.md new file mode 100644 index 000000000..bb3ef1a68 --- /dev/null +++ b/docs/es/forks/create.md @@ -0,0 +1 @@ +# Crea tu fork diff --git a/docs/es/forks/update.md b/docs/es/forks/update.md new file mode 100644 index 000000000..3d55f2bd5 --- /dev/null +++ b/docs/es/forks/update.md @@ -0,0 +1 @@ +# Manten tu fork actualizado diff --git a/docs/es/installation/README.md b/docs/es/installation/README.md new file mode 100644 index 000000000..320b9debb --- /dev/null +++ b/docs/es/installation/README.md @@ -0,0 +1,42 @@ +# Instalación local + +Antes de instalar Consul y empezar a usarlo asegúrate de tener [Ruby 2.3.2](https://www.ruby-lang.org/en/news/2016/11/15/ruby-2-3-2-released/) instalado en tu entorno local. + +1. Primero, clona el [repositorio de Consul en Github](https://github.com/consul/consul/): + + ``` + git clone https://github.com/consul/consul.git + ``` + +2. Ve a la carpeta del proyecto e instala las gemas requeridas usando [Bundler](http://bundler.io/): + ``` + cd consul + bundle install + ``` + +3. Copia los archivos de configuración de ejemplo del entorno dentro de unos nuevos válidos: + + ``` + cp config/database.yml.example config/database.yml + cp config/secrets.yml.example config/secrets.yml + ``` + +4. Ejecuta las siguientes [tareas Rake](https://github.com/ruby/rake) para rellenar tu base de datos local con el mínimo de información necesaria para que la aplicación funcione correctamente: + + ``` + bin/rake db:setup + bin/rake db:dev_seed + RAILS_ENV=test rake db:setup + ``` + +5. Ahora que ya está todo listo puedes ejecutar la aplicación: + + ``` + rails s + ``` + + ¡Felicidades! Tu aplicación Consul 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 con permisos con **nombre de usuario** `admin@consul.dev` y **contraseña** `12345678`. + +Si necesitas un usuario específico que pueda realizar acciones como votar, dispones de otro usuario verificado con **nombre de usuario** `verified@consul.dev` y **contraseña** `12345678`. diff --git a/docs/es/open_source/code_of_conduct.md b/docs/es/open_source/code_of_conduct.md new file mode 100644 index 000000000..7478ac228 --- /dev/null +++ b/docs/es/open_source/code_of_conduct.md @@ -0,0 +1 @@ +# Código de conducta diff --git a/docs/es/open_source/contributing.md b/docs/es/open_source/contributing.md new file mode 100644 index 000000000..ee33f5050 --- /dev/null +++ b/docs/es/open_source/contributing.md @@ -0,0 +1 @@ +# Contribuciones diff --git a/docs/es/open_source/conventions.md b/docs/es/open_source/conventions.md new file mode 100644 index 000000000..3f65aec96 --- /dev/null +++ b/docs/es/open_source/conventions.md @@ -0,0 +1 @@ +# Linters y convenciones diff --git a/docs/es/open_source/testing.md b/docs/es/open_source/testing.md new file mode 100644 index 000000000..007eb9551 --- /dev/null +++ b/docs/es/open_source/testing.md @@ -0,0 +1 @@ +# Tests diff --git a/docs/es/recomendations/README.md b/docs/es/recomendations/README.md new file mode 100644 index 000000000..a5f14d941 --- /dev/null +++ b/docs/es/recomendations/README.md @@ -0,0 +1 @@ +# Recomendaciones diff --git a/docs/es/servers/README.md b/docs/es/servers/README.md new file mode 100644 index 000000000..a560624f9 --- /dev/null +++ b/docs/es/servers/README.md @@ -0,0 +1 @@ +# Servidores de prueba y producción