diff --git a/.github/styles/config/vocabularies/Mautic/accept.txt b/.github/styles/config/vocabularies/Mautic/accept.txt index e881123a..46ca5c6b 100644 --- a/.github/styles/config/vocabularies/Mautic/accept.txt +++ b/.github/styles/config/vocabularies/Mautic/accept.txt @@ -125,6 +125,7 @@ Unpublish URL URLs UTM +VSCode Vtiger Webmecanik www diff --git a/docs/links/colima_install.py b/docs/links/colima_install.py new file mode 100644 index 00000000..0dba5652 --- /dev/null +++ b/docs/links/colima_install.py @@ -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)}) diff --git a/docs/links/ddev_install.py b/docs/links/ddev_install.py new file mode 100644 index 00000000..e602d6ef --- /dev/null +++ b/docs/links/ddev_install.py @@ -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)}) diff --git a/docs/links/docker_desktop_install.py b/docs/links/docker_desktop_install.py new file mode 100644 index 00000000..6548c3c0 --- /dev/null +++ b/docs/links/docker_desktop_install.py @@ -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)}) diff --git a/docs/links/git_download.py b/docs/links/git_download.py new file mode 100644 index 00000000..fc5a5cb4 --- /dev/null +++ b/docs/links/git_download.py @@ -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)}) diff --git a/docs/links/github_cli_install.py b/docs/links/github_cli_install.py new file mode 100644 index 00000000..571e621d --- /dev/null +++ b/docs/links/github_cli_install.py @@ -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)}) diff --git a/docs/links/vscode_install.py b/docs/links/vscode_install.py new file mode 100644 index 00000000..ee02bc9e --- /dev/null +++ b/docs/links/vscode_install.py @@ -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)}) diff --git a/docs/teams/education_team/contributing_docs_rst.rst b/docs/teams/education_team/contributing_docs_rst.rst index 1e9caaf3..8ebf3607 100644 --- a/docs/teams/education_team/contributing_docs_rst.rst +++ b/docs/teams/education_team/contributing_docs_rst.rst @@ -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. @@ -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` + +