Add gitpod.py and continue with docs writing

mautic · Oct 28, 2024 · 8a21d8c · 8a21d8c
1 parent 5b9b0ac
commit 8a21d8c
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/docs/links/gitpod.py b/docs/links/gitpod.py
@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Gitpod" 
+link_text = "Gitpod" 
+link_url = "https://gitpod.io/" 
+
+link.xref_links.update({link_name: (link_text, link_url)})
diff --git a/docs/teams/education_team/contributing_docs_rst.rst b/docs/teams/education_team/contributing_docs_rst.rst
@@ -7,3 +7,20 @@ So you're interested in contributing to Mautic's documentation? That's fantastic
 2. The :xref:`Developer Docs` - :xref:`Developer Docs GitHub`
 3. The :xref:`Community Handbook` - :xref:`Community Handbook GitHub`
 
+Getting started
+***************
+
+You can work with the documentation locally, using DDEV and an application like VSCode. This allows you to make changes and see them in real-time on a locally-hosted version of the documentation.
+
+You can also use the web-based tool :xref:`Gitpod`, which allows you to spin up a temporary cloud-hosted instance of the documentation, make changes, and submit a pull request to have your changes merged back into the main repository. You can also test PRs with Gitpod, too.
+
+Working locally
+===============
+
+To get started with one of the documentation repositories locally, it's advised to install:
+
+- Git
+- Docker or Colima
+- DDEV 
+- VSCode
+- GitHub CLI