mautic · RCheesley · Jul 24, 2023 · Jul 24, 2023 · Jul 24, 2023 · Jul 24, 2023
diff --git a/docs/development-environment/environments.rst b/docs/development-environment/environments.rst
@@ -15,8 +15,8 @@ Real environment variables win over ``.env`` files.
 
 .. warning:: Don't define secrets in this file, or any other committed files. Set secrets via environment variables, or through other secret management tools.
 
-Run ``composer dump-env prod`` to compile .env files for production use (``requires symfony/flex >=1.2``).
-Read more about best practices at :xref:`Symfony 4 best practices environment variables`
+Run ``composer dump-env prod`` to compile .env files for production use (``requires symfony/flex >=1.2``). Read more about 
+:xref:`Symfony 4 best practices environment variables`.
 
 By default the structure come with 3 environments
 ``.env``

diff --git a/docs/development-environment/getting_started.rst b/docs/development-environment/getting_started.rst
@@ -3,6 +3,9 @@ Development environment
 
 Introduction
 ============
-Mautic is a system based on Symfony and Doctrine.
-Mautic follow the Symfony coding standards and best practices and use the Symfony framework as a foundation for the app
+Mautic is a system based on the :xref:`Symfony framework` and :xref:`Doctrine`.
+
+Mautic uses the :xref:`Symfony framework` as a foundation for the app. 
+
+It follows the :xref:`Symfony coding standards` and :xref:`Symfony best practices`.
 
diff --git a/docs/development-environment/how_to_install.rst b/docs/development-environment/how_to_install.rst
diff --git a/docs/development-environment/how_to_install_with_ddev.rst b/docs/development-environment/how_to_install_with_ddev.rst
@@ -1,12 +1,15 @@
 How to install Mautic with DDEV
 ###############################
 
+.. note:: 
+    If you get stuck, join the lively Mautic Community on :xref:`Mautic Slack` or the :xref:`Developer Forum` for support and answers. **Please first post in the forum**, then share the link in Slack, so others can learn from your question.
+
 Pre-requisites with DDEV
 ========================
-1. You should have DDEV installed on your machine. If not, please follow the instructions here: https://ddev.readthedocs.io/en/stable/#installation
+1. You should have DDEV and Docker or Colima installed on your machine. If not, please follow the instructions here: :xref:`ddev install`
 
-Installing Mautic is a simple two-step process:
-===============================================
+Installing Mautic is a two-step process:
+========================================
 1. Clone this repository
 
 .. code-block:: bash
@@ -16,13 +19,12 @@ Installing Mautic is a simple two-step process:
 .. Note:: Clone the repository in the directory where you want to install Mautic.
 
 1. Install Mautic running DDEV.
+
 .. code-block:: bash
 
     cd mautic
     ddev start
 
-.. Note:: When asked if you want to install Mautic, choose yes.
-
 .. list-table:: Users and passwords
     :header-rows: 1
 

diff --git a/docs/development-environment/setup.rst b/docs/development-environment/setup.rst
@@ -1,20 +1,24 @@
-Setup
-######
+How to install Mautic manually
+##############################
 
 Pre-requisites to setup
 =======================
 
 Mautic assumed that the system already has ``composer`` and ``git`` installed and configured.
 
+.. note:: 
+    If you get stuck, join the lively Mautic Community on :xref:`Mautic Slack` or the :xref:`Developer Forum` for support and answers. **Please first post in the forum**, then share the link in Slack, so others can learn from your question.
+
 Steps
 =====
-1. To setup the developer environment, simply fork and clone the source from GitHub. Then Run ``composer install`` on the source.
+1. To setup the developer environment, fork and clone the source from GitHub as outlined in :doc:`/development-environment/how_to_install_with_ddev`. 
+2. Run ``composer install`` on the source.
+3. Open your browser and complete the installation through the Mautic installer.
 
-2. Open your browser and complete the installation through the Mautic installer.
-You can also execute the install process from command line:
+You can also run the install process from command line:
 
 * Add a ``local.php`` file in ``app/config``
