Skip to content

Instantly share code, notes, and snippets.

@ZPascal
Last active August 11, 2026 12:37
Show Gist options
  • Select an option

  • Save ZPascal/8a5f55e0a253880e9841a4eb488a309d to your computer and use it in GitHub Desktop.

Select an option

Save ZPascal/8a5f55e0a253880e9841a4eb488a309d to your computer and use it in GitHub Desktop.
CF Docs findings and requirements
  • Markdown instead of the HTML
    • Direct feedback of the generated documentation
    • Easy to contribute and simple usage
    • Versioned documentation
    • Handle the migration simple
    • Use a simple templating engine instead of ERB/ Ruby templates
  • Switch the documentation engine, e.g. Docu Saurus, well maintained, open source
    • Renable the search feature
    • Search Engine Optimization
    • Agent support
    • Local development
  • Deployment of the new solution
    • Host it on GitHub via GH pages
    • Reduce the costs
    • The community should have full access to the system, similar to the Concourse GH CF teams mapping
    • Handle the domain, how to keep the old one and how to keep the transition
  • Organisational changes
    • Clarify the existing consumers of the cf docs
      • Ask the main maintainers if they us the documentaion for there products
    • We need a full timeline of the rollout
    • How should we handle review and PR handling? Automate it via Codeowner files?
    • Find out a list of all involved repositories for the docs
    • We should think about an extension functionality
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment