diff options
| -rw-r--r-- | docs/developers/index.md | 18 | ||||
| -rw-r--r-- | es/docs/developers/index.md | 80 |
2 files changed, 89 insertions, 9 deletions
diff --git a/docs/developers/index.md b/docs/developers/index.md index f1167a22b..bcf74be16 100644 --- a/docs/developers/index.md +++ b/docs/developers/index.md @@ -16,10 +16,10 @@ title: For developers reasons, we recommend the use of [Varnish](https://www.varnish-cache.org). * To help you understand what the code is doing, read this [high-level - overview]({{ site.baseurl }}docs/developers/overview/), which includes a diagram of + overview]({{ page.baseurl }}/docs/developers/overview/), which includes a diagram of the models and how they are related. -* See the [API documentation]({{ site.baseurl }}docs/developers/api/) for how to get +* See the [API documentation]({{ page.baseurl }}/docs/developers/api/) for how to get data into or out of Alaveteli. * If you need to change or add strings in the interface, see our [guidelines @@ -40,23 +40,23 @@ title: For developers * Installing the software is a little involved, though it's getting easier. If you stick to Debian or Ubuntu, it should be possible to get a running version within a few hours. If you've got your own server, run the - [installation script]({{ site.baseurl }}docs/installing/script/), or follow the + [installation script]({{ page.baseurl }}/docs/installing/script/), or follow the instructions for a - [manual installation]({{ site.baseurl }}docs/installing/manual_install/). - Alternatively, there's an [Alaveteli EC2 AMI]({{ site.baseurl }}docs/installing/ami/) + [manual installation]({{ page.baseurl }}/docs/installing/manual_install/). + Alternatively, there's an [Alaveteli EC2 AMI]({{ page.baseurl }}/docs/installing/ami/) that might help you get up and running quickly. - [Get in touch]({{ site.baseurl }}community/) on the project mailing list or IRC + [Get in touch]({{ page.baseurl }}/community/) on the project mailing list or IRC for help. * A standard initial step for customising your deployment is [writing a - theme]({{ site.baseurl }}docs/customising/themes/). **If you only read one thing, + theme]({{ page.baseurl }}/docs/customising/themes/). **If you only read one thing, it should be this!** * Like many Ruby on Rails sites, the software is not hugely performant (see [these notes about performance issues](https://github.com/mysociety/alaveteli/wiki/Performance-issues) gathered over time with WhatDoTheyKnow). The site will run on a server with 512MB RAM but at least 2GB is recommended. Deployment behind [Varnish](https://www.varnish-cache.org) is also fairly essential. See - [production server best practices]({{site.baseurl}}docs/running/server/) for more. + [production server best practices]({{ page.baseurl }}/docs/running/server/) for more. * There's a number of [proposals for enhancements](https://github.com/mysociety/alaveteli/wiki/Proposals-for-enhancements), such as more user-focused features, but see also... @@ -76,7 +76,7 @@ title: For developers used in the past](https://www.mysociety.org/2009/09/17/whatdotheyknow-growing-pains-and-ruby-memory-leaks/) might be useful. -* If you're coding on a mac, see these [MacOS X installation notes]({{ site.baseurl }}docs/installing/macos/). <!-- [[OS X Quickstart]] --> +* If you're coding on a mac, see these [MacOS X installation notes]({{ page.baseurl }}/docs/installing/macos/). <!-- [[OS X Quickstart]] --> * We try to adhere to similar good practice across all our projects: see [mysociety.github.io](http://mysociety.github.io/) for things like our diff --git a/es/docs/developers/index.md b/es/docs/developers/index.md new file mode 100644 index 000000000..3b7b0eee1 --- /dev/null +++ b/es/docs/developers/index.md @@ -0,0 +1,80 @@ +--- +layout: es/page +title: Para desarrolladores +--- + +# Información para desarrolladores + +<p class="lead"> + Alaveteli es un proyecto de código abierto. Los desarrolladores a tiempo completo de mySociety junto con desarrolladores de todo el mundo contribuyen de forma activa en la base del código. Estos enlaces y notas le ayudarán si también desea ayudar. +</p> + +* El software está escrito en **Ruby on Rails 3.x**. Soportamos postgresql como + sistema gestor de base de datos. Se necesita un agente de transferencia de correo (MTA) + configurado, como exim, para analizar los correos recibidos. Disponemos de servidores de + producción implementados en Debian (Squeeze y Wheezy) y en Ubuntu (12.04 LTS). Por motivos + de rendimiento, recomendamos el uso de [Varnish](https://www.varnish-cache.org). + +* Para ayudarle a entender qué hace el código, le recomendamos que lea esta [vista general + de alto nivel]({{ page.baseurl }}/docs/developers/overview/), que incluye un esquema de + los modelos y las relaciones entre ellos. + +* Consulte la [documentación del API]({{ page.baseurl }}/docs/developers/api/) para averiguar + cómo extraer e introducir datos en Alaveteli. + +* Si necesita modificar o añadir cadenas de texto en la interfaz, consulte nuestras [guías + de internacionalización](http://mysociety.github.io/internationalization.html), + donde encontrará notas sobre nuestro uso de `gettext`. + +* Utilizamos el [modelo de ramas de flujo + de git](http://nvie.com/posts/a-successful-git-branching-model/) con un pequeño cambio: + actualmente nuestra rama `develop` se denomina `rails-3-develop`, por lo que + la última versión de desarrollo siempre se halla en la + [rama + rails-3-develop](https://github.com/mysociety/alaveteli/tree/rails-3-develop). La última + versión estable se encuentra siempre en la [rama + maestra](https://github.com/mysociety/alaveteli). Si tiene previsto colaborar en + la elaboración del software, es posible que las [extensiones de flujo de + git](https://github.com/nvie/gitflow) le resultes prácticas. + +* La instalación del software es un tanto compleja, pero poco a poco se vuelve más sencilla. + Si utiliza Debian o Ubuntu, debería poder poner en funcionamiento una versión en varias horas. + Si dispone de su propio servidor, ejecute el + [script de instalación]({{ page.baseurl }}/docs/installing/script/) o siga las + indicaciones de + [instalación manual]({{ page.baseurl }}/docs/installing/manual_install/). + Alternativamente existe una [AMI EC2 de Alaveteli]({{ page.baseurl }}/docs/installing/ami/) + que puede ayudarle a ponerlo en marcha rápidamente. + [Póngase en contacto]({{ page.baseurl }}/community/) a través de la lista de correo del proyecto o mediante IRC + para obtener ayuda. + +* Un paso inicial estándar en la personalización de su implementación es la [escritura de un + tema]({{ page.baseurl }}/docs/customising/themes/). **Si solo va a leer un apartado, + ¡que sea este!** + +* Al igual que numerosos sitios construidos con Ruby on Rails, el software no proporciona un rendimiento muy elevado (consulte + [estas notas sobre los problemas de rendimiento](https://github.com/mysociety/alaveteli/wiki/Performance-issues) recopiladas a través del tiempo con + WhatDoTheyKnow). El sitio funcionará sobre un servidor con 512 MB de memoria RAM, pero se recomienda un mínimo + de 2 GB. La implementación detrás de [Varnish](https://www.varnish-cache.org) también resulta esencial. Consulte las + [buenas prácticas en el servidor de producción]({{ page.baseurl }}/docs/running/server/) para obtener más información. + +* Existe un conjunto de [proposiciones de mejora](https://github.com/mysociety/alaveteli/wiki/Proposals-for-enhancements), + tales como un mayor número de funcionalidades centradas en el usuario, pero consulte también... + +* ...las [publicaciones de github](https://github.com/mysociety/alaveteli/issues). Marcamos + las publicaciones con la etiqueta **suitable for volunteers** (adecuada para voluntarios) cuando creemos que + son especialmente adecuadas para quien busca una tarea relativamente pequeña a la que dedicarse. + +* Intentamos garantizar que cada modificación confirmada cuente con su publicación correspondiente en el gestor. + Así los registros de modificaciones se vuelven más sencillos, pues podemos reunir todos los cambios propios de + una actualización concreta respecto a un objetivo intermedio en el gestor de publicaciones, [como esta actualización + 0.4](https://github.com/mysociety/alaveteli/issues?milestone=7&state=closed). + +* Si experimenta problemas de memoria, consulte [esta publicación del blog sobre estrategias utilizadas + anteriormente](https://www.mysociety.org/2009/09/17/whatdotheyknow-growing-pains-and-ruby-memory-leaks/). + +* Si edita el código en un Mac, consulte estas [notas de instalación en MacOS X]({{ page.baseurl }}/docs/installing/macos/). <!-- [[OS X Quickstart]] --> + +* Intentamos seguir unas buenas prácticas similares en todos nuestros proyectos: visite + [mysociety.github.io](http://mysociety.github.io/) para obtener información sobre temas tales como nuestros + [estándares de código](http://mysociety.github.io/coding-standards.html). |