Skip to content

Document the flarum/audit extension (1.x and 2.x)#535

Merged
imorland merged 3 commits into
mainfrom
im/audit-extension-docs
Jun 15, 2026
Merged

Document the flarum/audit extension (1.x and 2.x)#535
imorland merged 3 commits into
mainfrom
im/audit-extension-docs

Conversation

@imorland

@imorland imorland commented Jun 11, 2026

Copy link
Copy Markdown
Member

Adds documentation for the first-party flarum/audit extension, for both 1.x and 2.x.

Each version is split into two cross-linked pages, establishing a standard layout for documenting first-party extensions:

  • User / admin guide (extensions/audit) — requirements, installation, permissions, browsing & search, the IP country indicator, anatomy of an entry, removing data, the full list of logged actions, and known limitations. Listed under a new Bundled Extensions sidebar category.
  • Developer guide (extend/audit, "Integrating with Audit") — how any extension records its own actions via the public Flarum\Audit\Extend\Audit extender behind an optional flarum/audit dependency: event listeners, stateful using() integrations, the extender reference, and translating actions. Sits alongside the Realtime integration guide.

The 2.x docs additionally cover the new core/GDPR actions (group, developer token, settings reset, GDPR erasure/export) and recording the actor explicitly from a queued job.

Pairs with flarum/framework#4711.

Add a dedicated page for the first-party flarum/audit extension covering
permissions, browsing and search, the optional fof/geoip country indicator,
data removal, the full list of logged actions, and the public
Flarum\Audit\Extend\Audit extender for adding integrations. Register the
page in the 1.x guide sidebar.
@imorland imorland changed the title Document the Audit extension (1.x) Document theflarum/audit extension (1.x) Jun 11, 2026
…guides

- Add 2.x docs (extensions/audit + extend/audit), covering the new core/GDPR actions
- Split each version into a user/admin guide and a developer integration guide, cross-linked
- Add a 'Bundled Extensions' sidebar category; apply the same split + layout to 1.x for consistency
@imorland imorland changed the title Document theflarum/audit extension (1.x) Document the flarum/audit extension (1.x and 2.x) Jun 12, 2026
@claudiushenrichs

Copy link
Copy Markdown

I'm a bit late to the game, but some suggestions:

  • user guide: Use "audit log" consistently to refer to the log this extension keeps. Could be confused with the standard Flarum log that can be accessed via Log Viewer, so always referring to it by the full name should avoid ambiguity. Particularly important in the "Audit" introduction paragraphs.
  • For the "Permissions" paragraph: Add a sentence on why the two permission levels exist, e.g. second level is to protect personal identifiable information to be exposed to a wider moderation team / for minimizing PII exposure to follow data protection regulation like GDPR

Address review feedback on #535:
- Use "audit log" consistently in the introduction paragraphs.
- Explain why the two permission levels exist (PII/GDPR minimisation).
@imorland imorland merged commit a23298f into main Jun 15, 2026
@imorland imorland deleted the im/audit-extension-docs branch June 15, 2026 11:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants