mautic / mautic/developer-documentation-new

[DOCS]: Add "Commands" page to branch 7.0

Open
#394 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue
Dominant language
Shell
Stars
19
Forks
48
Avg merge
1d 16h
Merged PRs (30d)
25

Description

Description

We need to move the content from legacy repo and convert it to RST, as well as update the content.


[!IMPORTANT]
Please read the below resources before contributing to help you with this task:


Relevant Documentation URL

https://devdocs.mautic.org/en/7.0/plugin_miscellaneous/commands.html

Are you willing to help us fix this by making a pull request?

No

Suggestions (Optional)
How to update the page
  • Find the file that needs to be updated in the docs/ directory. The dev docs URL format is as such:

    https://devdocs.mautic.org/en/x.x/FOLDER_NAME/FILE_NAME.html
    

    For example, if the relevant URL is https://devdocs.mautic.org/en/7.0/plugin_extensions/manipulating_contacts.html, then find manipulating_contacts.rst file inside the plugin_extensions folder.

  • Transfer the content under the note admonition. Look at other pages on how to structure the content.

  • Review and update the content when you see fit.

  • Follow the contributing guidelines that are listed in the "Resources" section above.

Screenshots or Screen Recordings (Optional)

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the 7.0 page URL and locate the corresponding file under docs/plugin_miscellaneous, following the documented URL-to-file pattern. Review the contributing guidelines, documentation guidance, and style guide before transferring the legacy content into RST. Done means the Commands page exists in the 7.0 documentation, its content has been reviewed and updated, and it follows the project’s documentation conventions.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.