Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 1.31 KB

README.md

File metadata and controls

54 lines (36 loc) · 1.31 KB
Raw

Website for Cartographer.sh

Prerequisites

  • Hugo
    • macOS: brew install hugo
    • Windows: choco install hugo-extended -confirm
  • Node
  • Yarn

Serve

make serve

Visit http://localhost:1313

Generate a Release

to create a release copy of development use

make release version=v1.2.3

The new version should appear in the site and be the default.

Generating CRD Documentation

There is a tool, ./hack/crd.rb designed to autogenerate CRD documentation based off the content of our Go doc-comments in /cartographer/pkg/apis.

  1. Check out cartographer locally, as a sibling of cartographer-site.

  2. Ensure cartographer crd's are generated:

cd /path/to/cartographer
git co <revision you want to gen docs from>
make gen-manifests
  1. Generate the site CRD reference:
cd /path/to/cartographer-site
make gen-crd-reference
  1. review the changes to files in /cartographer/site/content/docs/development/crds/*.yaml
    1. Custom edits will be removed, so look for delta's that represent developer edits and roll those line's back

Note: the files in ./hack/crds contain configuration for which fields to replace or ignore.