mautic / mautic/developer-documentation-new
[DOCS]: Add "Notes" page to branch 7.0
Nobody has claimed this yet.
- 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:
- Contributing guidelines
- Contributing to Mautic’s documentation
- Mautic technical writing style guide
- The "Suggestions (Optional)" section below for guides on how to update the page
- Mautic API Library
Relevant Documentation URL
https://devdocs.mautic.org/en/7.0/rest_api/notes.html
Link to the content at legacy docs
https://github.com/mautic/developer-documentation/blob/main/source/includes/_api_endpoint_notes.md
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.htmlFor example, if the relevant URL is
https://devdocs.mautic.org/en/7.0/plugin_extensions/manipulating_contacts.html, then findmanipulating_contacts.rstfile inside theplugin_extensionsfolder. -
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the legacy content in source/includes/_api_endpoint_notes.md and the contributing and technical writing guidance linked in the issue. Create or update the corresponding docs/rest_api/notes.rst page, convert the content to RST, and revise it as appropriate; done means the Notes page is complete at the 7.0 REST API URL.
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
- Clearly specified
- Newbie friendliness
- 72/100