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: combine API and CRD reference index pages into one #2849

Merged
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
740bec9
keep
geoffrey1330 Aug 7, 2023
a052299
keep
geoffrey1330 Sep 22, 2023
0f86a7b
Combine API and CRD reference pages into a coherent parent page
geoffrey1330 Jan 22, 2024
72ea286
Combine API and CRD reference pages into a coherent parent page
geoffrey1330 Jan 22, 2024
012289f
Combine API and CRD reference pages into a coherent parent page
geoffrey1330 Jan 22, 2024
d459895
Combine API and CRD reference pages into a coherent parent page
geoffrey1330 Jan 22, 2024
c6a4088
Combine API and CRD reference pages into a coherent parent page
geoffrey1330 Jan 22, 2024
aec7727
Combine API and CRD reference pages into a coherent parent page
geoffrey1330 Jan 22, 2024
31ec423
Combine API and CRD reference pages into a coherent parent page
geoffrey1330 Jan 22, 2024
db071b7
Combine API and CRD reference pages into a coherent parent page
geoffrey1330 Jan 22, 2024
de76a29
Update docs/docs/reference/index.md
geoffrey1330 Jan 23, 2024
d19b59c
Update docs/docs/reference/index.md
geoffrey1330 Jan 23, 2024
5351842
Combine API and CRD reference pages into a coherent parent page
geoffrey1330 Jan 23, 2024
2b506ac
Combine API and CRD reference pages into a coherent parent page
geoffrey1330 Jan 23, 2024
14c2d0d
Combine API and CRD reference pages into a coherent parent page
geoffrey1330 Jan 23, 2024
f77b458
Combine API and CRD reference pages into a coherent parent page
geoffrey1330 Jan 23, 2024
0b308d5
Combine API and CRD reference pages into a coherent parent page
geoffrey1330 Jan 23, 2024
4c32009
Removed kubectl command for reference index.md
geoffrey1330 Jan 24, 2024
2fa0f19
Update docs/docs/reference/crd-reference/index.md
geoffrey1330 Jan 25, 2024
9128a46
Removed kubectl command for reference index.md
geoffrey1330 Jan 25, 2024
d1185d7
Removed kubectl command for reference index.md
geoffrey1330 Jan 25, 2024
3f4f0b8
Removed kubectl command for reference index.md
geoffrey1330 Jan 25, 2024
0f7e923
Merge branch 'main' into doc/2670/combine_api_crd_reference_page_info
geoffrey1330 Jan 25, 2024
8f630ae
Merge branch 'main' into doc/2670/combine_api_crd_reference_page_info
geoffrey1330 Jan 25, 2024
b838b22
Update docs/docs/reference/index.md
geoffrey1330 Jan 25, 2024
8d4134c
Update docs/docs/reference/index.md
geoffrey1330 Jan 25, 2024
f22043c
Update docs/docs/reference/index.md
geoffrey1330 Jan 25, 2024
380aa59
Removed kubectl command for reference index.md
geoffrey1330 Jan 25, 2024
b2e73e1
Removed kubectl command for reference index.md
geoffrey1330 Jan 25, 2024
3afa54c
Removed redundant intro in CRD Reference
geoffrey1330 Jan 25, 2024
ddb9d8c
Removed redundant intro in CRD Reference
geoffrey1330 Jan 25, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 0 additions & 42 deletions docs/docs/reference/api-reference/index.md
Original file line number Diff line number Diff line change
@@ -1,43 +1 @@
# API Reference

This section provides comprehensive reference information about all APIs
geoffrey1330 marked this conversation as resolved.
Show resolved Hide resolved
that are defined In Keptn.
This section is auto-generated from source code.

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.
The Keptn CRDs extend the base Kubernetes API
with new objects and functionality.
Keptn APIs follow API versioning conventions recommended by Kubernetes.

Keptn generates most of the resources it needs
without requiring manual input.
[Lifecycle CRD Reference and Metrics CRD Reference](../crd-reference/index.md)
contains reference pages for the manifests
that must be populated manually.

