Tweak docs readme

This commit is contained in:
Jeffrey Regan
2018-08-22 12:12:10 -07:00
parent d72879e109
commit 5fa209acfa
2 changed files with 15 additions and 11 deletions

View File

@@ -1,12 +1,13 @@
# Kustomize docs # Kustomize docs
* [glossary](glossary.md) - glossary for Kustomize. * [kustomization.yaml](kustomization.yaml) - Example of a
[kustomization](glossary.md#kustomization)
with explanations of each field.
* [Sample kustomization.yaml](kustomization.yaml) - A sample kustomization.yaml * [workflow](workflows.md) - Some steps one might take in using
with explanation for each field. bespoke and off-the-shelf configurations.
* [workflow](workflows.md) - Explaining the workflow for * [glossary](glossary.md) - An attempt to disambiguiate terminology.
both bespoke configuration and off-the-shelf configuration.
* [eschewed features](eschewedFeatures.md) - explaining the eschewed features * [eschewed features](eschewedFeatures.md) - Why certain features are (currently)
and why they are not supported in Kustomize. not supported in Kustomize.

View File

@@ -21,14 +21,17 @@ use and maintain a configuration.
## Bespoke configuration ## Bespoke configuration
In this workflow, all configuration files are owned by In this workflow, all configuration (resource YAML) files
the user. No content is incorporated from version are owned by the user. No content is incorporated from version
control repositories owned by others. control repositories owned by others.
![bespoke config workflow image][workflowBespoke] ![bespoke config workflow image][workflowBespoke]
#### 1) create a directory in version control #### 1) create a directory in version control
Speculate some overall cluster application called _ldap_;
we want to keep its configuration in its own repo.
> ``` > ```
> git init ~/ldap > git init ~/ldap
> ``` > ```