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: set up directory for CRD Reference #800

Merged
merged 3 commits into from
Feb 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions docs/content/en/docs/crd-ref/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: CRD Reference pages
description: Reference information about the KLT CRDs
weight: 100
hidechildren: false # this flag hides all sub-pages in the sidebar-multicard.html
---

This section provides comprehensive reference information
about the [Custom Resource Definitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) (CRDs)
that are defined for the Keptn Lifecycle Toolkit.

**NOTE: 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!**
36 changes: 36 additions & 0 deletions docs/content/en/docs/crd-ref/crd-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: <crd-name>
description: <one-line description of CRD>
weight: <assign weight to create alphabetical order>
hide: true
---

Copy this template to create a new CRD reference page.

1. Replace the variable text in metadata with information for this page
1. Delete the `hidden: true` line
1. Delete these instructions from your file
1. Populate the page with appropriate content

## Synopsis
```
```

## Parameters

<Detailed description of each field/parameter>

## Usage

<How this CRD is "activated". For example, which event uses this CRD>
<Instructions and guidelines for when and how to customize a CRD>

## Examples

## Files

## Differences between versions

## See also