Gitbook first attempt
Added english and spanish translations, first version of the summary and local installation guide.
This commit is contained in:
1
docs/.gitignore
vendored
Normal file
1
docs/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
.DS_Store
|
||||
4
docs/LANGS.md
Normal file
4
docs/LANGS.md
Normal file
@@ -0,0 +1,4 @@
|
||||
# Languages
|
||||
|
||||
* [English](en/)
|
||||
* [Español](es/)
|
||||
@@ -1,2 +0,0 @@
|
||||
# docs
|
||||
Consul documentation
|
||||
12
docs/en/README.md
Normal file
12
docs/en/README.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# Consul Documentation
|
||||
[](https://travis-ci.org/consul/consul)
|
||||
[](https://codeclimate.com/github/consul/consul)
|
||||
[](https://coveralls.io/github/consul/consul?branch=master)
|
||||
[](http://www.gnu.org/licenses/agpl-3.0)
|
||||
[](https://www.w3.org/WAI/eval/Overview)
|
||||
|
||||
[](https://gitter.im/consul/consul?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
[](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)).
|
||||
25
docs/en/SUMMARY.md
Normal file
25
docs/en/SUMMARY.md
Normal file
@@ -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)
|
||||
5
docs/en/book.json
Normal file
5
docs/en/book.json
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"gitbook": ">= 3.0.0",
|
||||
"title": "Consul Documentation",
|
||||
"description": "Citizen Participation and Open Government Application"
|
||||
}
|
||||
1
docs/en/customization/new_features.md
Normal file
1
docs/en/customization/new_features.md
Normal file
@@ -0,0 +1 @@
|
||||
# Adding new features
|
||||
1
docs/en/customization/overwritting.md
Normal file
1
docs/en/customization/overwritting.md
Normal file
@@ -0,0 +1 @@
|
||||
# Overwritting
|
||||
1
docs/en/customization/templating.md
Normal file
1
docs/en/customization/templating.md
Normal file
@@ -0,0 +1 @@
|
||||
# Templating
|
||||
1
docs/en/customization/translations.md
Normal file
1
docs/en/customization/translations.md
Normal file
@@ -0,0 +1 @@
|
||||
# Translations
|
||||
1
docs/en/forks/communication.md
Normal file
1
docs/en/forks/communication.md
Normal file
@@ -0,0 +1 @@
|
||||
# Communication
|
||||
1
docs/en/forks/create.md
Normal file
1
docs/en/forks/create.md
Normal file
@@ -0,0 +1 @@
|
||||
# Creating your fork
|
||||
1
docs/en/forks/update.md
Normal file
1
docs/en/forks/update.md
Normal file
@@ -0,0 +1 @@
|
||||
# Keeping your fork updated
|
||||
42
docs/en/installation/README.md
Normal file
42
docs/en/installation/README.md
Normal file
@@ -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`.
|
||||
1
docs/en/open_source/code_of_conduct.md
Normal file
1
docs/en/open_source/code_of_conduct.md
Normal file
@@ -0,0 +1 @@
|
||||
# Code of conduct
|
||||
1
docs/en/open_source/contributing.md
Normal file
1
docs/en/open_source/contributing.md
Normal file
@@ -0,0 +1 @@
|
||||
# Contributing
|
||||
1
docs/en/open_source/conventions.md
Normal file
1
docs/en/open_source/conventions.md
Normal file
@@ -0,0 +1 @@
|
||||
# Linters and conventions
|
||||
1
docs/en/open_source/testing.md
Normal file
1
docs/en/open_source/testing.md
Normal file
@@ -0,0 +1 @@
|
||||
# Testing
|
||||
1
docs/en/recomendations/README.md
Normal file
1
docs/en/recomendations/README.md
Normal file
@@ -0,0 +1 @@
|
||||
# Recomendations
|
||||
1
docs/en/servers/README.md
Normal file
1
docs/en/servers/README.md
Normal file
@@ -0,0 +1 @@
|
||||
# Production and Test servers
|
||||
12
docs/es/README.md
Normal file
12
docs/es/README.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# Documentación Consul
|
||||
[](https://travis-ci.org/consul/consul)
|
||||
[](https://codeclimate.com/github/consul/consul)
|
||||
[](https://coveralls.io/github/consul/consul?branch=master)
|
||||
[](http://www.gnu.org/licenses/agpl-3.0)
|
||||
[](https://www.w3.org/WAI/eval/Overview)
|
||||
|
||||
[](https://gitter.im/consul/consul?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
[](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)).
|
||||
25
docs/es/SUMMARY.md
Normal file
25
docs/es/SUMMARY.md
Normal file
@@ -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)
|
||||
5
docs/es/book.json
Normal file
5
docs/es/book.json
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"gitbook": ">= 3.0.0",
|
||||
"title": "Documentación Consul",
|
||||
"description": "Aplicación de Gobierno Abierto y Participación Ciudadana"
|
||||
}
|
||||
1
docs/es/customization/new_features.md
Normal file
1
docs/es/customization/new_features.md
Normal file
@@ -0,0 +1 @@
|
||||
# Añadir nuevas funcionalidades
|
||||
1
docs/es/customization/overwritting.md
Normal file
1
docs/es/customization/overwritting.md
Normal file
@@ -0,0 +1 @@
|
||||
# Adaptar la aplicación
|
||||
1
docs/es/customization/templating.md
Normal file
1
docs/es/customization/templating.md
Normal file
@@ -0,0 +1 @@
|
||||
# Interfaz y diseño
|
||||
1
docs/es/customization/translations.md
Normal file
1
docs/es/customization/translations.md
Normal file
@@ -0,0 +1 @@
|
||||
# Idiomas
|
||||
1
docs/es/forks/communication.md
Normal file
1
docs/es/forks/communication.md
Normal file
@@ -0,0 +1 @@
|
||||
# Comunicación
|
||||
1
docs/es/forks/create.md
Normal file
1
docs/es/forks/create.md
Normal file
@@ -0,0 +1 @@
|
||||
# Crea tu fork
|
||||
1
docs/es/forks/update.md
Normal file
1
docs/es/forks/update.md
Normal file
@@ -0,0 +1 @@
|
||||
# Manten tu fork actualizado
|
||||
42
docs/es/installation/README.md
Normal file
42
docs/es/installation/README.md
Normal file
@@ -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`.
|
||||
1
docs/es/open_source/code_of_conduct.md
Normal file
1
docs/es/open_source/code_of_conduct.md
Normal file
@@ -0,0 +1 @@
|
||||
# Código de conducta
|
||||
1
docs/es/open_source/contributing.md
Normal file
1
docs/es/open_source/contributing.md
Normal file
@@ -0,0 +1 @@
|
||||
# Contribuciones
|
||||
1
docs/es/open_source/conventions.md
Normal file
1
docs/es/open_source/conventions.md
Normal file
@@ -0,0 +1 @@
|
||||
# Linters y convenciones
|
||||
1
docs/es/open_source/testing.md
Normal file
1
docs/es/open_source/testing.md
Normal file
@@ -0,0 +1 @@
|
||||
# Tests
|
||||
1
docs/es/recomendations/README.md
Normal file
1
docs/es/recomendations/README.md
Normal file
@@ -0,0 +1 @@
|
||||
# Recomendaciones
|
||||
1
docs/es/servers/README.md
Normal file
1
docs/es/servers/README.md
Normal file
@@ -0,0 +1 @@
|
||||
# Servidores de prueba y producción
|
||||
Reference in New Issue
Block a user