Skip to content

add: admin field/audit log mappings #1146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Oct 10, 2022
Merged

add: admin field/audit log mappings #1146

merged 2 commits into from
Oct 10, 2022

Conversation

ericpaulsen
Copy link
Member

adds tables for the expected outputs of admin setting changes in the audit log.

@ericpaulsen ericpaulsen added docs 📝 Improvements or additions to documentation enhancement ✨ New feature or request labels Oct 7, 2022
@ericpaulsen ericpaulsen self-assigned this Oct 7, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Oct 7, 2022 •
edited
Loading

✨ Coder.com for PR #1146 deployed! It will be updated on every commit.

bpmct
bpmct approved these changes Oct 7, 2022
View reviewed changes
Copy link
Member

@bpmct bpmct left a comment

Choose a reason for hiding this comment

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

This is super thorough! Awesome addition to the docs.

Do we have a plan for how we update this when new features are added? It may be infrequent, but perhaps code comments or something would help us remember to update this?

admin/audit.md

## Admin logged events

With the exception of a few, logged events made by Admin panel changes will output
Copy link
Member

Choose a reason for hiding this comment

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

Should we document the exception?

Copy link
Member Author

Choose a reason for hiding this comment

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

we should, but those will be added soon, so we'd have to go back and remove it. i'm thinking whatever is not documenting isn't logged. what do you think?

Copy link
Member

Choose a reason for hiding this comment

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

that's fair.

@ericpaulsen ericpaulsen merged commit 8de2e54 into main Oct 10, 2022
@ericpaulsen ericpaulsen deleted the audit-log-diffs branch October 10, 2022 23:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bpmct bpmct bpmct approved these changes

@sharkymark sharkymark Awaiting requested review from sharkymark

@Emyrk Emyrk Awaiting requested review from Emyrk

Assignees

@ericpaulsen ericpaulsen

Labels
docs 📝 Improvements or additions to documentation enhancement ✨ New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ericpaulsen @bpmct