The GitHub Format Markdown style of Markdown links breaks in some Markdown renderers. Change to the style now used in all other files.
Signed-off-by: Stephen Finucane <stephen.finuc...@intel.com> --- docs/index.md | 18 ++++++++++-------- docs/installation.md | 10 ++++------ 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/index.md b/docs/index.md index ca4073f..8175eda 100644 --- a/docs/index.md +++ b/docs/index.md @@ -22,7 +22,7 @@ The latest version of Patchwork is available with git. To download: $ git clone git://github.com/getpatchwork/patchwork -Patchwork is distributed under the [GNU General Public License]. +Patchwork is distributed under the [GNU General Public License][ref-gpl]. # Design @@ -53,14 +53,16 @@ command-line client for patchwork, or directly to the XML RPC interface. # Getting Started -You should check out the [installation] and [development] guides for -information on how to get to work with patchwork. +You should check out the [deployment][doc-deployment] and +[development][doc-development] guides for information on how to configure +patchwork for production and development environments, respectively. # Support -All questions and contributions should be sent to the [patchwork mailing list]. +All questions and contributions should be sent to the +[patchwork mailing list][ref-pw-ml]. -[GNU General Public License]: http://www.gnu.org/licenses/gpl-2.0.html -[installation]: installation.md -[development]: development.md -[patchwork mailing list]: https://ozlabs.org/mailman/listinfo/patchwork +[ref-gpl]: http://www.gnu.org/licenses/gpl-2.0.html +[ref-pw-ml]: https://ozlabs.org/mailman/listinfo/patchwork +[doc-deployment]: installation.md +[doc-development]: development.md diff --git a/docs/installation.md b/docs/installation.md index b1219fa..7c73b62 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -129,14 +129,13 @@ distro probably provides this. If not, install it manually: ### Configure Settings -You will also need to configure a [settings] file for Django. A -[sample settings file] is provided, which defines default settings for +You will also need to configure a [settings][ref-django-settings] file for +Django. A sample settings file is provided, which defines default settings for patchwork. You'll need to configure settings for your own setup and save this as `production.py` (or override the `DJANGO_SETTINGS_MODULE` environment variable). - cp patchwork/settings/production.example.py \ - patchwork/settings/production.py + cp patchwork/settings/production{.example,}.py At the very minimum, the following settings need to be configured: @@ -192,8 +191,7 @@ database: PYTHONPATH=lib/python ./manage.py loaddata default_tags default_states -[sample_settings_file]: ../patchwork/settings/production.example.py -[settings]: https://docs.djangoproject.com/en/1.8/topics/settings/ +[ref-django-settings]: https://docs.djangoproject.com/en/1.8/topics/settings/ ## Apache Setup -- 2.0.0 _______________________________________________ Patchwork mailing list Patchwork@lists.ozlabs.org https://lists.ozlabs.org/listinfo/patchwork