From f8af2fd1715a676d539e74a84c6dace08eb5cd63 Mon Sep 17 00:00:00 2001 From: Mario Constanti Date: Wed, 4 Oct 2023 09:54:31 +0200 Subject: [PATCH] docs: add crds.dev link to visualize current CRD Signed-off-by: Mario Constanti --- .github/ISSUE_TEMPLATE/feature.yaml | 17 +++++++++++++++++ README.md | 8 ++++++-- 2 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature.yaml diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml new file mode 100644 index 0000000..e61f004 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -0,0 +1,17 @@ +name: Feature Request +description: Request a feature you want to see in garm operator +body: + - type: textarea + id: feature + attributes: + label: What is the feature you would like to have? + description: | + Please provide as much info as possible about the feature. + placeholder: "I would like to have ..." + validations: + required: true + + - type: textarea + id: additional + attributes: + label: Anything else you would like to add? diff --git a/README.md b/README.md index 0582b91..ab3c997 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -[![Go Report Card](https://goreportcard.com/badge/github.com/mercedes-benz/garm-operator)](https://goreportcard.com/report/github.com/mercedes-benz/garm-operator) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/mercedes-benz/garm-operator?sort=semver) +[![Go Report Card](https://goreportcard.com/badge/github.com/mercedes-benz/garm-operator)](https://goreportcard.com/report/github.com/mercedes-benz/garm-operator) +![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/mercedes-benz/garm-operator?sort=semver) +[![build](https://github.com/mercedes-benz/garm-operator/actions/workflows/build.yml/badge.svg)](https://github.com/mercedes-benz/garm-operator/actions/workflows/build.yml) # garm-operator @@ -55,7 +57,7 @@ We are releasing the `garm-operator` as container image together with the corres This manifests can be used to deploy the `garm-operator` into your Kubernetes cluster. ```bash -export GARM_OPERATOR_VERSIOn= +export GARM_OPERATOR_VERSION= export GARM_SERVER_URL= export GARM_SERVER_USERNAME= export GARM_SERVER_PASSWORD= @@ -64,6 +66,8 @@ curl -L https://github.com/mercedes-benz/garm-operator/releases/download/${GARM_ #### Custom Resources +The CRD documentation can be also seen via [docs.crds.dev](https://doc.crds.dev/github.com/mercedes-benz/garm-operator). + Folder `config/samples` contains few basic examples of `Pools`, `Images` and corresponding `Repositories`, `Organizations` or `Enterprises`. ## 💻 Development