Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Generate documentation for audit log diffs #468

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.

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

Closed
Tracked by #684
misskniss opened this issue Mar 17, 2022 · 0 comments
Closed
Tracked by #684

Generate documentation for audit log diffs #468

misskniss opened this issue Mar 17, 2022 · 0 comments

Comments

@misskniss
Copy link

depends on: #467

The main issue with the current approach to diffing is that it’s done in a very Go native, decentralized way. This makes it very simple to add audit diffing to new features or data types, but it doesn’t make it easy to have a high level view of everything we provide diffs on. Documenting or auditing all of the diffs we produce would be very labor intensive.

While there is documentation for how to use the diff tags, because it is decoupled from where you write diff tags, the documentation is often not followed. There have been a couple cases where secrets have been leaked to the audit log, due to not using the secret tag (which allows you to diff a secret field by indicating it changed, but not logging the value) at all or using it incorrectly.

Option discussed:
generate a JSON blob

@misskniss misskniss added this to the V2 Beta milestone Mar 17, 2022
@misskniss misskniss mentioned this issue Mar 17, 2022
6 tasks
@misskniss misskniss modified the milestones: V2 Beta, Enterprise MVP Mar 30, 2022
@misskniss misskniss added docs Area: coder.com/docs api Area: HTTP API labels Jun 14, 2022
@kylecarbs kylecarbs changed the title Implement ability to use the single source to generate docs of all our diffs Generate documentation for audit log diffs Jun 22, 2022
@misskniss misskniss removed this from the Enterprise MVP milestone Jul 22, 2022
@bpmct bpmct closed this as not planned Won't fix, can't repro, duplicate, stale Jul 22, 2022
@misskniss misskniss added invalid and removed docs Area: coder.com/docs api Area: HTTP API labels Jul 26, 2022
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

No branches or pull requests

3 participants