Summary
The current documentation does not fully reflect the validated state of the project.
Honeynet now supports an end-to-end workflow that includes:
- multi-region honeypot deployment
- centralized raw log collection
- Lambda-based enrichment
- Glue schema discovery
- Athena querying
However, the project documentation still under-explains:
- the broader framework vision beyond the current Cowrie implementation
- the local environment setup required to run the project
- the deployment and testing workflow from AWS login through Athena validation
- contribution expectations for future infrastructure, telemetry, and documentation work
Problem
The README and supporting documentation are currently too high-level for a new contributor or evaluator to follow the full setup and validation path confidently.
This makes onboarding harder and undersells the actual project maturity.
Scope
- refresh the README to describe Honeynet as a broader honeypot framework
- explain that Cowrie is the current validated implementation, not the long-term limit
- document local environment setup in detail
- document AWS CLI authentication and prerequisites
- document deployment and testing workflow step by step
- document Glue and Athena usage
- add or update contribution guidelines to match the current repo and workflow
Acceptance Criteria
- README reflects the current validated architecture
- setup steps are clear from AWS authentication to deployment and testing
- Glue and Athena workflow are documented
- contribution guidelines are available and aligned with the current project direction
Summary
The current documentation does not fully reflect the validated state of the project.
Honeynet now supports an end-to-end workflow that includes:
However, the project documentation still under-explains:
Problem
The README and supporting documentation are currently too high-level for a new contributor or evaluator to follow the full setup and validation path confidently.
This makes onboarding harder and undersells the actual project maturity.
Scope
Acceptance Criteria