warderhomelab/homelab-compose
1
0
Fork 0
Code Issues 3 Pull requests 5 Projects Releases Packages Wiki Activity Actions

Standardize README sections for legacy stacks #24

New issue
Open
opened 2026-06-21 05:10:30 +00:00 by pwarder · 0 comments
pwarder commented 2026-06-21 05:10:30 +00:00
Owner
Copy link

README Standardization

Update legacy stack documentation so each deployable stack README includes the required sections.

Affected Stacks

  • apps/actual-budget/README.md

    • Add ## Configuration
    • Add ## Backups

  • networking/unpoller/README.md

    • Add ## Configuration
    • Add ## Backups
    • Add ## Upgrades and Template Portability

  • networking/wireguard/README.md

    • Add ## Configuration
    • Add ## Backups
    • Add ## Upgrades and Template Portability

Completion Criteria

  • python3 scripts/validate_readmes.py passes.
  • README changes remain generic.
  • No deployment-specific values or secrets are added.
  • README validation is then added to local make validate and Forgejo CI.
# README Standardization Update legacy stack documentation so each deployable stack README includes the required sections. ## Affected Stacks - [ ] `apps/actual-budget/README.md` - Add `## Configuration` - Add `## Backups` - [ ] `networking/unpoller/README.md` - Add `## Configuration` - Add `## Backups` - Add `## Upgrades and Template Portability` - [ ] `networking/wireguard/README.md` - Add `## Configuration` - Add `## Backups` - Add `## Upgrades and Template Portability` ## Completion Criteria - [ ] `python3 scripts/validate_readmes.py` passes. - [ ] README changes remain generic. - [ ] No deployment-specific values or secrets are added. - [ ] README validation is then added to local `make validate` and Forgejo CI.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
renovate/docker-image-updates
renovate/postgres-18.x
renovate/mysql-9.x
renovate/mariadb-12.x
renovate/ghcr.io-immich-app-postgres-16.x
chore/template-audit
No results found.
Labels
Clear labels   
bug
Something is not working

  
duplicate
This issue or pull request already exists

  
enhancement
New feature

  
help wanted
Need some help

  
invalid
Something is wrong

  
priority: high
Important work that should be addressed soon

  
priority: low
Non-urgent improvement or future consideration

  
question
More information is needed

  
status: blocked
Waiting on another task, decision, upstream fix, or dependency

  
status: needs-triage
Needs initial review or categorization

  
status: ready
Ready to be worked on

  
type: ci
Forgejo Actions, validation, Renovate, pre-commit, or automation work

  
type: dependencies
Image, package, or Renovate dependency updates

  
type: documentation
README, catalog, standards, policy, or other documentation work

  
type: new-stack
Request or work to add a new Docker Compose stack template

  
type: security
Security hardening, secret handling, or vulnerability-related work

  
wontfix
This won't be fixed

No labels
bug
duplicate
enhancement
help wanted
invalid
priority: high
priority: low
question
status: blocked
status: needs-triage
status: ready
type: ci
type: dependencies
type: documentation
type: new-stack
type: security
wontfix
Milestone
Clear milestone
No items
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
warderhomelab/homelab-compose#24
No description provided.