From c192f1afb7ef2f01954dba9e00e20c3db8d2fd46 Mon Sep 17 00:00:00 2001 From: Mikey O'Toole <mikey@mjco.uk> Date: Wed, 15 Jul 2020 08:03:58 +0100 Subject: [PATCH] Fix two broken links! --- docs/backdrop/index.md | 2 +- docs/index.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 docs/index.md diff --git a/docs/backdrop/index.md b/docs/backdrop/index.md index 8950e2f..7fc95a5 100644 --- a/docs/backdrop/index.md +++ b/docs/backdrop/index.md @@ -128,4 +128,4 @@ There should now be a **CiviCRM** link in your Backdrop menu. Click that link an ## Trouble-shooting Resources {:#troubleshooting} -* Review the [Troubleshooting](../troubleshooting.md) page for help with problems you may encounter during the installation. +* Review the [Troubleshooting](../general/troubleshooting.md) page for help with problems you may encounter during the installation. diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..23e659c --- /dev/null +++ b/docs/index.md @@ -0,0 +1,18 @@ +## Scope of this guide + +This guide is for people installing a [CiviCRM](https://civicrm.org) instance for an organization. + +### Installation Guide vs other guides + +We also have a [User Guide](https://docs.civicrm.org/user/en/latest) which covers all the functionality available through CiviCRM's web-based interface and a [SysAdmin Guide](https://docs.civicrm.org/sysadmin/en/latest) which covers more advanced administration. + +The two guides have some overlapping scope when it comes to setup and configuration. In general, we try to cover actions in the User Guide which the user can perform from within CiviCRM's user interface. Actions that require work outside of the CiviCRM interface (e.g. file-system or shell access) are covered in the System Administrator Guide. + +## Editing this guide + +* This guide is made with MkDocs and stored in a [GitLab repository](https://lab.civicrm.org/documentation/docs/installation). +* See the ["Writing Documentation"](https://docs.civicrm.org/dev/en/latest/documentation)" page in the Developer Guide for specific details on editing this guide. + +## Credits + +This guide is collaboratively written by the CiviCRM community, with facilitation from the [Documentation Working Group](https://civicrm.org/working-groups/documentation). -- GitLab