Merge branch 'main' into patch-2

.github/holopin.yml

@@ -0,0 +1,5 @@
+organization: mautic
+holobytes:
+  - evolvingStickerId: cm1ti4x4c57560cjq2styaitm
+    icon: avocado
+    alias: writetoberfest-2024

.github/styles/Vocab/Mautic/accept.txt → .github/styles/config/vocabularies/Mautic/accept.txt

@@ -59,9 +59,12 @@ IDP
 IMAP
 infographics
 JavaScript
+Jira
 Jitsi
+Jono
 Joomla
 Joomla!
+Kubuntu
 Libre
 Licensor
 LinkedIn

.github/workflows/linting.yml

@@ -1,35 +1,39 @@
 name: Linting
 on:
-  # Note: onlyAnnotateModifiedLines only works correctly on PRs!
-  # If you need to run checks on push as well, create a separate workflow file.
   pull_request:
 
 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@v2
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
 
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.x'
+        cache: 'pip'
+
+    - name: Install Python dependencies
+      run: pip3 install -r docs/requirements.txt
+
     - name: Vale
-      uses: errata-ai/vale-action@master
+      uses: errata-ai/vale-action@reviewdog
       with:
-        # We can modify these styles as we want
-        styles: |
-          https://github.com/errata-ai/Google/releases/latest/download/Google.zip
-        onlyAnnotateModifiedLines: true
+        # Please keep version in sync with the version in .gitpod.Dockerfile for a consistent experience
+        version: 3.7.1
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   build:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
-    - uses: actions/setup-python@v2
+    - uses: actions/setup-python@v4
       with:
         python-version: '3.x'
         cache: 'pip'
@@ -43,4 +47,4 @@ jobs:
 
     - name: Check links
       working-directory: docs
-      run: make checklinks
+      run: make checklinks

.gitpod.Dockerfile

@@ -0,0 +1,20 @@
+FROM python:3.11
+
+# Please keep version in sync with the version in .github/workflows/linting.yml for a consistent experience
+ENV VALE_VERSION=3.7.1
+
+WORKDIR /workspace
+
+# Needed for Vale (rst2html) and reStructuredText (rstcheck)
+RUN pip install rst2html rstcheck
+
+RUN mkdir -p vale && cd vale && wget https://github.com/errata-ai/vale/releases/download/v${VALE_VERSION}/vale_${VALE_VERSION}_Linux_64-bit.tar.gz && \
+    tar -xf vale_${VALE_VERSION}_Linux_64-bit.tar.gz && cp /workspace/vale/vale /usr/local/bin/vale && cd ../
+
+# /home/gitpod/.local/bin ensures that Python packages like rstcheck can be found
+ENV PATH=/home/gitpod/.local/bin:$PATH
+
+# Create the gitpod user. UID must be 33333. https://www.gitpod.io/docs/configure/workspaces/workspace-image#use-a-custom-dockerfile
+RUN useradd -l -u 33333 -G sudo -md /home/gitpod -s /bin/bash -p gitpod gitpod
+
+USER gitpod

.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
@@ -9,26 +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
-
-github:
-  prebuilds:
-    # enable for the master/default branch (defaults to true)
-    master: true
-    # enable for all branches in this repo (defaults to false)
-    branches: true
-    # enable for pull requests coming from this repo (defaults to true)
-    pullRequests: true
-    # enable for pull requests coming from forks (defaults to false)
-    pullRequestsFromForks: true
-    # add a check to pull requests (defaults to true)
-    addCheck: false
-    # add a "Review in Gitpod" button as a comment to pull requests (defaults to false)
-    addComment: false
-    # add a "Review in Gitpod" button to the pull request's description (defaults to false)
-    addBadge: true
-    # add a label once the prebuild is ready to pull requests (defaults to false)
-    addLabel: false
+    - eamodio.gitlens

.readthedocs.yaml

@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-20.04
   tools:
-    python: "3.9"
+    python: "3.11"
     # You can also specify other tool versions:
     # nodejs: "16"
     # rust: "1.55"

.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"
+}

docs/conf.py

@@ -58,3 +58,12 @@
 
 # -- Options for EPUB output
 epub_show_urls = 'footnote'
+
+# -- Internationalisation configuration
+
+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!
+
+linkcheck_ignore = []

docs/index.rst

@@ -1,4 +1,4 @@
-Mautic community handbook
+Mautic Community Handbook
 #########################
 
 This handbook is a central point of call for understanding the management and organization of the Mautic community.
@@ -9,6 +9,13 @@ The vision is that it grows over time as the teams and governance structure evol
 
    This project is under active development as the handbook is re-platformed from the old system.
 
+.. toctree::
+   :maxdepth: 2
+   :caption: Community Handbook
+   :hidden:
+
+   overview/community
+
 .. toctree::
    :maxdepth: 2
    :caption: About Mautic
@@ -23,4 +30,14 @@ The vision is that it grows over time as the teams and governance structure evol
 
    teams/legal_and_finance_team
 
+.. toctree::
+   :maxdepth: 2
+   :caption: Resources
+   :hidden:
 
+   resources/community_wide_resources/community_wide_resources
+   resources/community_wide_resources/avoiding_burnout
+   resources/community_wide_resources/getting_help_in_a_crisis
+   resources/meetings/meetings
+   resources/meetings/asynchronous_meetings
+   resources/meetings/preparing_and_running_meetings

docs/links/Art-of-community-book.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "The Art of Community" 
+link_text = "The Art of Community"
+link_url = "http://www.artofcommunityonline.org/" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/links/Jono-bacon-video.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Jono Bacon's how to prevent burnout video"
+link_text = "Jono Bacon's how to prevent burnout video"
+link_url = "https://www.youtube.com/watch?v=WC1bpYGoB7s" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/links/everytimezone.py

@@ -0,0 +1,6 @@
+from . import link
+
+link_name = "everytimezone" 
+link_text = "everytimezone"
+link_url = "https://everytimezone.com/"
+link.xref_links.update({link_name: (link_text, link_url)})

docs/links/mautic-google-drive.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Mautic Google Drive" 
+link_text = "Mautic Google Drive"
+link_url = "https://drive.google.com/drive/folders/1lUQyFnrPEZKlrmhP9HedxSnDGY3StMXx" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/links/mautic-meeting-parser.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Mautic Meeting Parser" 
+link_text = "Mautic Meeting Parser"
+link_url = "https://github.com/RCheesley/mautic-meeting-parser" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/links/suicide-prevention-lifeline.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Suicide Prevention Lifeline" 
+link_text = "Suicide Prevention Lifeline" 
+link_url = "http://www.suicidepreventionlifeline.org/" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/links/wikipedia.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Wikipedia" 
+link_text = "Wikipedia" 
+link_url = "https://en.wikipedia.org/wiki/List_of_suicide_crisis_lines" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/overview/community.rst

@@ -0,0 +1,6 @@
+Community Handbook
+==================
+
+This handbook is a central point of call for how the Mautic community is organised and managed.
+
+The vision is that it will grow over time as the teams and governance structure evolves, with team members adding useful resources and updating processes as they mature and are refined.

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
-esbonio==0.16.0
-attrs==22.2.0
+rstcheck==6.2.4
+myst-parser==4.0.0 
+linkify-it-py==2.0.3
+esbonio==0.16.5
+attrs==24.2.0