From e22de0add359e6c00bec5d6595ee85f6a1aad583 Mon Sep 17 00:00:00 2001 From: John Linhart Date: Wed, 9 Oct 2024 10:26:31 +0200 Subject: [PATCH 01/12] Use the local dockerfile over the image --- .gitpod.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.gitpod.yml b/.gitpod.yml index 659fc24b..3764db53 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -1,6 +1,5 @@ -# Since Gitpod doesn't support caching custom Dockerfiles yet, we temporarily -# use this once which has Python 3.9 and Vale preinstalled. -image: dennisameling/python-vale:latest +image: + file: .gitpod.Dockerfile tasks: - before: pip install -r docs/requirements.txt From e5d36cfb452753f9096bf3a7ececd2d572b98f5a Mon Sep 17 00:00:00 2001 From: John Linhart Date: Wed, 9 Oct 2024 11:33:19 +0200 Subject: [PATCH 02/12] Updating Vale --- .github/workflows/linting.yml | 2 +- .gitpod.Dockerfile | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml index 6e08cd6e..3c9a8df4 100644 --- a/.github/workflows/linting.yml +++ b/.github/workflows/linting.yml @@ -15,7 +15,7 @@ jobs: uses: errata-ai/vale-action@reviewdog with: # Please keep version in sync with the version in .gitpod.Dockerfile for a consistent experience - version: 2.29.2 + version: 3.7.1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitpod.Dockerfile b/.gitpod.Dockerfile index c345449f..e388e131 100644 --- a/.gitpod.Dockerfile +++ b/.gitpod.Dockerfile @@ -1,8 +1,7 @@ FROM python:3.11 -# Don't update to a higher version until this issue has been fixed: https://github.com/errata-ai/vale/issues/528 # Please keep version in sync with the version in .github/workflows/linting.yml for a consistent experience -ENV VALE_VERSION=2.29.2 +ENV VALE_VERSION=3.7.1 WORKDIR /workspace From 564b7b6efa5acb89f8990e9977a47b5667ac8f2b Mon Sep 17 00:00:00 2001 From: John Linhart Date: Wed, 9 Oct 2024 11:47:41 +0200 Subject: [PATCH 03/12] Downgrading ubuntu to make the GH action work --- .github/workflows/linting.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml index 3c9a8df4..8c2010a6 100644 --- a/.github/workflows/linting.yml +++ b/.github/workflows/linting.yml @@ -4,7 +4,7 @@ on: jobs: prose: - runs-on: ubuntu-latest + runs-on: ubuntu-22.04 # See https://github.com/errata-ai/vale-action/issues/128 before upgrading steps: - name: Checkout uses: actions/checkout@v4 From 073a39e5e96f6e4ffe0e508864ef630d54e76b92 Mon Sep 17 00:00:00 2001 From: John Linhart Date: Wed, 9 Oct 2024 11:53:37 +0200 Subject: [PATCH 04/12] Updating path to accept.txt according to https://vale.sh/docs/topics/vocab/#folder-structure --- .github/styles/{Vocab => config/vocabularies}/Mautic/accept.txt | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/styles/{Vocab => config/vocabularies}/Mautic/accept.txt (100%) diff --git a/.github/styles/Vocab/Mautic/accept.txt b/.github/styles/config/vocabularies/Mautic/accept.txt similarity index 100% rename from .github/styles/Vocab/Mautic/accept.txt rename to .github/styles/config/vocabularies/Mautic/accept.txt From cf2c5851c41f5d6d117c2723eeb60b4533c6ee64 Mon Sep 17 00:00:00 2001 From: John Linhart Date: Wed, 9 Oct 2024 12:07:09 +0200 Subject: [PATCH 05/12] Updating esbonio to latest version --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 0a6fb17b..94b8ed29 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -7,5 +7,5 @@ readthedocs-sphinx-search==0.3.2 rstcheck==6.1.1 myst-parser==1.0.0 linkify-it-py==2.0.0 -esbonio==0.16.0 +esbonio==0.16.5 attrs==22.2.0 From 905aa6179d06afcd5531082dce34258f4240a222 Mon Sep 17 00:00:00 2001 From: John Linhart Date: Wed, 9 Oct 2024 12:25:50 +0200 Subject: [PATCH 06/12] Upgrading other python dependencies to latest --- docs/requirements.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 94b8ed29..7a8a8cfb 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,11 +1,11 @@ # File: requirements.txt # Defining the exact version will make sure things don't break -sphinx==6.2.1 -sphinx_rtd_theme==1.2.0 +sphinx==8.0.2 +sphinx_rtd_theme==3.0.0 readthedocs-sphinx-search==0.3.2 -rstcheck==6.1.1 -myst-parser==1.0.0 -linkify-it-py==2.0.0 +rstcheck==6.2.4 +myst-parser==4.0.0 +linkify-it-py==2.0.3 esbonio==0.16.5 -attrs==22.2.0 +attrs==24.2.0 From b6b1d2ed1ab5267841e00871e04f8dd756272b0b Mon Sep 17 00:00:00 2001 From: John Linhart Date: Wed, 9 Oct 2024 12:39:41 +0200 Subject: [PATCH 07/12] Trying more settings to configure esbonio --- .vscode/settings.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 494ebbd1..7947ada3 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -5,5 +5,8 @@ "esbonio.sphinx.buildDir": "${workspaceFolder}/build", "esbonio.sphinx.confDir": "${workspaceFolder}/docs", "restructuredtext.pythonRecommendation.disabled": true, - "restructuredtext.preview.name": "sphinx" + "restructuredtext.preview.name": "sphinx", + "esbonio.sphinx.pythonCommand": "python3", + "esbonio.sphinx.buildCommand": "sphinx-build", + "esbonio.logging.level": "debug" } From 03023ff02726f5876e8c2b7753e5b94ae4fe9e95 Mon Sep 17 00:00:00 2001 From: John Linhart Date: Wed, 9 Oct 2024 12:46:42 +0200 Subject: [PATCH 08/12] Fixing docs/troubleshooting/troubleshooting.rst:116: WARNING: unknown document: './troubleshooting/working_with_resource_limits' --- docs/troubleshooting/troubleshooting.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/troubleshooting/troubleshooting.rst b/docs/troubleshooting/troubleshooting.rst index ca338828..83b486ce 100644 --- a/docs/troubleshooting/troubleshooting.rst +++ b/docs/troubleshooting/troubleshooting.rst @@ -113,7 +113,7 @@ This error reported is: This means that the memory limit that Apache has available is too low. Edit the ``memory_limit`` in the ``php.ini`` configuration file. -Read more about this in :doc:`./troubleshooting/working_with_resource_limits`. +Read more about this in :doc:`/troubleshooting/working_with_resource_limits`. A required PHP extension is missing =================================== From ee8c48aa5639e3bbc7cc8ac2f5cc00ce4937594f Mon Sep 17 00:00:00 2001 From: John Linhart Date: Wed, 9 Oct 2024 12:51:33 +0200 Subject: [PATCH 09/12] Replacing a link that timeouts --- docs/links/linux_ls_command_documentation.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/links/linux_ls_command_documentation.py b/docs/links/linux_ls_command_documentation.py index bdd1b6a8..01460326 100644 --- a/docs/links/linux_ls_command_documentation.py +++ b/docs/links/linux_ls_command_documentation.py @@ -2,6 +2,6 @@ link_name = "Linux ls command" link_text = "Linux ls command documentation" -link_url = "https://www.garron.me/en/go2linux/ls-file-permissions.html" +link_url = "https://en.wikipedia.org/wiki/Ls" link.xref_links.update({link_name: (link_text, link_url)}) From 3626f2831bec8a25e54f00bfe3e2ec6c6c5f6250 Mon Sep 17 00:00:00 2001 From: John Linhart Date: Wed, 9 Oct 2024 15:49:46 +0200 Subject: [PATCH 10/12] Fixing redirected link --- docs/links/github_search_ini.py | 7 +++++++ docs/translations/translations.rst | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 docs/links/github_search_ini.py diff --git a/docs/links/github_search_ini.py b/docs/links/github_search_ini.py new file mode 100644 index 00000000..c0f165e7 --- /dev/null +++ b/docs/links/github_search_ini.py @@ -0,0 +1,7 @@ +from . import link + +link_name = "Mautic INI files" +link_text = "Mautic INI files" +link_url = "https://github.com/search?q=repo%3Amautic%2Fmautic+Dashboard+menu+language%3AINI" + +link.xref_links.update({link_name: (link_text, link_url)}) diff --git a/docs/translations/translations.rst b/docs/translations/translations.rst index 3446001b..5322f1e7 100644 --- a/docs/translations/translations.rst +++ b/docs/translations/translations.rst @@ -89,7 +89,7 @@ GitHub has also an option to search for strings in the repository - it's not par Try searching for 'Dashboard menu' within the Mautic/Mautic repository, as there is special translation for the menu item and another for the page title. GitHub won't find the right translation when you search for just 'Dashboard' - it requires the full string. Next, use the filter to show only INI files. Here is the link to the search result: -`https://github.com/mautic/mautic/search?l=INI&q=Dashboard+menu `_ +:xref:`Mautic INI files` The first file found is ``app/bundles/DashboardBundle/Translations/en_US/messages.ini`` and there is the line ``mautic.dashboard.menu.index="Dashboard"`` within the file, which is text to override. From 492e74c282a2203d7d13503ff974a9a9c666cfcc Mon Sep 17 00:00:00 2001 From: John Linhart Date: Fri, 11 Oct 2024 10:08:16 +0200 Subject: [PATCH 11/12] Downgrading restructuredtext to support live previews --- .gitpod.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitpod.yml b/.gitpod.yml index 3764db53..bdc51320 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -8,7 +8,7 @@ tasks: vscode: extensions: - ms-python.python - - lextudio.restructuredtext + - lextudio.restructuredtext@190.1.4 # See https://github.com/mautic/user-documentation/pull/334#issuecomment-2405922370 before upgrading. - trond-snekvik.simple-rst - errata-ai.vale-server - eamodio.gitlens \ No newline at end of file From 7b7146cf0e2a8a88f0cebaa7e831bde7b70f4af9 Mon Sep 17 00:00:00 2001 From: Dennis Ameling Date: Fri, 11 Oct 2024 10:00:15 +0000 Subject: [PATCH 12/12] Fix linkcheck and warning regarding locale_dirs --- docs/conf.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index cf45deb5..cb73a4b8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -61,7 +61,7 @@ # -- Internationalisation configuration -locale_dirs = 'locale' +locale_dirs = ['locale'] # Please add links here that do not pass the "make checklinks" check. # A little context on the reason for ignoring is greatly appreciated! @@ -76,4 +76,11 @@ r"https://api-ssl.bitly.com/*", #This domain blocks the checker. r"https://linuxize.com/*", + # The GitHub Search UI requires users to be authenticated with session cookies, which we can't set up programmatically + r"https://github.com/search*", + # Requires authentication. + r"https://www.maxmind.com/en/accounts/current*", + # The URLs below broken and should be replaced by working ones. + r"https://staffwww.fullcoll.edu/sedwards/Nano/NanoKeyboardCommands.html", + r"https://blog.maxmind.com/search-results*" ]