diff options
| -rw-r--r-- | docs/glossary.md | 15 | ||||
| -rw-r--r-- | docs/running/upgrading.md | 14 |
2 files changed, 16 insertions, 13 deletions
diff --git a/docs/glossary.md b/docs/glossary.md index 7a7c5d003..d35454cbf 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -510,12 +510,12 @@ Definitions <dd> We issue new <strong>releases</strong> of the Alaveteli code whenever key work (new features, improvements, bugfixes, and so on) have been added to - the core code. Releases are identified by three numbers: major, minor, and - — if necessary — a patch number. We recommend you always use - the latest version. The process is handled by the Alaveteli <strong>release - manager</strong>, who decides what changes are to be included in the - current release, and the cut-off date for the work. Currently this is - Alaveteli's lead developer at mySociety. + the core code. Releases are identified by their tag, which comprises two or + three numbers: major, minor, and — if necessary — a patch + number. We recommend you always use the latest version. The process is + handled by the Alaveteli <strong>release manager</strong>, who decides what + changes are to be included in the current release, and the cut-off date for + the work. Currently this is Alaveteli's lead developer at mySociety. <div class="more-info"> <p>More information:</p> <ul> @@ -524,7 +524,8 @@ Definitions <a href="https://github.com/mysociety/alaveteli/tree/master">master branch</a>. </li> <li> - See a <a href="https://github.com/mysociety/alaveteli/releases">list of all releases</a>. + See a <a href="https://github.com/mysociety/alaveteli/releases">list of all releases</a> + and their explicit tags. </li> <li> We try to coordinate releases with any active translation work too. diff --git a/docs/running/upgrading.md b/docs/running/upgrading.md index 611712bf6..2142bfd47 100644 --- a/docs/running/upgrading.md +++ b/docs/running/upgrading.md @@ -7,8 +7,9 @@ Upgrading Alaveteli <p class="lead"> Alaveteli is under active development — don't let the - version you're running get too far behind our latest release. This page - describes how to keep your site up-to-date + version you're running get too far behind our latest + <a href="{{site.baseurl}}docs/glossary/#release" class="glossary__link">release</a>. + This page describes how to keep your site up-to-date </p> ## Master branch contains the latest stable release @@ -16,9 +17,10 @@ Upgrading Alaveteli The developer team policy is that the `master` branch in git should always contain the latest stable release -- so you'll be up to date if you pull from the `master` branch. However, on your -<a href="{{site.baseurl}}docs/glossary/#production" class="glossary">production site</a>, -you should know precisely what version you're running, and deploy Alaveteli -from a [*specific* release tag](https://github.com/mysociety/alaveteli/releases). +<a href="{{site.baseurl}}docs/glossary/#production" class="glossary">production +site</a>, you should know precisely what version you're running, and deploy +Alaveteli from a [*specific* release +tag](https://github.com/mysociety/alaveteli/releases). Upgrading may just require pulling in the latest code -- but it may also require other changes ("further action"). For this reason, for anything other than a @@ -32,7 +34,7 @@ other changes that might be needed to make the new code work. * If you're using Capistrano for deployment, simply [deploy the code]({{site.baseurl}}docs/installing/deploy/#usage): set the repo and branch in `deploy.yml` to be the version you want. - We recommend you set this to the explicit branch name (for example, + We recommend you set this to the explicit tag name (for example, `0.18`, and not `master`) so there's no risk of you accidentally deploying a new version before you're aware it's been released. * otherwise, you can simply upgrade by running `git pull` |