Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add content to all section index pages #2645

Merged
merged 12 commits into from
Dec 12, 2023
4 changes: 3 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -147,16 +147,18 @@ docs-build:
docker run --rm -it -v ${PWD}/docs-new:/docs-new \
-v ${PWD}/mkdocs.yml:/mkdocs.yml \
-v ${PWD}/requirements.txt:/requirements.txt \
-v ${PWD}/.git:/.git \
--entrypoint "" \
${MKDOCS_DOCKER_IMAGE}:${MKDOCS_DOCKER_IMAGE_VERSION} \
sh -c 'cd /; pip install -r requirements.txt -q; mkdocs build -q'
sh -c 'cd /; pip install -r requirements.txt -q; mkdocs build'

.PHONY: docs-serve
docs-serve:
docker run --rm -it -p 8000:8000 \
-v ${PWD}/docs-new:/docs-new \
-v ${PWD}/mkdocs.yml:/mkdocs.yml \
-v ${PWD}/requirements.txt:/requirements.txt \
-v ${PWD}/.git:/.git \
--entrypoint "" \
${MKDOCS_DOCKER_IMAGE}:${MKDOCS_DOCKER_IMAGE_VERSION} \
sh -c 'cd /; pip install -r requirements.txt -q; mkdocs serve -a 0.0.0.0:8000'
Expand Down
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/index.md)
* [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.
mowies marked this conversation as resolved.
Show resolved Hide resolved
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.
mowies marked this conversation as resolved.
Show resolved Hide resolved
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/index.md) will help you understand what Keptn is all about
- [Get Started](./getting-started/index.md) will help you get going with your first use cases for Keptn
mowies marked this conversation as resolved.
Show resolved Hide resolved
- [Installation](./installation/index.md) will guide you through the installation procedure of Keptn
mowies marked this conversation as resolved.
Show resolved Hide resolved
3 changes: 3 additions & 0 deletions docs-new/docs/installation/configuration/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
# Configuration

This section contains guides for specific configuration use cases for Keptn.
Those will help you adjust settings that need to be set at installation time.
2 changes: 2 additions & 0 deletions docs-new/docs/reference/api-reference/lifecycle/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Lifecycle API

Reference information about the Lifecycle API.
2 changes: 2 additions & 0 deletions docs-new/docs/reference/api-reference/metrics/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Metrics API

Reference information about the Metrics API.
2 changes: 2 additions & 0 deletions docs-new/docs/reference/api-reference/options/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Options API

Reference information about the Options API.
8 changes: 7 additions & 1 deletion docs-new/docs/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# 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
mowies marked this conversation as resolved.
Show resolved Hide resolved
[CRD Reference](./crd-reference/index.md) 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/index.md) 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.
Loading