Skip to content

Commit

Permalink
docs: add content to all section index pages
Browse files Browse the repository at this point in the history
Signed-off-by: Moritz Wiesinger <[email protected]>
  • Loading branch information
mowies committed Dec 6, 2023
1 parent 32be4db commit bf94589
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 20 deletions.
24 changes: 5 additions & 19 deletions docs-new/docs/components/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,9 @@

## Keptn Components

Keptn consists of two main components:
Keptn consists of the following main components:

* Keptn Lifecycle Operator, which splits into two separate operators
in Release 0.7.0 and later:
* Lifecycle-Operator
* Metrics-Operator
* Keptn Lifecycle Scheduler

```mermaid
graph TD;
KeptnComponents-->Operators;
KeptnComponents-->Scheduler
Operators-->Lifecycle-Operator
Operators-->Metrics-Operator
style KeptnComponents fill:#006bb8,stroke:#fff,stroke-width:px,color:#fff
style Operators fill:#d8e6f4,stroke:#fff,stroke-width:px,color:#006bb8
style Scheduler fill:#d8e6f4,stroke:#fff,stroke-width:px,color:#006bb8
style Lifecycle-Operator fill:#d8e6f4,stroke:#fff,stroke-width:px,color:#006bb8
style Metrics-Operator fill:#d8e6f4,stroke:#fff,stroke-width:px,color:#006bb8
```
* [Keptn Lifecycle Operator](./lifecycle-operator)
* [Keptn Metrics Operator](./metrics-operator.md)
* [Keptn Scheduler](./scheduling.md)
* [Keptn Certificate Manager](./certificate-operator.md)
2 changes: 2 additions & 0 deletions docs-new/docs/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Get started

This section will guide you through some tutorials that show how to bootstrap and use Keptn.
2 changes: 2 additions & 0 deletions docs-new/docs/guides/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Guides

This section will help you with guides about specific features of Keptn.
5 changes: 5 additions & 0 deletions docs-new/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Keptn Documentation

This is the documentation homepage.
If you are new to Keptn, please check out the following sections:

- [Core Concepts](./core-concepts) will help you understand what Keptn is all about
- [Get Started](./getting-started) will help you get going with your first use cases for Keptn
- [Installation](./installation) will guide you through the installation procedure of Keptn
7 changes: 6 additions & 1 deletion docs-new/docs/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Reference

This section of the Keptn documentation contains reference documentation.
This section of the Keptn documentation contains reference documentation for the various APIs and CRDs that are used in Keptn.

If you want to learn more about specific Custom Resource Definitions, go to the [CRD Reference](./crd-reference) section.

If you want to look up some specific object properties or want ot know more about the internal APIs of Keptn,
Go to the [API Reference](./api-reference) section.
2 changes: 2 additions & 0 deletions docs-new/docs/use-cases/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Use Cases

This section contains specific use cases and integration scenarios with other Cloud Native tools.

0 comments on commit bf94589

Please sign in to comment.