Skip to content

Commit

Permalink
Links for installing core tooling
Browse files Browse the repository at this point in the history
  • Loading branch information
RCheesley committed Nov 3, 2024
1 parent 8a21d8c commit 8b20667
Show file tree
Hide file tree
Showing 8 changed files with 51 additions and 6 deletions.
1 change: 1 addition & 0 deletions .github/styles/config/vocabularies/Mautic/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ Unpublish
URL
URLs
UTM
VSCode
Vtiger
Webmecanik
www
Expand Down
7 changes: 7 additions & 0 deletions docs/links/colima_install.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from . import link

link_name = "install Colima"
link_text = "install Colima"
link_url = "https://github.com/abiosoft/colima?tab=readme-ov-file#installation"

link.xref_links.update({link_name: (link_text, link_url)})
7 changes: 7 additions & 0 deletions docs/links/ddev_install.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from . import link

link_name = "install DDEV"
link_text = "install DDEV"
link_url = "https://ddev.readthedocs.io/en/stable/users/install/ddev-installation/"

link.xref_links.update({link_name: (link_text, link_url)})
7 changes: 7 additions & 0 deletions docs/links/docker_desktop_install.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from . import link

link_name = "install Docker Desktop"
link_text = "install Docker Desktop"
link_url = "https://www.docker.com/products/docker-desktop/"

link.xref_links.update({link_name: (link_text, link_url)})
7 changes: 7 additions & 0 deletions docs/links/git_download.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from . import link

link_name = "install Git"
link_text = "install Git"
link_url = "https://git-scm.com/downloads"

link.xref_links.update({link_name: (link_text, link_url)})
7 changes: 7 additions & 0 deletions docs/links/github_cli_install.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from . import link

link_name = "install GitHub CLI"
link_text = "install GitHub CLI"
link_url = "https://cli.github.com/"

link.xref_links.update({link_name: (link_text, link_url)})
7 changes: 7 additions & 0 deletions docs/links/vscode_install.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from . import link

link_name = "install VSCode"
link_text = "install VSCode"
link_url = "https://code.visualstudio.com/download"

link.xref_links.update({link_name: (link_text, link_url)})
14 changes: 8 additions & 6 deletions docs/teams/education_team/contributing_docs_rst.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ So you're interested in contributing to Mautic's documentation? That's fantastic
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 work with the documentation locally, using DDEV and an editor like VSCode. This allows you to make changes and see them in real-time on a locally hosted version of the documentation. It's recommended as you can benefit from having syntax highlighting, and also generate the docs to verify the layout of your work as you go.

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.

Expand All @@ -19,8 +19,10 @@ 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
- Git - :xref:`install Git`
- Docker Desktop - All operating systems, :xref:`install Docker Desktop` - or Colima - Mac and Linux, :xref:`install Colima`
- DDEV - :xref:`install DDEV`
- VSCode - :xref:`install VSCode`
- GitHub CLI - :xref:`install GitHub CLI`


0 comments on commit 8b20667

Please sign in to comment.