kubernetes-sigs/kustomize
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/kustomize.git synced 2026-06-11 17:12:51 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Document AnnotationsTransformer (#5247)

Browse Source 
* 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:
Anna Song
2023-09-08 20:54:10 -07:00
committed by GitHub
parent 985835f96f
commit 7c36ed21b3
11 changed files with 134 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
site/content/en/docs/Reference/_index.md
View File

@@ -2,13 +2,7 @@
title: "Reference"
linkTitle: "Reference"
weight: 9
date: 2023-07-28
description: >
Low level reference docs for your project.
References are the low-level definitions in Kustomize.
---
{{% pageinfo %}}
This is a placeholder page that shows you how to use this template site.
{{% /pageinfo %}}
If your project has an API, configuration, or other reference - anything that users need to look up that’s at an even lower level than a single task - put (or link to it) here. You can serve and link to generated reference docs created using Doxygen,
Javadoc, or other doc generation tools by putting them in your `static/` directory. Find out more in [Adding static content](https://docsy.dev/docs/adding-content/content/#adding-static-content). For OpenAPI reference, Docsy also provides a [Swagger UI layout and shortcode](https://www.docsy.dev/docs/adding-content/shortcodes/#swaggerui) that renders [Swagger UI](https://swagger.io/tools/swagger-ui/) using any OpenAPI YAML or JSON file as source.