From da142a8e97fe044ac7734c1fe69032b679f8781b Mon Sep 17 00:00:00 2001 From: Jeffrey Regan Date: Thu, 23 Aug 2018 11:25:59 -0700 Subject: [PATCH] Move some docs to docs dir (declutter the top). --- README.md | 2 +- code-of-conduct.md | 6 ------ CODE_OF_CONDUCT.md => docs/CODE_OF_CONDUCT.md | 0 CONTRIBUTING.md => docs/CONTRIBUTING.md | 0 INSTALL.md => docs/INSTALL.md | 0 docs/README.md | 12 +++++++++++- SECURITY_CONTACTS => docs/SECURITY_CONTACTS | 0 7 files changed, 12 insertions(+), 8 deletions(-) delete mode 100644 code-of-conduct.md rename CODE_OF_CONDUCT.md => docs/CODE_OF_CONDUCT.md (100%) rename CONTRIBUTING.md => docs/CONTRIBUTING.md (100%) rename INSTALL.md => docs/INSTALL.md (100%) rename SECURITY_CONTACTS => docs/SECURITY_CONTACTS (100%) diff --git a/README.md b/README.md index 6625bac47..72cfb5c18 100644 --- a/README.md +++ b/README.md @@ -127,7 +127,7 @@ This tool is sponsored by [sig-cli] ([KEP]). [examples]: examples/README.md [imageBase]: docs/base.jpg [imageOverlay]: docs/overlay.jpg -[install]: INSTALL.md +[install]: docs/INSTALL.md [kubernetes style]: docs/glossary.md#kubernetes-style-object [kustomization]: docs/glossary.md#kustomization [overlay]: docs/glossary.md#overlay diff --git a/code-of-conduct.md b/code-of-conduct.md deleted file mode 100644 index 98e34bc24..000000000 --- a/code-of-conduct.md +++ /dev/null @@ -1,6 +0,0 @@ -[Kubernetes Community Code of Conduct]: https://git.k8s.io/community/code-of-conduct.md - -# Code of Conduct - -This project has adopted the -[Kubernetes Community Code of Conduct]. diff --git a/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to docs/CODE_OF_CONDUCT.md diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md diff --git a/INSTALL.md b/docs/INSTALL.md similarity index 100% rename from INSTALL.md rename to docs/INSTALL.md diff --git a/docs/README.md b/docs/README.md index a6f53ed20..4689b76ee 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,7 @@ # Kustomize docs - + + * [installation instructions](INSTALL.md) + * [kustomization.yaml](kustomization.yaml) - Example of a [kustomization](glossary.md#kustomization) with explanations of each field. @@ -11,3 +13,11 @@ * [eschewed features](eschewedFeatures.md) - Why certain features are (currently) not supported in Kustomize. + + * [contributing guidelines](CONTRIBUTING.md) - Please read before sending a PR. + + * [code of conduct](CODE_OF_CONDUCT.md) + + + + diff --git a/SECURITY_CONTACTS b/docs/SECURITY_CONTACTS similarity index 100% rename from SECURITY_CONTACTS rename to docs/SECURITY_CONTACTS