From 678591c467cbae6c46301eb65e2c3b93c68cb3af Mon Sep 17 00:00:00 2001 From: Ayu Adiati Date: Mon, 22 Sep 2025 06:19:48 +0200 Subject: [PATCH 1/5] fix internal links in developer.rst --- docs/contributing/developer.rst | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/docs/contributing/developer.rst b/docs/contributing/developer.rst index 59ab74f08..e803631c6 100644 --- a/docs/contributing/developer.rst +++ b/docs/contributing/developer.rst @@ -221,10 +221,8 @@ BC break is any change that may break a Plugin, either by using or extending a c Examples: -.. Replace [deprecated] with :doc:`deprecated ` - -* Remove or rename a public or protected method in a non-final class. Create a new method instead and mark the old one [deprecated]. -* Change the signature of a private or public method in a non-final class. This means adding/removing method parameters or adding/changing parameters or return types. Create a new method instead and mark the old one [deprecated]. +* Remove or rename a public or protected method in a non-final class. Create a new method instead and mark the old one :doc:`deprecated `. +* Change the signature of a private or public method in a non-final class. This means adding/removing method parameters or adding/changing parameters or return types. Create a new method instead and mark the old one :doc:`deprecated `. * Change the behavior of a method so it does something differently. * Add a new method to an existing interface. Create a new interface instead. * Whenever you change a :xref:`Symfony Twig` template, think about the Themes that are overwriting this template. For instance, changing the template name can cause issues. @@ -404,9 +402,7 @@ PR testing .. vale on -.. Replace [Code governance] with :doc:`/governance/code_governance` - -If you want to test a PR from other developers, see the :ref:`PR review process` section. All PRs require testing by others in the Community and must have the code reviewed by a member of the Core Team. Read more information in the [Code governance] section. +If you want to test a PR from other developers, see the :ref:`PR review process` section. All PRs require testing by others in the Community and must have the code reviewed by a member of the Core Team. Read more information in the :doc:`/governance/code_governance` section. Automated testing ----------------- @@ -559,9 +555,7 @@ PR review process .. vale on -.. Replace [tier of the PR] with :doc:`tier of the PR ` - -Every change to Mautic happens via PRs. Every PR must have a number of successful tests and code reviews to be merged to the core and released in the next version - the number required depends on the [tier of the PR]. Testing a PR is a great way to move Mautic forward and personally improve its quality and stability. +Every change to Mautic happens via PRs. Every PR must have a number of successful tests and code reviews to be merged to the core and released in the next version - the number required depends on the :doc:`tier of the PR `. Testing a PR is a great way to move Mautic forward and personally improve its quality and stability. Here are the steps to review a PR: From f200b869656261f716ba5094a9b24639ae1f1011 Mon Sep 17 00:00:00 2001 From: Ayu Adiati Date: Mon, 22 Sep 2025 06:31:24 +0200 Subject: [PATCH 2/5] fix internal link in paying_contributors.rst --- docs/policies/paying_contributors.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/policies/paying_contributors.rst b/docs/policies/paying_contributors.rst index 30e18bcab..e2cf17804 100644 --- a/docs/policies/paying_contributors.rst +++ b/docs/policies/paying_contributors.rst @@ -24,9 +24,7 @@ This policy provides a guideline on how Mautic uses the funds available for use Proposing sponsored contributors ================================ -.. Replace "Financial Policy" with :doc:``. - -Team Leads can propose that the Mautic Community sponsor any contributor from their teams who are in good standing within the community. The Community Council reviews these, with the final decision being approved by the Project Lead. It's important to note that the Mautic Community is unable to pay people who live in certain countries for legal reasons. Please check the Financial Policy for further details. +Team Leads can propose that the Mautic Community sponsor any contributor from their teams who are in good standing within the community. The Community Council reviews these, with the final decision being approved by the Project Lead. It's important to note that the Mautic Community is unable to pay people who live in certain countries for legal reasons. Please check the :doc:`Financial Policy ` for further details. A clear proposal will be made, which outlines the benefits to the Mautic Project through sponsoring the individual, with examples of their previous contributions and a plan for the first three months of what they will work on. This should also specify the number of hours per week that the individual will be sponsored for, and which budget the funds are to be allocated from. If fundraising is required, a project on the :xref:`Mautic Open Collective` can be established. From 9f87f47beeca6e6d42c1449a6be248972f37d5bb Mon Sep 17 00:00:00 2001 From: Ayu Adiati Date: Mon, 22 Sep 2025 06:50:24 +0200 Subject: [PATCH 3/5] fix internal links in contributing_to_mautic.rst --- docs/contributing/contributing_to_mautic.rst | 74 +++++++------------- 1 file changed, 24 insertions(+), 50 deletions(-) diff --git a/docs/contributing/contributing_to_mautic.rst b/docs/contributing/contributing_to_mautic.rst index 3b67e3f3f..eede4d12c 100644 --- a/docs/contributing/contributing_to_mautic.rst +++ b/docs/contributing/contributing_to_mautic.rst @@ -26,95 +26,71 @@ There are many opportunities for designers to get involved with the Mautic Commu We also need UX designers to help us when we're bringing in new features to Mautic - you can help us with creating wireframes, defining the user experience, and guiding developers on best practices. -Find out :doc:`how to get involved`. +Find out :doc:`how to get involved `. -.. Replace the title with :doc:`/contributing/developer`. See line 22 as an example. - -Developer -========= +:doc:`Developer ` +========================================== As a developer, you can contribute to Mautic by reporting and fixing bugs, working on new features as part of Strategic Initiatives or community projects, test and code-review pull requests, creating demo plugins or applications to share with other developers who might want to get started with Mautic, and help us to improve our developer documentation. We also need developers to help us with maintaining and improving our web-based resources, such as the main ``mautic.org`` website and our Grav-based documentation websites. -.. Replace "how to get involved" with :doc:`how to get involved`. See line 29 as an example. - -Find out how to get involved. +Find out :doc:`how to get involved `. -.. Replace the title with :doc:`/contributing/marketer`. See line 22 as an example. - -Marketer -======== +:doc:`Marketer ` +======================================== Help us to tell the world how awesome Mautic is. Marketers can help the Marketing Team in a range of areas from planning and executing campaigns, managing our paid advertising accounts, writing content for our website, supporting the monthly newsletter, and more. We also need marketers to support our release cycle, helping to get the message out about exciting new features and important information about new releases. -.. Replace "how to get involved" with :doc:`how to get involved`. See line 29 as an example. +Find out :doc:`how to get involved `. -Find out how to get involved. - -.. Replace the title with :doc:`/contributing/tester`. See line 22 as an example. - -Tester -====== +:doc:`Tester ` +==================================== Every new feature and bug fix has to be reviewed and tested by members of the Mautic Community. It's a great way to get started and makes a real difference to how quickly we can release bug fixes and features. If you have a basic knowledge of Mautic, you can help us as a tester. We also have a suite of automated tests which check the code to ensure that it hasn't broken any part of the product which is covered with tests. If you come from a QA/QE background we would also love your help to improve our processes and workflows. -.. Replace "how to get involved" with :doc:`how to get involved`. See line 29 as an example. - -Find out how to get involved. +Find out :doc:`how to get involved `. -.. Replace the title with :doc:`/contributing/translator`. See line 22 as an example. - -Translator -========== +:doc:`Translator ` +============================================ Mautic is currently available in 67 languages, which are all maintained by volunteers from around the world giving their time to translate Mautic into other languages. If you would like to help with this effort by translating or reviewing Mautic, or helping to internationalize other resources in the Mautic project, we'd love to have your help. -.. Replace "how to get involved" with :doc:`how to get involved`. See line 29 as an example. - -Find out how to get involved. +Find out :doc:`how to get involved `. -.. Replace the title with :doc:`/contributing/writing_for_mautic`. See line 22 as an example. - -Writer -====== +:doc:`Writer ` +================================================ Content makes the world go round, right? We have many opportunities for writers to support the Mautic Community, whether that be through writing, proofreading and editing content for our website, reviewing and optimising existing pages, creating compelling content for our marketing and communications or supporting the Education Team as a technical writer. -.. Replace "how to get involved" with :doc:`how to get involved`. See line 29 as an example. - -Find out how to get involved. +Find out :doc:`how to get involved `. :doc:`Community Builder ` ========================================================== Our community is at the heart of Mautic, and community builders are the people who help us to grow and nurture that community. The Community Team have quite a wide remit, and there are a lot of opportunities to get involved with supporting Mautic as a community builder. Whether you want to support local communities, or help people to get started as a contributor, or want to find ways to reach out into other open source communities, we've got lots of ways to get involved. -Find out :doc:`how to get involved`. +Find out :doc:`how to get involved `. -.. Replace the title with :doc:`/contributing/event_organizer`. See line 22 as an example. - -Event organizer -=============== +:doc:`Event organizer ` +====================================================== Events are the beating heart of a thriving open source community, and we have quite a lot of them happening throughout the year. We hold an in-person event annually which moves continent each year, in addition to Mautic Conference Global which is held virtually. Local communities can also host a MautiCamp event - a localised conference for people in that region - and Mautic Meetups which are smaller monthly gatherings of Mauticians. Whether you want to help with the big international events or the regional and local events, there are lots of opportunities to put your expertise to good use and help bring Mauticians together in-person, online, or in a combination of the two. -.. Replace "how to get involved" with :doc:`how to get involved`. See line 29 as an example. - -Find out how to get involved. +Find out :doc:`how to get involved `. :doc:`Web developer ` ================================================== The Mautic Community has several web assets which require regular updates, improvements and development of new features. If you're a keen web developer and have experience with WordPress, we'd love to hear from you. While our website is hosted by Hostnet, it is our responsibility to drive new developments and innovations. We'd love to build a web development team in the community specifically to look after our web properties and keep us moving forward. -Find out :doc:`how to get involved` +Find out :doc:`how to get involved ` :doc:`Server Administrator ` ================================================================ @@ -123,12 +99,10 @@ Several of our services and websites run on servers which need supporting. Our i If you're an experienced Linux systems administrator and would like to support Mautic by maintaining our servers, we'd love to have your help. -Find out :doc:`how to get involved`. - -.. Replace the title with :doc:`/contributing/contributing_financially`. See line 22 as an example. +Find out :doc:`how to get involved `. -Contributing financially to Mautic -================================== +:doc:`Contributing financially to Mautic ` +================================================================================== If you would like to financially support the Mautic Community, you can do so via :xref:`Mautic GitHub sponsor` or :xref:`Mautic open collective`. From 05bf8c42f46c320d4ba8120b5f137b505e57d27c Mon Sep 17 00:00:00 2001 From: Ayu Adiati Date: Mon, 22 Sep 2025 06:53:20 +0200 Subject: [PATCH 4/5] fix internal link in marketer.rst --- docs/contributing/marketer.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/contributing/marketer.rst b/docs/contributing/marketer.rst index 48844a682..b1336178b 100644 --- a/docs/contributing/marketer.rst +++ b/docs/contributing/marketer.rst @@ -16,9 +16,7 @@ That's why we need your help. The Mautic Community Marketing Team *********************************** -.. Link the "Marketing Team" section to the "Marketing Team" section in the community handbook. - -We have a Marketing Team which you can read more about on the Marketing Team section. +We have a Marketing Team which you can read more about on the :doc:`Marketing Team ` section. The team holds regular meetings, which anybody can join - just hop into the :xref:`Mautic marketing team Slack` channel on Slack, and you'll get a notification when the next meeting is coming up. From e00cbf05eb7883e8885d1dabffbdf1ec3c851486 Mon Sep 17 00:00:00 2001 From: Ayu Adiati Date: Mon, 22 Sep 2025 06:58:39 +0200 Subject: [PATCH 5/5] list a 403 link in conf.py --- docs/conf.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 8f787b40f..d358d7eea 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -117,4 +117,6 @@ r"https://www.canva.com/*", # Anchor is picked up as not found r"https://github.com/mautic/mautic-community-handbook/blob/main/.github/CONTRIBUTING.md#create-a-new-link", + # 403 errors from this domain + r"https://www.npmjs.com/" ]