diff --git a/docs/en/customization/introduction.md b/docs/en/customization/introduction.md index 0959ad299..4d04132d8 100644 --- a/docs/en/customization/introduction.md +++ b/docs/en/customization/introduction.md @@ -1,8 +1,10 @@ # Customization -You can modify your own Consul Democracy to have your custom visual style, but first you'll have to [create your own fork from](../getting_started/create.md). +You can modify your own Consul Democracy to adapt it to the visual style of your institution. To do so, first you'll have to [create your own fork](../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 Democracy's main repository, without having conflicts on code merging or risking loosing your customization changes. We try to make Consul Democracy as vanilla as possible to help other developers onboard the codebase. +The main principle to follow when customizing Consul Democracy is doing so in a way that custom changes are isolated so, when updating to a new version of Consul Democracy, it'll be easier to check which code belongs to the application and how the code changed in the new version. Otherwise, it'll be very hard to adapt your custom changes to the new version. + +For that purpose, Consul Democracy includes custom folders so you rarely have to touch the original application files. ## Special Folders and Files @@ -41,6 +43,8 @@ There are also files where you can apply some customizations: * `config/environments/custom/test.rb` * `Gemfile_custom` +Using these files, you will be able to customize [translations](translations.md), [images](images.md), [CSS](css.md), [JavaScript](javascript.md), [HTML views](views.md), any Ruby code like [models](models.md), [controllers](controllers.md), [components](components.md) or [other Ruby classes](ruby.md), [gems](gems.md), [application configuration](application.md), [routes](routes.md) and [tests](tests.md). + ## Running the tests When customizing the code, it is **very important** that all the tests in your test suite are still passing. If not, there will be issues when upgrading to a new version of Consul Democracy (or even when updating the custom changes) that won't be detected until the code is running on production. Consul Democracy includes more than 6000 tests checking the way the application behaves; without them, it'd be impossible to make sure that new code doesn't break any existing behavior. diff --git a/docs/es/customization/introduction.md b/docs/es/customization/introduction.md index d92b9f095..2057946c9 100644 --- a/docs/es/customization/introduction.md +++ b/docs/es/customization/introduction.md @@ -1,12 +1,14 @@ -# Personalización +# Personalización de código -Puedes modificar Consul Democracy y ponerle tu propia imagen, para esto debes primero [crear tu propio fork](../getting_started/create.md). +Puedes modificar Consul Democracy y adaptarlo a la imagen y a la manera de trabajar de tu institución. 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 Democracy sea una aplicación Ruby on Rails lo más plain vanilla posible para facilitar el acceso de nuevas desarrolladoras. +La principal regla a seguir al personalizar código de Consul Democracy es hacerlo de manera que los cambios personalizados estén separados del resto del código. De esta forma, al actualizar a una nueva versión de Consul Democracy, será más fácil comprobar qué código pertenece a la aplicación y cómo cambia el código en la nueva versión. En caso contrario, será muy difícil adaptar tus cambios personalizados a la nueva versión. + +Con este fin, Consul Democracy incluye directorios "custom" para que rara vez tengas que cambiar los archivos originales. ## Ficheros y directorios especiales -Para adaptar tu fork de Consul Democracy puedes utilizar alguno de los directorios `custom` que están en las rutas: +Para adaptar tu "fork" de Consul Democracy, puedes utilizar alguno de los directorios `custom` que están en las rutas: * `app/assets/images/custom/` * `app/assets/javascripts/custom/` @@ -41,6 +43,8 @@ Aparte de estos directorios, también puedes utilizar los siguientes ficheros: * `config/environments/custom/test.rb` * `Gemfile_custom` +Utilizando estos ficheros, podrás personalizar [traducciones](translations.md), [imágenes](images.md), [CSS](css.md), [JavaScript](javascript.md), [vistas HTML](views.md), cualquier código de Ruby como [modelos](models.md), [controladores](controllers.md), [componentes](components.md) u [otras clases de Ruby](ruby.md), [gemas](gems.md), [configuración de la aplicación](application.md), [rutas](routes.md) y [tests](tests.md). + ## Ejecutar los tests Al personalizar el código, es **muy importante** que todos los tests de la aplicación sigan pasando. En caso contrario, habrá fallos al actualizar a una nueva versión de Consul Democracy (o incluso al actualizar los cambios personalizados) y estos fallos no serán detectados hasta que el código esté ya ejecutándose en producción. Consul Democracy incluye más de 6000 tests que comprueban la manera en que se comporta la aplicación; sin ellos, sería imposible asegurarse de que el código nuevo no rompe comportamientos existentes.