Skip to content

About

Kill Bill documentation

Topics

Resources

Contributing

Stars

44 stars

Watchers

4 watching

Forks

Repository files navigation

Docs

Kill Bill documentation (user guides and tutorials).

The site is built using Asciidoctor.

Edit and Syntax

The documentation is in the userguide directory.

AsciiDoc syntax: https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/

Development

To generate the documentation locally:

make.sh

Generated html files are in the build directory.

To run the site locally:

ruby server.rb

Prerequisites:

Deployment

To deploy the docs:

make.sh
update_gh-pages.sh

Notes:

  • The generated static pages under build/selfcontained are pushed to the gh-pages branch (not served by GitHub pages)
  • The gh-pages branch is then deployed by Cloudflare (https://docs.killbill.io/)
  • Minification of assets is handled by Cloudflare (check-in the unminified version)
  • Site-root files are generated in build/root by make.sh and copied to the root of gh-pages by update_gh-pages.sh:
    • robots.txt, _headers and _redirects come from static/
    • sitemap.xml (latest pages only) is generated by scripts/generate_sitemap.rb
    • 404.html is built from userguide/site/404.adoc (Cloudflare Pages serves it, with a 404 status, for missing paths)
  • Pages link to their /latest/ URL as canonical (html5/document.html.slim). Old version directories on gh-pages are never rebuilt, so update_gh-pages.sh runs scripts/canonicalize_versions.rb to add a canonical link to the same page under /latest/ (or noindex when there is none, see scripts/canonical-overrides.txt)

About

Kill Bill documentation

Topics

Resources

Contributing

Stars

44 stars

Watchers

4 watching

Forks

Sponsor this project

Used by

Contributors

Languages