freedomofpress / freedomofpress/securedrop-dev-docs
add OSSEC overview for developers
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 4
- Avg merge
- 2h 22m
- Merged PRs (30d)
- 1
Description
Originally posted by @emkll in https://github.com/freedomofpress/securedrop-docs/pull/199#r613227289:
It would be helpful here to describe the 4 different OSSEC packages maintained here, what they contain, and what they are used for.
While freedomofpress/securedrop-docs#116 proposes consolidating the administrator-facing documentation in ossec_alerts.rst, this would give developers an overview of how the different OSSEC components fit together in a SecureDrop installation prior to the task-oriented documentation in the current development/updating_ossec.rst.
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 by reading development/updating_ossec.rst for the existing task-oriented material and ossec_alerts.rst for the administrator-facing context. Trace the four OSSEC packages maintained in the project and document what each contains and how the components fit together in a SecureDrop installation. Done means developers have a clear overview before using the update instructions.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100