mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-09-15 12:18:57 +00:00
Document AnnotationsTransformer (#5247)
* Restructure existing Reference docs Restructure Reference section for site to better match k8s.io. Change descriptions to complete sentences. Improve instructions to locally load site. * Document AnnotationsTransformer on site Dcoument AnnotationsTransformer API under Reference on site. * Document required fields Document required fields and explain effects of optional ones. * Make site setup instructions more explicit * Link required K8s fields
This commit is contained in:
@@ -23,17 +23,28 @@ docker-compomse up -d
|
||||
```
|
||||
|
||||
### hugo
|
||||
Building using the `hugo` command requires the following dependencies:
|
||||
* [hugo CLI](https://gohugo.io/getting-started/installing/)
|
||||
* [Go](https://go.dev/learn/)
|
||||
* [Node.js](https://nodejs.org/en/)
|
||||
* npm dependencies
|
||||
1. Building using the `hugo` command requires the following dependencies:
|
||||
* [hugo CLI](https://gohugo.io/getting-started/installing/)
|
||||
* [Go](https://go.dev/learn/)
|
||||
* [Node.js](https://nodejs.org/en/)
|
||||
* npm dependencies
|
||||
```bash
|
||||
npm install -D autoprefixer
|
||||
npm install -D postcss-cli
|
||||
npm install -D postcss
|
||||
```
|
||||
1. Initialize [Docsy](https://www.docsy.dev/docs/) and nested [submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
|
||||
```bash
|
||||
npm install -D autoprefixer
|
||||
npm install -D postcss-cli
|
||||
npm install -D postcss
|
||||
# In Kustomize repository root directory, fetch docsy submodule at site/themes/docsy.
|
||||
# See alternative submodule cloning options in the submodule documentation linked above.
|
||||
git submodule init
|
||||
git submodule update
|
||||
# Fetch submodules nested in docsy.
|
||||
cd site/themes/docsy
|
||||
git submodule init
|
||||
git submodule update
|
||||
```
|
||||
1. Start in development mode:
|
||||
```bash
|
||||
hugo serve -D
|
||||
```
|
||||
Start in development mode:
|
||||
```bash
|
||||
hugo serve -D
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user