Merge pull request #89 from rockandror/fix-docs
Improve texts and fix links
This commit is contained in:
Javier Martín
@@ -61,7 +61,7 @@
|
||||
|
||||
* [Instalación](es/installation/introduction.md)
|
||||
* [Instalación local](es/installation/local_installation.md)
|
||||
* [Prerrequisitos](en/installation/prerequisitos.md)
|
||||
* [Prerrequisitos](es/installation/prerequisites.md)
|
||||
* [Ubuntu Linux](es/installation/ubuntu.md)
|
||||
* [Debian Linux](es/installation/debian.md)
|
||||
* [MacOS](es/installation/macos.md)
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Customization
|
||||
|
||||
You can modify your own CONSUL to have your custom visual style, but first you'll have to [create your own fork from](forks/create.md).
|
||||
You can modify your own CONSUL to have your custom visual style, but first you'll have to [create your own fork from](../getting_started/create.md).
|
||||
|
||||
We've created an specific structure where you can overwrite and customize the application in a way that will let you keep updating it from CONSUL's main repository, without having conflicts on code merging or risking loosing your customization changes. We try to make CONSUL as vanilla as possible to help other developers onboard the codebase.
|
||||
|
||||
|
||||
@@ -77,5 +77,4 @@ You will find different functionalities with the names of the different particip
|
||||
|
||||
### More information and detailed documentation
|
||||
|
||||
These options above will allow you to have a basic version of CONSUL to start using. We recommend that you access the [CONSUL Documentation and Guides](../getting_started/documentation_and_guides.md) section where you can find more detailed documentation.
|
||||
|
||||
These options above will allow you to have a basic version of CONSUL to start using. We recommend that you access the [CONSUL Documentation and Guides](documentation_and_guides.md) section where you can find more detailed documentation.
|
||||
|
||||
@@ -44,13 +44,15 @@ Ruby versions packaged in official repositories are not suitable to work with co
|
||||
|
||||
The preferred method is via rvm:
|
||||
|
||||
### As a local user
|
||||
|
||||
```
|
||||
command curl -sSL https://rvm.io/mpapis.asc | gpg --import -
|
||||
command curl -sSL https://rvm.io/pkuczynski.asc | gpg --import -
|
||||
curl -L https://get.rvm.io | bash -s stable
|
||||
```
|
||||
|
||||
then add rvm script source to user's bash (/root/.bashrc)
|
||||
then add rvm script source to user's bash (source /root/.bashrc) (this step is only necessary if you can't execute the rvm command)
|
||||
|
||||
```
|
||||
[[ -s /usr/local/rvm/scripts/rvm ]] && source /usr/local/rvm/scripts/rvm
|
||||
@@ -165,4 +167,12 @@ chromedriver --version
|
||||
|
||||
You should receive an output with the latest version of ChromeDriver. If that's the case, you're good to go!
|
||||
|
||||
> Now you're ready to go get Consul [installed](local_installation.md)!!
|
||||
If you are using an Arch-based distro, installing `chromium` from the `extra` repository should be sufficient.
|
||||
|
||||
You also have the option of just installing ChromeDriver from AUR. If you use `pacaur`, run the following command:
|
||||
|
||||
```bash
|
||||
pacaur -S chromedriver
|
||||
```
|
||||
|
||||
Now you're ready to go get Consul [installed](local_installation.md)!!
|
||||
|
||||
@@ -14,11 +14,11 @@ In this example we used [Mailgun](https://www.mailgun.com/).
|
||||
|
||||
## Domain configuration
|
||||
* Go to the Domains section:
|
||||
|
||||
|
||||
|
||||
* Since you don't have a domain yet, you should click in the sandbox that is already created;
|
||||
* Remember the next credentials:
|
||||
|
||||
|
||||
|
||||
## Consul mailing configuration for development environment
|
||||
* Go to `config/environments/development.rb` file;
|
||||
@@ -40,7 +40,7 @@ In this example we used [Mailgun](https://www.mailgun.com/).
|
||||
```
|
||||
* Fill, `address`, `domain`, `user_name`, `password` with your information. The file would look like:
|
||||
|
||||
|
||||
|
||||
|
||||
## Consul mailing configuration for production environment
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Using Docker for local development
|
||||
|
||||
You can use Docker to have a local CONSUL installation for development if:
|
||||
- You're having troubles having [prerequisites](prerequisites) installed.
|
||||
- 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.
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ You can find the installation instructions at: [brew.sh](http://brew.sh)
|
||||
|
||||
To install *git* you'll first need to install *Xcode* (download it from the Mac App Store) and its *Xcode Command Line Tools* (you can install them from the Xcode's app menu)
|
||||
|
||||
## Git
|
||||
## Git and Github
|
||||
|
||||
You can download git from: [git-scm.com/download/mac](https://git-scm.com/download/mac)
|
||||
|
||||
@@ -20,6 +20,8 @@ OS X already comes with a preinstalled Ruby version, but it's quite old and we n
|
||||
|
||||
[github.com/rbenv/rbenv](https://github.com/rbenv/rbenv)
|
||||
|
||||
Then install Ruby version 2.4.9
|
||||
|
||||
## Bundler
|
||||
|
||||
```
|
||||
@@ -106,4 +108,4 @@ brew install chromedriver
|
||||
brew install imagemagick
|
||||
```
|
||||
|
||||
> Now you're ready to go get Consul [installed](../local_installation.html)!!
|
||||
Now that we have all the dependencies installed we can download the project: [installed](local_installation.md)
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
# Windows
|
||||
|
||||
Windows is not yet officially supported. Please install [Virtual Box](https://www.virtualbox.org/) to setup a virtual machine in [Linux](prerequisites).
|
||||
Windows is not yet officially supported. Please install [Virtual Box](https://www.virtualbox.org/) to setup a virtual machine in [Linux](prerequisites.md).
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Personalización
|
||||
|
||||
Puedes modificar CONSUL y ponerle tu propia imagen, para esto debes primero [crear tu propio fork](forks/create.md).
|
||||
Puedes modificar CONSUL y ponerle tu propia imagen, para esto debes primero [crear tu propio fork](../getting_started/create.md).
|
||||
|
||||
Hemos creado una estructura específica donde puedes sobreescribir y personalizar la aplicación para que puedas actualizar sin que tengas problemas al hacer merge y se sobreescriban por error tus cambios. Intentamos que CONSUL sea una aplicación Ruby on Rails lo más plain vanilla posible para facilitar el acceso de nuevas desarrolladoras.
|
||||
|
||||
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
3. Si se te solicita acceso a tu cuenta de Github por parte de Travis CIaccess, marca la organización o usuario bajo el cual reside tu fork de Consul y haz click en el botón "**Authorize travis-ci**".
|
||||
|
||||
4. Visit [your travis profile](https://travis-ci.org/profile/) and enable Travis for your Consul fork on the repositories list that will appear.
|
||||
4. Visita [tu perfil en Travis](https://travis-ci.org/profile/) y habilita Travis para tu fork de Consul en el listado de repositorios.
|
||||
|
||||
5. Click on the cog button next to your recenlty enabled consul repository to check the builds.
|
||||
5. Haz click en el icono de un piñón a la derecha del repositorio para ver las builds.
|
||||
|
||||
6. Try it out by creating a test Pull Request against your fork (editing a .md file should do the trick)
|
||||
6. Comprueba que todo está bien configurado creando un Pull Request de prueba (editar un simple fichero .md podría servir).
|
||||
|
||||
@@ -10,7 +10,7 @@ El repositorio git de Consul está hospedado en Github.com, recomendamos lo uses
|
||||
|
||||
4. [Clona el repositorio de tu fork](https://help.github.com/articles/cloning-a-repository/) en tu ordenador
|
||||
|
||||
****ADVERTENCIA IMPORTANTE**: No hagas un fork de `https://github.com/AyuntamientoMadrid/consul`, es una equivocación infrecuente que conlleva múltiples y graves problemas.
|
||||
****ADVERTENCIA IMPORTANTE**: No hagas un fork de `https://github.com/AyuntamientoMadrid/consul`, es una equivocación frecuente que conlleva múltiples y graves problemas.
|
||||
|
||||
## ¿Porqué hacer el código público?
|
||||
|
||||
|
||||
@@ -63,6 +63,6 @@ B. Se abre una ventana del editor que tengas configurado en git, mostrando el me
|
||||
|
||||
C. Recibes mensajes de error de git junto con un `Automatic merge failed; fix conflicts and then commit the result.`. Esto significa que se han encontrado conflictos entre los cambios en tu código y los cambios que se realizaron en CONSUL desde la última vez que actualizaste tu fork. Esta es una de las principales razones para intentar mantener tu fork lo más al dia posible, realizando este proceso al menos mensualmente. Resuelve manualmente los conflictos para terminar el merge y haz un commit.
|
||||
|
||||
Now you can just simply push **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.
|
||||
Ahora simplemente sube la rama **upstream** a github y crea un Pull Request, así podrás ver de manera sencilla todos los cambios que se han realizado en el repositorio y verás también como arranca la suite de tests.
|
||||
|
||||
Recuerda que siempre puedes comprobar rápidamente los cambios que tienes pendientes de integrar de CONSUL a tu fork sustituyendo **your_org_name** en la url: https://github.com/your_org_name/consul/compare/master...consul:master
|
||||
|
||||
@@ -68,4 +68,4 @@ Por defecto encontrarás en CONSUL diferentes formas de participación para los
|
||||
Encontrarás diversas funcionalidades con los nombres de los diferentes canales de participación "Debates", "Propuestas", "Votaciones", "Legislación Colaborativa" y "Presupuestos Participativos". Puedes desactivar cualquiera de las funcionalidades y dejará de mostrarse en tu instalación de CONSUL.
|
||||
|
||||
### Más información y documentación detallada
|
||||
Estas opciones anteriores te permitirán tener una versión básica de CONSUL que empezar a usar. Te recomendamos acceder a la sección [Documentación y guías sobre CONSUL](../getting_started/consul_guides.md) donde podrás encontrar más documentación detallada.
|
||||
Estas opciones anteriores te permitirán tener una versión básica de CONSUL que empezar a usar. Te recomendamos acceder a la sección [Documentación y guías sobre CONSUL](documentation_and_guides.md) donde podrás encontrar más documentación detallada.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## Super usuario
|
||||
|
||||
El programa 'sudo' no viene instalado en Debian por defecto. Su instalación y configuración es posible, se puede encontrar informacion al respecto [aquí](https://wiki.debian.org/es/sudo). Pero no lo recomendamos porque puede causar otros problemas. Recomendamos que se ejecuten las siguientes instrucciones como un super usuario, así que asegúrate de que la primera instrucción que ejecutes sea:
|
||||
El programa 'sudo' no viene instalado en Debian por defecto. Su instalación y configuración es posible, se puede encontrar información al respecto [aquí](https://wiki.debian.org/es/sudo). Pero no lo recomendamos porque puede causar otros problemas. Recomendamos que se ejecuten las siguientes instrucciones como un super usuario, así que asegúrate de que la primera instrucción que ejecutes sea:
|
||||
|
||||
```
|
||||
su
|
||||
@@ -39,7 +39,7 @@ apt-get install curl
|
||||
|
||||
## Ruby
|
||||
|
||||
Las versiones de Ruby versions empaquetadas en repositorios oficiales no son aptas para trabajar con consul (al menos Debian 7 y 8), así que debemos instalar manualmente.
|
||||
Las versiones de Ruby empaquetadas en repositorios oficiales no son aptas para trabajar con consul, así que debemos instalar manualmente.
|
||||
|
||||
El método recomendado es via rvm:
|
||||
|
||||
@@ -51,7 +51,7 @@ command curl -sSL https://rvm.io/pkuczynski.asc | gpg --import -
|
||||
curl -L https://get.rvm.io | bash -s stable
|
||||
```
|
||||
|
||||
despues añadimos el script rvm a nuestro bash (~/.bashrc) (este paso sólo es necesario si no puedes ejecutar el comando rvm)
|
||||
después añadimos el script rvm a nuestro bash (source /root/.bashrc) (este paso sólo es necesario si no puedes ejecutar el comando rvm)
|
||||
|
||||
```
|
||||
[[ -s /usr/local/rvm/scripts/rvm ]] && source /usr/local/rvm/scripts/rvm
|
||||
@@ -71,7 +71,7 @@ rvm install 2.4.9
|
||||
|
||||
## Bundler
|
||||
|
||||
lo instalammos usando
|
||||
lo instalamos usando
|
||||
|
||||
```
|
||||
gem install rubygems-bundler
|
||||
@@ -172,4 +172,4 @@ También tienes la opción de solo instalar ChromeDriver desde AUR. Si usas `pac
|
||||
pacaur -S chromedriver
|
||||
```
|
||||
|
||||
> Ya estás listo para [instalar Consul](local_installation.md)!!
|
||||
Ya estás listo para [instalar Consul](local_installation.md)!!
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Usando Docker para desarrollo en local
|
||||
|
||||
Puedes usar Docker para tener una instalación local de CONSUL si:
|
||||
- Estás teniendo problemas para instalar los [prerrequisitos](prerequisites) correctamente.
|
||||
- Estás teniendo problemas para instalar los [prerrequisitos](prerequisites.md) correctamente.
|
||||
- Quieres tener una instalación local rápidamente para probar o hacer una demo.
|
||||
- Prefieres no interferir con instalaciones de apps Rails existentes.
|
||||
|
||||
@@ -112,7 +112,7 @@ Deberías obtener algo similar a:
|
||||
Pendiente de ser completado... ¡Se agradecen las Contribuciones!
|
||||
|
||||
|
||||
## ¿Habiendo problemas?
|
||||
## ¿Tienes problemas?
|
||||
Ejecute los comandos en el **directorio de CONSUL**, para borrar todas las imágenes y contenedores anteriores del Docker de CONSUL. Luego, reinicie el [proceso de instalación](#instalación) de Docker:
|
||||
|
||||
1. Quitar todas las imágenes de CONSUL:
|
||||
|
||||
@@ -108,31 +108,4 @@ brew install chromedriver
|
||||
brew install imagemagick
|
||||
```
|
||||
|
||||
## Clonar el repositorio
|
||||
|
||||
Ahora que ya tenemos todas las dependencias instalado podemos bajarnos el proyecto:
|
||||
|
||||
```
|
||||
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
|
||||
```
|
||||
|
||||
Ahora copia en `database.yml` el usuario y la contraseña que pusiste para *consul*. Cuando ya lo hayas hecho:
|
||||
|
||||
```
|
||||
rake db:create
|
||||
rake db:setup
|
||||
rake db:dev_seed
|
||||
RAILS_ENV=test bin/rake db:setup
|
||||
```
|
||||
|
||||
Para ejecutar los tests:
|
||||
|
||||
```
|
||||
bundle exec rspec
|
||||
```
|
||||
|
||||
> Ya estás listo para [instalar Consul](../local_installation.html)!!
|
||||
Ahora que ya tenemos todas las dependencias instalado podemos bajarnos el proyecto: [instalar Consul](local_installation.md)
|
||||
|
||||
@@ -4,4 +4,3 @@
|
||||
* [Debian Linux](debian.md)
|
||||
* [MacOS](macos.md)
|
||||
* [Windows](windows.md)
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ sudo apt install git
|
||||
|
||||
## Ruby
|
||||
|
||||
Las versiones de Ruby versions empaquetadas en repositorios oficiales no son aptas para trabajar con CONSUL, así que debemos instalarlo manualmente.
|
||||
Las versiones de Ruby empaquetadas en repositorios oficiales no son aptas para trabajar con CONSUL, así que debemos instalarlo manualmente.
|
||||
|
||||
En primer lugar, necesitamos los siguiente paquetes para poder instalar Ruby:
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
# Windows
|
||||
|
||||
De momento Windows no es un sistema operativo compatible. Por favor instale [Virtual Box](https://www.virtualbox.org/) para crear una máquina virtual en [Linux](prerequisites).
|
||||
De momento Windows no es un sistema operativo compatible. Por favor instale [Virtual Box](https://www.virtualbox.org/) para crear una máquina virtual en [Linux](prerequisites.md).
|
||||
|
||||
Reference in New Issue
Block a user