diff options
Diffstat (limited to 'docs/developers')
| -rw-r--r-- | docs/developers/directory_structure.md | 6 | ||||
| -rw-r--r-- | docs/developers/index.md | 17 | ||||
| -rw-r--r-- | docs/developers/overview.md | 2 |
3 files changed, 12 insertions, 13 deletions
diff --git a/docs/developers/directory_structure.md b/docs/developers/directory_structure.md index e073a96ce..9dbe06789 100644 --- a/docs/developers/directory_structure.md +++ b/docs/developers/directory_structure.md @@ -13,7 +13,7 @@ directories.</p> Alaveteli -- this is really more useful if you're a developer planning on making more substantive changes to the code. You don't need to be familiar with Ruby to install or make basic [customisations to your -installation](/docs/customising). +installation](/docs/customising/). <!-- (and if you do, remember to read the page about [feeding your changes back](/feeding-back)).--> @@ -140,7 +140,7 @@ website](http://guides.rubyonrails.org/getting_started.html). <p><em>documentation</em></p> <p> These are technical notes. This is in addition to the <a - href="http://code.fixmystreet.com">core documentation</a> — which + href="http://code.alaveteli.org/docs/">core documentation</a> — which you are reading now — which is actually stored in the git repository in the <code>gh-pages</code> branch, and published as GitHub pages. @@ -215,7 +215,7 @@ website](http://guides.rubyonrails.org/getting_started.html). <dd> <p><em>tests</em></p> <p> - Alaveteli's test suite runs under <a href="TODO">spec</a>. + Alaveteli's test suite runs under <a href="http://rspec.info/">rspec</a>. </p> </dd> <dt> diff --git a/docs/developers/index.md b/docs/developers/index.md index f98261a77..22390f236 100644 --- a/docs/developers/index.md +++ b/docs/developers/index.md @@ -12,14 +12,14 @@ title: For developers * The software is written in **Ruby on Rails 3.x**. We support postgresql as the backend database. A configured mail transfer agent (MTA) like exim, postfix or sendmail is necessary to parse incoming emails. We have production - sites deployed on Debian (Squeeze and Wheezy) and Ubuntu (10.04 and 12.04 LTS). For performance + sites deployed on Debian (Squeeze and Wheezy) and Ubuntu (12.04 LTS). For performance 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]({{ site.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]({{ site.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 @@ -49,14 +49,14 @@ title: For developers 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]({{ site.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 - some notes about [[performance issues]] gathered over time with + [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]] for more. + [production server best practices]({{site.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... @@ -74,10 +74,9 @@ title: For developers * If you're experiencing memory issues, [this blog post about some strategies used in the - past](http://www.mysociety.org/2009/09/17/whatdotheyknow-growing-pains-and-rub - y-memory-leaks/) might be useful. + 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]({{ site.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/docs/developers/overview.md b/docs/developers/overview.md index ca2d27985..af312f997 100644 --- a/docs/developers/overview.md +++ b/docs/developers/overview.md @@ -43,7 +43,7 @@ ensure they have an envelope-from header set (to combat spam). ## Schema diagram -<a name="schema-diagram" href="{{ site.baseurl }}images/railsmodels.png"><img src="{{ site.baseurl }}images/railsmodels.png"></a> +<a href="{{ site.baseurl }}assets/img/railsmodels.png"><img src="{{ site.baseurl }}assets/img/railsmodels.png"></a> This schema for the Rails models was generated from the code on 19 Dec 2012 using [Railroad](http://railroad.rubyforge.org/). |