Skip to content

README.md

Latest commit

 

History

History
37 lines (25 loc) · 1.21 KB

README.md

File metadata and controls

37 lines (25 loc) · 1.21 KB
Raw

Capsule Website

Source for projectcapsule.dev, the documentation site for Capsule and capsule-proxy.

Built with Hugo and the Docsy theme, pulled in as a Hugo module. CNCF Netlify deploys main and previews every pull request.

Running locally

npm install brings in the pinned extended Hugo, so npx runs the version the site is deployed with. A go toolchain is also needed, to fetch the Docsy module.

npm install
npx hugo server   # http://localhost:1313

Generated API reference

content/en/docs/reference.md and content/en/docs/proxy/reference.md come from the Capsule and capsule-proxy CRDs. Edit those upstream, not these files, then regenerate:

make apidocs              # both repositories at main, so unreleased CRDs
make apidocs REF=v0.10.6  # one ref, used for both repositories

Contributing

Pages live under content/en/. See CONTRIBUTING.md for the pull request workflow and DEVELOPMENT.md for the pre-commit hooks and link checker.

License

Apache 2.0.