Campaign import export user docs - #361
Conversation
|
Note that these docs should be targeted to Mautic v7.x but that branch is not available yet. |
passive -> active... hopefully
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
5defae6 to
4f4b529
Compare
|
Added further parameter to the command line for export |
There was a problem hiding this comment.
Pull request overview
Adds end-user documentation for Campaign import/export and links it into the existing docs navigation and CLI command reference.
Changes:
- Added new Campaign import and export documentation pages, including UI, CLI, and API usage.
- Linked the new pages into the Campaigns section of the main docs index.
- Updated the CLI command reference to include campaign import/export commands and improved the “bin/console” guidance.
Reviewed changes
Copilot reviewed 4 out of 13 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/index.rst | Adds the new import/export pages to the Campaigns toctree for navigation. |
| docs/configuration/command_line_interface.rst | Updates CLI guidance and adds campaign import/export commands to the command list. |
| docs/campaigns/importing_campaigns.rst | New page documenting Campaign imports via UI, CLI, and API. |
| docs/campaigns/exporting_campaigns.rst | New page documenting Campaign exports via UI, CLI, and API. |
| docs/campaigns/images/upload_zip_file.png | Adds a screenshot used by the import docs. |
| docs/campaigns/images/campaign_active_toggle_button.png | Adds a screenshot used by the import docs. |
| .gitignore | Minor formatting/indent fix at EOF comment line. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
adiati98
left a comment
adiati98
left a comment
There was a problem hiding this comment.
Let's address the review from @RCheesley.
|
@mautic/core-team can you please review the suggested changes by me here if they're correct in addressing @RCheesley's reviews? TIA! ✨ |
|
Thank you for reaching out. I am currently unavailable, but I have alerted the team who will respond as appropriate. |
|
Thanks @adiati98 - all four points look good from my side (Copilot's right on --data '' forcing POST, the lead-in reads clearly, Republish Behavior fixes are in, and surfacing the existing placeholder admonition covers Ruth's point). No blockers from me! |
adiati98
left a comment
adiati98
left a comment
There was a problem hiding this comment.
Move API replacement instructions before code examples for better visibility.
|
Went through the full docs - overall looks good. Left a few inline comments on small technical fixes, rest is solid. Good job. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>
adiati98
left a comment
adiati98
left a comment
There was a problem hiding this comment.
We need to address the Vale warnings and tidy up some things.
Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>
vukovicpredrag
left a comment
vukovicpredrag
left a comment
There was a problem hiding this comment.
Two small CLI flag fixes - details inline:
- exporting_campaigns.rst:
--json-fileshould be--json-only(that flag doesn't exist). - command_line_interface.rst:
--zip-fileis a boolean (VALUE_NONE), so--zip-file=path/...fails. Use--zip-file --path=path/to-file.
Verified against EntityExportCommand / EntityImportCommand in core. Rest of the examples match the codebase.
adiati98
left a comment
adiati98
left a comment
There was a problem hiding this comment.
@vukovicpredrag sorry, I missed your latest review! Are these changes addressing your review correctly?
|
@adiati98 No worries. Both suggestions are correct and address the review exactly. Thank you! |
Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>
I've committed the changes. Can you please review this again or approve it if you feel like everything's already good to go? Thanks, @vukovicpredrag! |
vukovicpredrag
left a comment
vukovicpredrag
left a comment
There was a problem hiding this comment.
Re-reviewed against core - everything checks out (UI/CLI import, export flags, API routes, Republish Behavior, plugin validation). Only one minor note on the JSON import example (inline) - can be a quick follow-up. Approving! Thanks @adiati98 🚀
Added descriptions for campaign import and campaign export.