-* Edit the ``local.php`` file using the following template (Mautic adapt to new local settings):
+* Edit the ``local.php`` file using the following template (Mautic adapts to new local settings):
 
 .. code-block:: php
 
@@ -31,8 +35,8 @@ You can also execute the install process from command line:
             'db_backup_prefix' => 'bak_',
     );
 
-* Execute the following command and add your own options:
+* Run the following command and add your own options:
 
 .. code-block:: bash
 
-    php bin/console mautic:install http://your.mautic.instance
+    php bin/console mautic:install https://mautic.example.com
diff --git a/docs/index.rst b/docs/index.rst
@@ -9,9 +9,8 @@ This is a work in progress. More to come soon. In the meantime, go to :xref:`Leg
    :hidden:
 
    development-environment/getting_started
-   development-environment/setup
-   development-environment/how_to_install
    development-environment/how_to_install_with_ddev
+   development-environment/setup
    development-environment/environments
 
 .. toctree::

diff --git a/docs/links/composer.py b/docs/links/composer.py
@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "composer" 
+link_text = "Composer" 
+link_url = "https://getcomposer.org" 
+
+link.xref_links.update({link_name: (link_text, link_url)})
diff --git a/docs/links/ddev_install.py b/docs/links/ddev_install.py
@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "ddev install" 
+link_text = "Install DDEV" 
+link_url = "https://ddev.readthedocs.io/en/stable/#installation" 
+
+link.xref_links.update({link_name: (link_text, link_url)})
diff --git a/docs/links/doctrine.py b/docs/links/doctrine.py
@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Doctrine" 
+link_text = "Doctrine" 
+link_url = "https://www.doctrine-project.org/" 
+
+link.xref_links.update({link_name: (link_text, link_url)})
diff --git a/docs/links/mautic_dev_forum.py b/docs/links/mautic_dev_forum.py
@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Developer Forum" 
+link_text = "Developer Forum" 
+link_url = "https://forum.mautic.org/c/development" 
+
+link.xref_links.update({link_name: (link_text, link_url)})
diff --git a/docs/links/mautic_github.py b/docs/links/mautic_github.py
@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Mautic's GitHub Repo" 
+link_text = "Mautic's GitHub repository" 
+link_url = "https://github.com/mautic/mautic" 
+
+link.xref_links.update({link_name: (link_text, link_url)})
diff --git a/docs/links/mautic_slack.py b/docs/links/mautic_slack.py
@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Mautic Slack" 
+link_text = "Slack" 
+link_url = "https://mau.tc/slack-invite" 
+
+link.xref_links.update({link_name: (link_text, link_url)})
diff --git a/docs/links/symfony_best_practices.py b/docs/links/symfony_best_practices.py
@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Symfony best practices" 
+link_text = "Symfony best practices" 
+link_url = "https://symfony.com/doc/current/best_practices.html" 
+
+link.xref_links.update({link_name: (link_text, link_url)})
diff --git a/docs/links/symfony_coding_standards.py b/docs/links/symfony_coding_standards.py
@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Symfony coding standards" 
+link_text = "Symfony coding standards" 
+link_url = "https://symfony.com/doc/current/contributing/code/standards.html" 
+
+link.xref_links.update({link_name: (link_text, link_url)})
diff --git a/docs/links/symfony_docs_best_pratice_environments.py b/docs/links/symfony_docs_best_pratice_environments.py
@@ -1,7 +1,7 @@
 from . import link
 
 link_name = "Symfony 4 best practices environment variables"
-link_text = "Read more about best practices at:"
+link_text = "best practices"
 link_url = "https://symfony.com/doc/current/best_practices.html#use-environment-variables-for-infrastructure-configuration"
 
 link.xref_links.update({link_name: (link_text, link_url)})
diff --git a/docs/links/symfony_framework.py b/docs/links/symfony_framework.py
@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Symfony framework" 
+link_text = "Symfony framework" 
+link_url = "https://symfony.com/" 
+
+link.xref_links.update({link_name: (link_text, link_url)})