diff options
| author | Matthew Somerville <matthew-github@dracos.co.uk> | 2018-09-27 15:33:43 +0100 |
|---|---|---|
| committer | Sam Pearson <sam@sgp.me.uk> | 2018-09-28 14:35:46 +0100 |
| commit | 43845231cccbea8abd37930c480ed46349ca1de3 (patch) | |
| tree | da7ff99bab403cc4b2ee4cdd129a20d74cc2e5a3 /docs | |
| parent | e7d4b3c7e85ee3840b4b089044e3cbe9ac690c8e (diff) | |
[Docs] Update docs about docs.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.md | 10 | ||||
| -rw-r--r-- | docs/directory_structure.md | 2 |
2 files changed, 6 insertions, 6 deletions
diff --git a/docs/README.md b/docs/README.md index d1b4897d0..9f4398ba3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,9 +1,9 @@ fixmystreet.org =============== -The gh-pages branch is [fixmystreet.org](https://fixmystreet.org), the -Jekyll-based static site running on GitHub Pages that is the documentation for -setting up / running the FixMyStreet platform. +This directory is [fixmystreet.org](https://fixmystreet.org), the Jekyll-based +static site running on GitHub Pages that is the documentation for setting up / +running the FixMyStreet platform. ## Installation @@ -12,8 +12,8 @@ The site is built by Jekyll. We manage our Ruby gem dependencies via already have it. Then you need to… ``` -git clone --recursive -b gh-pages https://github.com/mysociety/fixmystreet fixmystreet-pages -cd fixmystreet-pages +git clone --recursive https://github.com/mysociety/fixmystreet +cd fixmystreet/docs bundle install --deployment ``` diff --git a/docs/directory_structure.md b/docs/directory_structure.md index 5b9e8077d..a8b8955d5 100644 --- a/docs/directory_structure.md +++ b/docs/directory_structure.md @@ -112,7 +112,7 @@ you're doing is [customising your installation](/customising). <p> These are technical notes. This is in addition to the <a href="https://fixmystreet.org/">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 + which is actually stored in the git repository in the <code>docs</code> directory, and published as GitHub pages. </p> </dd> |