Skip to content

Docs: Add Roles page #281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adiati98 wants to merge 3 commits into
base: 5.x
Choose a base branch
from
Open

Docs: Add Roles page #281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d09b8ad
add links/mautic_roles_api_legacy.py
adiati98 Dec 12, 2025
894b06c
add roles page
adiati98 Dec 12, 2025
809b2a9
add vale off and on statements
adiati98 Dec 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@ There are several ways to support Mautic other than contributing with code.
rest_api/notifications
rest_api/point_groups
rest_api/reports
rest_api/roles
rest_api/text_messages

.. toctree::
Expand Down
7 changes: 7 additions & 0 deletions docs/links/mautic_roles_api_legacy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from . import link

link_name = "Roles file"
link_text = "Roles file"
link_url = "https://github.com/mautic/developer-documentation/blob/main/source/includes/_api_endpoint_roles.md"

link.xref_links.update({link_name: (link_text, link_url)})
14 changes: 14 additions & 0 deletions docs/rest_api/roles.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Roles
#####

.. vale off

.. note::

The content for this page requires a major update. The legacy page contains outdated and potentially inaccurate information. But you can still access it in the :xref:`Roles file` of the archived ``developer-documentation`` repository.

If you're interested in helping develop the new content for this page and others, consider joining the documentation efforts.

Please read the Contributing Guidelines to get started.
Copy link
Contributor Author

@adiati98 adiati98 Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: The link to the contributing guidelines will follow as we don't have it yeat atm.


.. vale on