mautic / mautic/user-documentation
Add Resources and FAQ section in the user guide
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 22
- Forks
- 76
- Avg merge
- 22h 9m
- Merged PRs (30d)
- 33
Description
@fakela
The current How to Update page has a section on "What to do if you need help updating Mautic?". This section is repeated several times across different pages. We can add a section in the user guide as Resources and FAQ. As needed, writers can point the readers to this section for reference.
Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.
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 current How to Update page at https://docs.mautic.org/en/setup/how-to-update-mautic and locate the repeated “What to do if you need help updating Mautic?” section across the user guide. Create a Resources and FAQ section, then check the affected pages so writers can reference it instead of repeating the content. Done means the shared section exists and the relevant pages point readers to it.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100