mautic / mautic/developer-documentation-new

Write the documentation to support the Campaign import/export features

Open
#239 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

We are coming to the end of the development of the campaign import and export features. We will need to publish docs to support.
I have put together a brief that contains the majority of the information required, I need some help with producing the final docs in the correct format in the correct places in Mautic's structure. The brief is here: https://docs.google.com/document/d/16rHthCcfwTOnh_GGOKwLB-Ahy_SzpXNv7AkR3Rk3Kwo/edit?usp=sharing
We are aiming to complete testing in 2-3 weeks with the final release of code being soon after.

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 by reading the linked Google Docs brief and inspecting the developer-documentation-new repository structure to identify where Campaign import/export documentation belongs. Confirm the required format and locations with the project maintainers, then document the completed features in those locations and verify the rendered documentation before considering the work done.

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
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.