Skip to content

docs: Document the Projects feature (7.1)#834

Open
promptless-for-oss wants to merge 1 commit into
mautic:7.1from
Promptless:promptless/projects-feature-7.1
Open

docs: Document the Projects feature (7.1)#834
promptless-for-oss wants to merge 1 commit into
mautic:7.1from
Promptless:promptless/projects-feature-7.1

Conversation

@promptless-for-oss

Copy link
Copy Markdown
Contributor

Open this suggestion in Promptless to view citations and reasoning process

Adds a new Projects overview page documenting the Mautic Projects feature for the 7.1 branch: what Projects are, creating/managing/deleting Projects (including the duplicate-name check added in 7.1), the two ways to assign items, the assignable item types, the project: search command, and the Project permission set including the Associate permission. Registers the page in the docs toctree after Categories.

Trigger Events

  • Deep Analysis: Our docs missing an info about Projects feature. Info might be different between branches (perhaps there are additional functionalities for ea...

Tip: Filter the Dashboard by labels or assignees to focus on what matters to you 🔎


Projects give you one place to group everything that belongs to a single marketing initiative. Instead of hunting for the Campaigns, Emails, Segments, and other items behind a launch, you assign them all to a Project and manage them together. A Project works like a folder that spans item types, so you can see how the pieces of an initiative fit together and find related items quickly.

You can assign many item types to a Project, including Asset, Campaign, Company, Dynamic Content, Email, Focus Item, Form, Landing Page, Marketing Message, Point, Point Trigger, Segment, Stage, and Text message.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The list of assignable item types (Asset, Campaign, Company, Dynamic Content, Email, Focus Item, Form, Landing Page, Marketing Message, Point, Point Trigger, Segment, Stage, Text message) comes from the entity types that use ProjectTrait and are discovered by ProjectEntityLoaderService in the 7.1 ProjectBundle.

Source: https://github.com/mautic/mautic/blob/7.1/app/bundles/ProjectBundle/Service/ProjectEntityLoaderService.php

To create a Project, select New, then give it a name and an optional description. Each Project name must be unique. If you enter a name that's already in use, Mautic displays 'A project with this name already exists.' and asks you to choose another.

To delete one or more Projects, select them in the list and choose Delete. Deleting a Project removes the references to it from every assigned item, but it doesn't delete the items themselves.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The unique-name requirement and the exact message 'A project with this name already exists.' come from validators.ini (project.name.already.exists) in the 7.1 ProjectBundle; this friendly validator exists in 7.1 (Validator/UniqueName) but not in 7.0.

Source: https://github.com/mautic/mautic/blob/7.1/app/bundles/ProjectBundle/Translations/en_US/validators.ini


.. vale on

Use the ``project`` search command to filter any supported list down to the items in a Project. In the search box, enter ``project:name`` to show only the items assigned to that Project. For example, ``project:"Summer Launch"`` returns every item assigned to the 'Summer Launch' Project.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

UI labels 'Hit enter to create', 'Add new to project', 'Remove from project', the Projects menu item, and the project search command (mautic.project.searchcommand.name) are taken verbatim from messages.ini in the 7.1 ProjectBundle.

Source: https://github.com/mautic/mautic/blob/7.1/app/bundles/ProjectBundle/Translations/en_US/messages.ini

@adiati98 adiati98 added this to the Mautic 7.1 milestone Jul 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants