Skip to content

docs: Document Contact change log CSV export feature#800

Open
promptless-for-oss wants to merge 2 commits into
mautic:7.1from
Promptless:promptless/contact-change-log-export
Open

docs: Document Contact change log CSV export feature#800
promptless-for-oss wants to merge 2 commits into
mautic:7.1from
Promptless:promptless/contact-change-log-export

Conversation

@promptless-for-oss

Copy link
Copy Markdown
Contributor

Open this suggestion in Promptless to view citations and reasoning process

Documents the Contact change log CSV export feature, addressing a documentation gap revealed by PR #15994 which fixed a mislabeled column header in this export.

Changes

contacts/manage_contacts.rst

  • New subsection: Exporting the change log - Added under the History section documenting:
    • The ability to export a Contact's change log to CSV for offline analysis or record-keeping
    • Information about the CSV columns (timestamp, action, details, user/source)
    • How to access the export via the dropdown menu on the Contact detail page

Context

PR #15994 fixed a bug where the CSV header column was labeled eventName when it should have been userSourceName to accurately reflect the data in that column. The documentation correctly describes this column conceptually as "the user or source that triggered the change" without referencing the technical header name. This PR has now been merged.

Trigger Events


Tip: Point @Promptless at some of your docs debt and have it clean them up in the background 🧹

Some Plugins contain specific events. The events display and are searchable after installing and configuring the Plugin.

Exporting the change log
------------------------

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR #15994 fixes a mislabeled CSV header in the Contact change log export (eventName → userSourceName). This documentation addition addresses the gap revealed by that fix - the export feature was previously undocumented. File: app/bundles/LeadBundle/Controller/AuditlogController.php

Source: mautic/mautic#15994

@adiati98

Copy link
Copy Markdown
Contributor

@promptless-for-oss, there are many unrelated old commits. Please rebase this to 7.1.

@adiati98 adiati98 added this to the Mautic 7.1 milestone Jun 27, 2026
Add documentation for the ability to export a Contact's change log to CSV
from the Contact detail page, addressing a documentation gap revealed by
PR #15994 which fixed a mislabeled column header in this export.
@promptless-for-oss promptless-for-oss force-pushed the promptless/contact-change-log-export branch from 9fe2bf7 to 26d9b7b Compare June 27, 2026 09:06
@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Thanks @adiati98! I've rebased this onto the latest 7.1 — the branch now has a single commit and the PR diff shows only the intended change to docs/contacts/manage_contacts.rst (the new "Exporting the change log" subsection). The unrelated old commits are gone.

@adiati98 adiati98 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@promptless-for-oss please address the suggestions.

Comment thread docs/contacts/manage_contacts.rst Outdated
Comment thread docs/contacts/manage_contacts.rst
- Capitalize 'User' in CSV columns description
- Wrap export step in .. vale off / .. vale on per maintainer request
@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Thanks @adiati98 — both suggestions have been applied and pushed to the branch.

  • Updated the change log export description to: "You can export the Contact's change log to CSV for offline analysis or record-keeping. The CSV includes columns for each event's timestamp, action, details, and the User or source that triggered the change."
  • Updated the export step to your wording, wrapped in .. vale off / .. vale on as suggested.

The change is scoped to docs/contacts/manage_contacts.rst. Ready for another look.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants