GitHub Promotion Checklist

Maintainer note: this page is for repository maintainers, not server operators.

This checklist complements repository files and requires some GitHub UI settings.

1) Configure repository About (GitHub UI)

In Settings -> General -> About:

  • Description:
    • Production-ready VPS bootstrap for Coolify on Ubuntu 24 with VPS init hardening and recovery runbooks.
  • Website:
    • https://rigu.github.io/vps-coolify-bootstrap/
  • Topics:
    • coolify
    • vps-init
    • ubuntu-24-04
    • vps
    • devops
    • self-hosted
    • docker
    • security

2) Keep README optimized

Already applied in this repo:

  • concise keyword-focused intro
  • trust badges (CI, Pages, License, Release, Last Commit)
  • clear docs CTA
  • visual overview image

3) Keep releases active

  • create semantic tags (v1.0.0, v1.1.0, …)
  • include concise release notes and migration notes
  • link docs updates in release notes

4) Improve external SEO

  • publish one technical article/tutorial linking to this repo
  • add backlinks from related docs/projects
  • keep docs pages updated and internally linked

5) Community and trust files

Already included:

  • CONTRIBUTING.md
  • SECURITY.md
  • CODE_OF_CONDUCT.md
  • SUPPORT.md
  • LICENSE
  • CITATION.cff

Back to Docs Home