From a3aa4e5b2d76443559727da1752921196ccffac4 Mon Sep 17 00:00:00 2001 From: Meg McRoberts Date: Wed, 15 Mar 2023 05:39:12 -0700 Subject: [PATCH] docs: set up directories for contribution guide (#1004) Co-authored-by: Giovanni Liva Co-authored-by: Simon Schrottner Co-authored-by: Simon Schrottner Co-authored-by: Moritz Wiesinger --- docs/content/en/contribute/_index.md | 20 +++++++++++++++++++ docs/content/en/contribute/docs/_index.md | 13 ++++++++++++ docs/content/en/contribute/general/_index.md | 13 ++++++++++++ docs/content/en/contribute/software/_index.md | 13 ++++++++++++ docs/content/en/docs/crd-ref/_index.md | 16 +++++++++++++++ 5 files changed, 75 insertions(+) create mode 100644 docs/content/en/contribute/_index.md create mode 100644 docs/content/en/contribute/docs/_index.md create mode 100644 docs/content/en/contribute/general/_index.md create mode 100644 docs/content/en/contribute/software/_index.md diff --git a/docs/content/en/contribute/_index.md b/docs/content/en/contribute/_index.md new file mode 100644 index 0000000000..2819bd6ff6 --- /dev/null +++ b/docs/content/en/contribute/_index.md @@ -0,0 +1,20 @@ +--- +title: Contributing to Keptn +description: How to contribute to the Keptn projects +linktitle: Contributing +weight: 400 +menu: + main: + weight: 20 +type: docs +cascade: + type: docs +--- + +This section is under development. +Contents are not complete, +but all material here has been reviewed for technical accuracy. + +Keptn software and documentation +is developed and maintained by the Keptn community. +We invite you to join us. diff --git a/docs/content/en/contribute/docs/_index.md b/docs/content/en/contribute/docs/_index.md new file mode 100644 index 0000000000..ebb89c9935 --- /dev/null +++ b/docs/content/en/contribute/docs/_index.md @@ -0,0 +1,13 @@ +--- +title: Documentation contributions +description: Information about contributing to the Keptn documentation +weight: 300 +--- + +This section is under development. +Contents are not complete, +but all material here has been reviewed for technical accuracy. + +Keptn software and documentation +is developed and maintained by the Keptn community. +We invite you to join us. diff --git a/docs/content/en/contribute/general/_index.md b/docs/content/en/contribute/general/_index.md new file mode 100644 index 0000000000..a4a595e431 --- /dev/null +++ b/docs/content/en/contribute/general/_index.md @@ -0,0 +1,13 @@ +--- +title: General information about contributing +description: Information relevant to all contributions +weight: 100 +--- + +This section is under development. +Contents are not complete, +but all material here has been reviewed for technical accuracy. + +Keptn software and documentation +is developed and maintained by the Keptn community. +We invite you to join us. diff --git a/docs/content/en/contribute/software/_index.md b/docs/content/en/contribute/software/_index.md new file mode 100644 index 0000000000..a8b0a9da44 --- /dev/null +++ b/docs/content/en/contribute/software/_index.md @@ -0,0 +1,13 @@ +--- +title: Software contributions +description: Information about contributing software +weight: 200 +--- + +This section is under development. +Contents are not complete, +but all material here has been reviewed for technical accuracy. + +Keptn software and documentation +is developed and maintained by the Keptn community. +We invite you to join us. diff --git a/docs/content/en/docs/crd-ref/_index.md b/docs/content/en/docs/crd-ref/_index.md index 6c3e58a8a9..da78c2a843 100644 --- a/docs/content/en/docs/crd-ref/_index.md +++ b/docs/content/en/docs/crd-ref/_index.md @@ -14,3 +14,19 @@ This section is under development. Information that is published here has been reviewed for technical accuracy but the format and content is still evolving. We welcome your input!** + +Each CRD is an object of an API library. +Keptn APIs follow the Kubernetes API versioning scheme. +and are themselves composed of objects and sub-objects. +By introducing CRDs, Keptn is extending the base Kubernetes API with new objects and functionality. +Keptn APIs follow API versioning conventions recommended by Kubernetes. + +For more information, see the Kubernetes documentation: + +* [API Overview](https://kubernetes.io/docs/reference/using-api/) + +* [Custom Resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) + +* [API versioning](https://kubernetes.io/docs/reference/using-api/#api-versioning) + +* [Understanding Kubernetes Objects](https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/)