Update documentation standards and project changelog
Update CLAUDE.md guidelines and CHANGELOG.md to reflect recent infrastructure improvements and documentation enhancements. Changes to CLAUDE.md: - Fix markdown code block formatting in role documentation template - Enhance role/playbook/plays organization section - Clarify documentation structure requirements: * Roles must have CHANGELOG.md and ROADMAP.md in role directories * ./playbooks/ contains roles-related plays * ./plays/ for temporary, non-lasting plays * Cheatsheets organized by type (role/play/playbook) * Documentation organized by type (role/play/playbook) - Strengthen requirements: "MUST HAVE" for role documentation Changes to CHANGELOG.md: - Document comprehensive documentation structure additions - Record system_info role implementation - Track compliance improvement from 45% to 95%+ - Document new directories and file structure: * cheatsheets/ organized by role/playbook/plays * docs/architecture/ for infrastructure documentation * docs/roles/ for detailed role documentation * docs/security-compliance.md for CIS/NIST mappings Added documentation components: - Role cheatsheets and detailed documentation - Architecture documentation (overview, network, security) - Security compliance mapping (CIS, NIST CSF, NIST 800-53) - Troubleshooting guide - Variables documentation with naming conventions This update brings the project documentation to organizational standards and significantly improves maintainability and knowledge transfer. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
22
CLAUDE.md
22
CLAUDE.md
@@ -525,12 +525,12 @@ List of dependent roles.
|
||||
|
||||
## Example Playbook
|
||||
|
||||
\```yaml
|
||||
```yaml
|
||||
- hosts: servers
|
||||
roles:
|
||||
- role: role_name
|
||||
var_name: value
|
||||
\```
|
||||
```
|
||||
|
||||
## Security Considerations
|
||||
|
||||
@@ -545,19 +545,17 @@ Organization license information
|
||||
## Author
|
||||
|
||||
Role maintainer contact information
|
||||
```
|
||||
|
||||
### Cheatsheets and documentation
|
||||
### roles, plays, playbooks, Cheatsheets and documentation
|
||||
|
||||
Cheatsheets are stored in `./cheatsheets/`, and documentation is saved in `./docs`.
|
||||
- Each role should have it's documentation and cheatsheet
|
||||
- Each playbook shall have it's cheatsheet.
|
||||
Each role will have it's own `ROADMAP.md`, `CHANGELOG.md` files located in `./roles/{role name}/{CHANGELOG,ROADMAP}.md`.
|
||||
|
||||
```
|
||||
cheatsheets/
|
||||
├── role-name.md
|
||||
└── common-tasks.md
|
||||
```
|
||||
`./playbooks` SHALL CONTAIN `roles` related plays.
|
||||
`./plays` SHALL BE USED for *temporary, non-lasting* plays.
|
||||
|
||||
Cheatsheets are stored in `./cheatsheets/{role,play,playbook}/`, and documentation saved in `./docs/{role,play,playbook}/`.
|
||||
- Each role MUST HAVE it's documentation and cheatsheet
|
||||
- Each playbook SHALL HAVE it's cheatsheet.
|
||||
|
||||
Cheatsheets should include:
|
||||
- Quick start commands
|
||||
|
||||
Reference in New Issue
Block a user