gravitational / gravitational/teleport
Update the Audit Events and Records guide
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Go
- Stars
- 20.9k
- Forks
- 2.2k
- PR merge metrics
- No merged PRs in 30d
Description
Applies To
/reference/deployment/monitoring/audit/
Details
Let's rethink the role, placement, and content of this guide, plus bring the guide up to date.
- It's in the Reference section but contains general, conceptual information about the audit log. Put the conceptual information in the zero-trust-access/management/diagnostics section.
- Much of the text dates from an early version of the Teleport docs. For example, we refer to pages as "chapters", which we haven't done in a long time. Give this guide a read-through and update anything outdated.
- The incomplete list of audit events is unnecessary now that we have an auto-generated audit event reference. Remove the incomplete list and link to the auto-generated page.
How will we know this is resolved?
We have either:
- Completed the checklist items above.
- Removed the guide, as most of the content in the guide is covered elsewhere.
Related Issues
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/pages/reference/deployment/monitoring/audit.mdx and compare it with the docs/pages/zero-trust-access/management/diagnostics section and docs/pages/reference/audit-events.mdx. Review the guide's placement and wording, remove the incomplete event list in favor of the generated reference, and either complete the checklist or remove the guide if its content is covered elsewhere.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100