Document the `audit` module API
Open
Nobody has claimed this yet.
EE
reference
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Branches: 2.11, latest
Product: Tarantool Enterprise
Since: 2.10
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/
https://www.tarantool.io/en/doc/latest/enterprise/audit_log/#enterprise-audit-module
SME: @ locker
Details
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
Read the audit module source at src/box/lua/audit.lua and compare it with the existing enterprise audit page and Lua reference root document. Document the module's API for the 2.11 and latest branches, using the source as the reference; done means the audit API is covered in the appropriate documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100