Merge branch '5.x' into moving-templates-docs-to-subfolder

Author: adiati98

.github/styles/Mautic/FeatureList.yml

@@ -39,13 +39,18 @@ swap:
   leads: Contacts
   marketing message: Marketing Message
   marketing messages: Marketing Messages
+  mautic: Mautic
   page: Landing Page
   pages: Landing Pages
   point actions: Point Actions
   point triggers: Point Triggers
   points: Points
+  point group: Point Group
+  point groups: Point Groups
   plugin: Plugin
   plugins: Plugins
+  publish: Activate or Turn On
+  published: Active or Available
   report: Report
   reports: Reports
   role: Role
@@ -54,11 +59,11 @@ swap:
   segments: Segments
   stage: Stage
   stages: Stages
-  sync engine: Sync Engine
-  sync report: Sync Report
   theme: Theme
   themes: Themes
+  unpublish: Deactivate or Turn Off
+  unpublished: Unavailable or Deactivated
   user: User
   users: Users
   webhook: Webhook
-  webhooks: Webhooks
+  webhooks: Webhooks

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

@@ -41,6 +41,7 @@ CORS
 cron
 Cron
 CTRL
+datetime
 DDEV
 DNC
 Do Not Contact
@@ -94,6 +95,7 @@ middlewares
 MJML
 Multiselect
 multiselect
+MVC
 MVP
 mysqldump
 Namespace

.readthedocs.yaml

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

docs/components/config.rst

@@ -1,8 +1,17 @@
 Welcome to Mautic's developer documentation
-===========================================
+###########################################
+
+.. vale off
 
 .. note::
-    Work is ongoing bringing over some of the content from the old documentation, which you can find at :xref:`Mautic Developer Portal`. Please see the :xref:`Mautic Dev Docs Issues` if you'd like to help with completing this work.
+
+   The content for this documentation requires a major update. The legacy documentation contains outdated and potentially inaccurate information. You can still access it in the :xref:`legacy repository`.
+
+   If you're interested in helping develop the new content for this documentation, consider joining the documentation efforts.
+
+   Please read the :xref:`dev docs contributing guidelines` and :xref:`Contributing to Mautic’s documentation` to get started.
+
+.. vale on
 
 Welcome to the Mautic Developer Documentation. The documentation broadly covers building custom Plugins for Mautic which extends its features, building custom Themes, and how to integrate applications outside of Mautic using the REST API.
 
@@ -120,53 +129,121 @@ There are several ways to support Mautic other than contributing with code.
    plugins/event_listeners
    plugins/installation
    plugins/data
+   plugins/cache
    plugins/translations
-   plugins/continuous-integration
-   plugins/from-4-to-5
+   plugins/continuous_integration
+   plugins/update_m4_to_m5
+   plugins/mvc
+   plugins/permissions
 
 .. toctree::
    :maxdepth: 3
-   :caption: Extending Mautic
+   :caption: Plugin Extensions
    :hidden:
 
-   components/api
-   components/cache
-   components/campaigns
-   components/categories
-   components/channels
-   components/config
-   components/contacts
-   components/core
-   components/emails
-   components/forms
-   components/forms_advanced
-   components/integrations
-   components/ip_lookups
-   components/landing_pages
-   components/maintenance
-   components/points
-   components/queue
-   components/reports
-   components/security
-   components/tracking_script
-   components/translator
-   components/ui
+   plugin_extensions/manipulating_contacts
+   plugin_extensions/api
+   plugin_extensions/campaigns
+   plugin_extensions/categories
+   plugin_extensions/channels
+   plugin_extensions/contacts
+   plugin_extensions/emails
+   plugin_extensions/forms
+   plugin_extensions/forms_advanced
+   plugin_extensions/integrations
+   plugin_extensions/landing_pages
+   plugin_extensions/maintenance
+   plugin_extensions/points
+   plugin_extensions/reports
+   plugin_extensions/ui
+   plugin_extensions/webhooks
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Plugin Integrations
+   :hidden:
+
+   plugin_integrations/integrations
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Plugin Services
+   :hidden:
+
+   plugin_services/cookie_helper
+   plugin_services/database
+   plugin_services/event_dispatcher
+   plugin_services/factory
+   plugin_services/ip_lookups
+   plugin_services/mail_helper
+   plugin_services/model_factory
+   plugin_services/parameters
+   plugin_services/paths_helper
+   plugin_services/plugin_config_helper
+   plugin_services/request
+   plugin_services/router
+   plugin_services/security
+   plugin_services/session
+   plugin_services/translator
+   plugin_services/user
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Miscellaneous
+   :hidden:
+
+   plugin_miscellaneous/commands
+   plugin_miscellaneous/events
+   plugin_miscellaneous/flash_messages
+   plugin_miscellaneous/forms
+   plugin_miscellaneous/helpers
+   plugin_miscellaneous/translated_entities
+   plugin_miscellaneous/variant_entities
 
 .. toctree::
    :maxdepth: 2
    :caption: REST API
    :hidden:
 
+   rest_api/api_intro
+   rest_api/authorization
    rest_api/assets
    rest_api/campaigns
    rest_api/categories
+   rest_api/companies
    rest_api/contacts
+   rest_api/data
+   rest_api/dynamic_content
+   rest_api/emails
    rest_api/fields
+   rest_api/files
+   rest_api/focus
+   rest_api/forms
+   rest_api/messages
+   rest_api/notes
    rest_api/notifications
+   rest_api/pages
+   rest_api/point_actions
    rest_api/point_groups
+   rest_api/point_triggers
    rest_api/reports
    rest_api/roles
+   rest_api/segments
+   rest_api/stages
+   rest_api/stats
+   rest_api/tags
    rest_api/text_messages
+   rest_api/themes
+   rest_api/tweets
+   rest_api/users
+   rest_api/webhooks
+
+.. toctree::
+   :maxdepth: 2
+   :caption: MauticJS API
+   :hidden:
+
+   mauticjs_api/tracking_script
 
 .. toctree::
    :maxdepth: 2

docs/components/core.rst

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "DoctrineCacheBundle docs" 
+link_text = "DoctrineCacheBundle documentation" 
+link_url = "https://www.doctrine-project.org/projects/doctrine-cache-bundle/en/1.3/index.html" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/components/queue.rst

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "API library package" 
+link_text = "Mautic API library package" 
+link_url = "https://github.com/mautic/api-library/archive/master.zip" 
+
+link.xref_links.update({link_name: (link_text, link_url)})