From 1326da1ebfcc28b2dd898ff03860f52468755d44 Mon Sep 17 00:00:00 2001 From: Louise Crow Date: Tue, 17 Jun 2014 15:53:15 +0100 Subject: Fix broken link --- docs/developers/directory_structure.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/developers') diff --git a/docs/developers/directory_structure.md b/docs/developers/directory_structure.md index e073a96ce..3e4500941 100644 --- a/docs/developers/directory_structure.md +++ b/docs/developers/directory_structure.md @@ -215,7 +215,7 @@ website](http://guides.rubyonrails.org/getting_started.html).

tests

- Alaveteli's test suite runs under spec. + Alaveteli's test suite runs under rspec.

-- cgit v1.2.3 From 13fab33898e6a52fbdb0900eea3a722dcedd7527 Mon Sep 17 00:00:00 2001 From: Louise Crow Date: Tue, 17 Jun 2014 16:04:14 +0100 Subject: Add trailing slashes to internal URLs. --- docs/developers/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/developers') diff --git a/docs/developers/index.md b/docs/developers/index.md index f98261a77..7f1039d8a 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]({{ 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,7 +49,7 @@ 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 @@ -77,7 +77,7 @@ title: For developers past](http://www.mysociety.org/2009/09/17/whatdotheyknow-growing-pains-and-rub y-memory-leaks/) might be useful. -* If you're coding on a mac, see these [MacOS X installation notes]({{ site.baseurl }}docs/installing/macos). +* If you're coding on a mac, see these [MacOS X installation notes]({{ site.baseurl }}docs/installing/macos/). * We try to adhere to similar good practice across all our projects: see [mysociety.github.io](http://mysociety.github.io/) for things like our -- cgit v1.2.3 From cfab41cbd7a6a8ef27da6743b5f554d43a51ef96 Mon Sep 17 00:00:00 2001 From: Louise Crow Date: Tue, 17 Jun 2014 16:13:47 +0100 Subject: Use https for mySociety --- docs/developers/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/developers') diff --git a/docs/developers/index.md b/docs/developers/index.md index 7f1039d8a..f8367a4ea 100644 --- a/docs/developers/index.md +++ b/docs/developers/index.md @@ -74,7 +74,7 @@ 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 + past](https://www.mysociety.org/2009/09/17/whatdotheyknow-growing-pains-and-rub y-memory-leaks/) might be useful. * If you're coding on a mac, see these [MacOS X installation notes]({{ site.baseurl }}docs/installing/macos/). -- cgit v1.2.3 From 50a76fabf38fac4ccceb1f129ba443ce27f76cec Mon Sep 17 00:00:00 2001 From: Louise Crow Date: Tue, 17 Jun 2014 16:14:13 +0100 Subject: Fix ref to these docs. --- docs/developers/directory_structure.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/developers') diff --git a/docs/developers/directory_structure.md b/docs/developers/directory_structure.md index 3e4500941..5d0d55642 100644 --- a/docs/developers/directory_structure.md +++ b/docs/developers/directory_structure.md @@ -140,7 +140,7 @@ website](http://guides.rubyonrails.org/getting_started.html).

documentation

These are technical notes. This is in addition to the core documentation — which + href="http://code.alaveteli.org/docs/">core documentation — which you are reading now — which is actually stored in the git repository in the gh-pages branch, and published as GitHub pages. -- cgit v1.2.3 From 307521f2e07155fbe44093a4235700bb84cbdeb4 Mon Sep 17 00:00:00 2001 From: Louise Crow Date: Tue, 17 Jun 2014 16:41:04 +0100 Subject: Add trailing slashes --- docs/developers/directory_structure.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/developers') diff --git a/docs/developers/directory_structure.md b/docs/developers/directory_structure.md index 5d0d55642..9dbe06789 100644 --- a/docs/developers/directory_structure.md +++ b/docs/developers/directory_structure.md @@ -13,7 +13,7 @@ directories.

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/). -- cgit v1.2.3 From 01b205851eaea613f5469ef2e4f48f26df0853e4 Mon Sep 17 00:00:00 2001 From: Louise Crow Date: Tue, 17 Jun 2014 16:41:40 +0100 Subject: Fix duplicate anchor --- docs/developers/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/developers') diff --git a/docs/developers/overview.md b/docs/developers/overview.md index 8193528ce..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 - + This schema for the Rails models was generated from the code on 19 Dec 2012 using [Railroad](http://railroad.rubyforge.org/). -- cgit v1.2.3 From 3956530a9ab80dc655e4bd5047dab5ba698dfb31 Mon Sep 17 00:00:00 2001 From: Louise Crow Date: Tue, 17 Jun 2014 17:01:06 +0100 Subject: Restore links split by linebreaks --- docs/developers/index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'docs/developers') diff --git a/docs/developers/index.md b/docs/developers/index.md index f8367a4ea..4a39ceaa3 100644 --- a/docs/developers/index.md +++ b/docs/developers/index.md @@ -74,8 +74,7 @@ title: For developers * If you're experiencing memory issues, [this blog post about some strategies used in the - past](https://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/). -- cgit v1.2.3 From 3929726b113240a78e9adf77a9edcb185e8ff4ab Mon Sep 17 00:00:00 2001 From: Louise Crow Date: Thu, 19 Jun 2014 16:51:52 +0100 Subject: We don't support Lucid anymore . Since https://github.com/mysociety/alaveteli/commit/2e33b1ac860e237ef31b862f80aa7d2b1dcf9c57 --- docs/developers/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/developers') diff --git a/docs/developers/index.md b/docs/developers/index.md index 4a39ceaa3..9d1869246 100644 --- a/docs/developers/index.md +++ b/docs/developers/index.md @@ -12,7 +12,7 @@ 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 -- cgit v1.2.3