Skip to content

vmware-tanzu/cartographer-site

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date
Jan 18, 2024
Apr 7, 2022
Aug 9, 2023
Mar 10, 2023
Jan 15, 2024
Jan 22, 2024
Jun 7, 2023
Aug 22, 2022
Aug 3, 2023
Apr 7, 2022
Jun 20, 2022
Mar 1, 2022
Aug 3, 2023
Apr 7, 2022
Jun 19, 2022
Mar 10, 2023
Apr 7, 2022
Apr 7, 2022
Jan 18, 2024
Jan 18, 2024

Repository files navigation

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.