Skip to content

Commit

Permalink
docs: set up directories for contribution guide (#1004)
Browse files Browse the repository at this point in the history
Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
Co-authored-by: Simon Schrottner <simon.schrottner@gmail.com>
Co-authored-by: Simon Schrottner <simon.schrottner@dynatrace.com>
Co-authored-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
  • Loading branch information
5 people committed Mar 15, 2023
1 parent 2a66ea0 commit a3aa4e5
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/content/en/contribute/_index.md
Original file line number Diff line number Diff line change
@@ -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.
13 changes: 13 additions & 0 deletions docs/content/en/contribute/docs/_index.md
Original file line number Diff line number Diff line change
@@ -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.
13 changes: 13 additions & 0 deletions docs/content/en/contribute/general/_index.md
Original file line number Diff line number Diff line change
@@ -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.
13 changes: 13 additions & 0 deletions docs/content/en/contribute/software/_index.md
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 16 additions & 0 deletions docs/content/en/docs/crd-ref/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)

0 comments on commit a3aa4e5

Please sign in to comment.