Document the flarum/audit extension (1.x and 2.x)#535
Merged
Conversation
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.
flarum/audit extension (1.x)
…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
flarum/audit extension (1.x)flarum/audit extension (1.x and 2.x)
|
I'm a bit late to the game, but some suggestions:
|
Address review feedback on #535: - Use "audit log" consistently in the introduction paragraphs. - Explain why the two permission levels exist (PII/GDPR minimisation).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds documentation for the first-party
flarum/auditextension, 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:
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.extend/audit, "Integrating with Audit") — how any extension records its own actions via the publicFlarum\Audit\Extend\Auditextender behind an optionalflarum/auditdependency: event listeners, statefulusing()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.