Use `kubectl` to inspect the current contents of any Keptn resource:

1. List all resources of the specified type within a certain namespace.
For example, to list all the `KeptnApp` resources
in the `namespace1` namespace, the command is:

kubectl get keptnapps -n namespace1

2. Get the current manifest for the specified resource.
For example, to view the manifest for the `my-keptn-app` resource
in the `namespace1` namespace, the command is:

kubectl get keptnapp -n <namespace> my-keptn-app -oyaml

For more information about the APIs and Custom Resources,
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/)
20 changes: 0 additions & 20 deletions docs/docs/reference/crd-reference/index.md
Original file line number Diff line number Diff line change
@@ -1,21 +1 @@
# CRD Reference

This section provides comprehensive reference information about the
geoffrey1330 marked this conversation as resolved.
Show resolved Hide resolved
manifest files that must be populated for Keptn
[Custom Resource Definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).

Each CRD is an object of an API library.
In addition to the CRDs documented in this section,
Keptn populates many resources on its own.
For a comprehensive list of all Keptn resources, see
[API Reference](../api-reference/index.md).

For more information about CRDs and APIs, 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/)
59 changes: 52 additions & 7 deletions docs/docs/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,56 @@
# Reference

This section of the Keptn documentation contains reference documentation for the various APIs and CRDs that are used in Keptn.
Welcome to the Keptn documentation reference section, your comprehensive guide to the various Custom Resource Definitions (CRDs) and APIs used in Keptn.
geoffrey1330 marked this conversation as resolved.
Show resolved Hide resolved

If you want to learn more about specific Custom Resource Definitions
that you may need to populate to use Keptn,
go to the
[CRD Reference](./crd-reference/index.md) section.
## [CRD Reference](./crd-reference/index.md)
geoffrey1330 marked this conversation as resolved.
Show resolved Hide resolved

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.
Dive into the manifest files crucial for Keptn—Custom Resource Definitions (CRDs).
geoffrey1330 marked this conversation as resolved.
Show resolved Hide resolved
geoffrey1330 marked this conversation as resolved.
Show resolved Hide resolved
This section provides comprehensive reference information about the CRDs
that must be populated to tailor Keptn to your needs.

Each CRD, an integral part of our API library, plays a crucial role in defining
geoffrey1330 marked this conversation as resolved.
Show resolved Hide resolved
the behavior of Keptn resources. While many resources are automatically populated,
the CRD Reference guides you through the manual steps for specific manifests.

For a comprehensive list of all Keptn resources, see the [API Reference](./api-reference/index.md).

To learn more about CRDs, APIs, and Kubernetes objects, consult 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/)
geoffrey1330 marked this conversation as resolved.
Show resolved Hide resolved

## [API Reference](./api-reference/index.md)
geoffrey1330 marked this conversation as resolved.
Show resolved Hide resolved

Explore the rich set of APIs that Keptn offers, providing detailed
information about all defined APIs.
This auto-generated content from source code offers insights into the structure,
geoffrey1330 marked this conversation as resolved.
Show resolved Hide resolved
versioning, and functionality of Keptn APIs.

Each API corresponds to an object in our API library, following Kubernetes API versioning.
Keptn APIs extend the base Kubernetes API with additional objects and functionality.
Notably, Keptn generates many of its resources automatically, minimizing the need for manual input.

For quick reference and practical usage, you can employ `kubectl` commands
geoffrey1330 marked this conversation as resolved.
Show resolved Hide resolved
to inspect the current state of Keptn resources:

1. **List all resources** of a specific type within a namespace. For example:

```bash
kubectl get keptnapps -n namespace1
```

2. **Retrieve the current manifest** for a specified resource. For example:

```bash
kubectl get keptnapp -n <namespace> my-keptn-app -oyaml
```

For further details on Kubernetes APIs, custom resources, versioning, and
geoffrey1330 marked this conversation as resolved.
Show resolved Hide resolved
understanding Kubernetes objects, refer to 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/)
Loading