Merge pull request #280 from james-milligan/artifact-hub

docs: Artifact hub improvements

Author: james-milligan

.gitignore

@@ -4,7 +4,6 @@ config/manager/manager.yaml
 config/manager/kustomization.yaml
 schemas
 .vscode
-open-feature-operator
 of-agent
 # Binaries for programs and plugins
 *.exe

Makefile

@@ -120,7 +120,7 @@ release-manifests: manifests kustomize
     fi
 	@if [ ${KUSTOMIZE_OVERLAY} = HELM ]; then\
 		echo building helm overlay;\
-        $(KUSTOMIZE) build config/overlays/helm > chart/templates/rendered.yaml;\
+        $(KUSTOMIZE) build config/overlays/helm > chart/open-feature-operator/templates/rendered.yaml;\
     fi
 
 .PHONY: deploy
@@ -187,7 +187,7 @@ set-helm-overlay:
 	${eval KUSTOMIZE_OVERLAY = HELM}
 
 helm-package: set-helm-overlay generate release-manifests helm
-	$(HELM) package --version $(CHART_VERSION) chart
-	mkdir -p charts && mv ofo-*.tgz charts
+	$(HELM) package --version $(CHART_VERSION) chart/open-feature-operator
+	mkdir -p charts && mv open-feature-operator-*.tgz charts
 	$(HELM) repo index --url https://open-feature.github.io/open-feature-operator/charts charts
 	mv charts/index.yaml index.yaml

chart/.helmignore renamed to chart/open-feature-operator/.helmignore

@@ -1,5 +1,5 @@
 apiVersion: v2
-name: ofo
+name: open-feature-operator
 description: A feature flag operator for Kubernetes
 # A chart can be either an 'application' or a 'library' chart.
 #
@@ -13,9 +13,10 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.0
+version: "v0.2.20" # x-release-please-version
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
 appVersion: "v0.2.20" # x-release-please-version
+icon: https://avatars.githubusercontent.com/u/99483952?s=200&v=4

chart/Chart.yaml renamed to chart/open-feature-operator/Chart.yaml

@@ -0,0 +1,47 @@
+# OpenFeature Operator
+
+## TL;DR
+> This helm chart has a dependency on [cert manager](https://cert-manager.io/docs/installation/)
+```
+helm repo add openfeature https://open-feature.github.io/open-feature-operator/
+helm repo update
+helm upgrade -i openfeature openfeature/open-feature-operator
+```
+
+## Introduction
+
+The OpenFeature Operator is a Kubernetes native operator that allows you to expose feature flags to your applications. It injects a [flagd](https://github.com/open-feature/flagd) sidecar into your pod and allows you to poll the flagd server for feature flags in a variety of ways.
+The full documentation for this project can be found here: [OpenFeature Operator](https://github.com/open-feature/open-feature-operator/tree/main/docs)
+
+## Prerequisites
+
+The OpenFeature Operator requires [cert manager](https://cert-manager.io/docs/installation/) to be installed on the target cluster.
+
+## Install
+
+To install/upgrade the chart with the release name `open-feature-operator`:
+```
+helm upgrade -i open-feature-operator openfeature/open-feature-operator
+```
+This installation will use the default helm configuration, described in the [configuration section](#configuration)
+
+## Uninstall
+
+To uninstall the `open-feature-operator`:
+
+```
+helm uninstall open-feature-operator
+```
+
+The command removes all the Kubernetes components associated with the chart and deletes the release.
+
+## Configuration
+<a name="configuration"></a>
+
+| Value       | Default     | Explanation |
+| ----------- | ----------- | ----------- |
+| `defaultNamespace`      | `open-feature-operator`  | [INTERNAL USE ONLY] To override the namespace use the `--namespace` flag. This default is provided to ensure that the kustomize build charts in `/templates` deploy correctly when no `namespace` is provided via the `-n` flag.|
+
+## Changelog
+
+See [CHANGELOG.md](https://github.com/open-feature/open-feature-operator/blob/main/CHANGELOG.md)

chart/open-feature-operator/README.md

@@ -0,0 +1,11 @@
+.  ___                        ___                _                      
+  / _ \   _ __   ___   _ _   | __|  ___   __ _  | |_   _  _   _ _   ___ 
+ | (_) | | '_ \ / -_) | ' \  | _|  / -_) / _` | |  _| | || | | '_| / -_)
+  \___/  | .__/ \___| |_||_| |_|   \___| \__,_|  \__|  \_,_| |_|   \___|
+         |_|                                                            
+
+Thank you for installing {{ .Chart.Name }}.
+
+Your release version is {{ .Chart.AppVersion }}.
+
+Documentation and configuration options can be found here: https://github.com/open-feature/open-feature-operator

chart/open-feature-operator/templates/NOTES.txt

@@ -955,4 +955,4 @@ webhooks:
     - UPDATE
     resources:
     - featureflagconfigurations
-  sideEffects: None
+  sideEffects: None

chart/templates/_helpers.tpl renamed to chart/open-feature-operator/templates/_helpers.tpl

@@ -1,5 +1,6 @@
-# If this namespace is changed the value must be reflected in /chart/values.yaml
+# If this namespace is changed the value must be reflected in /open-feature-operator/values.yaml
 defaultNamespace: open-feature-operator-system
+
 controllerManager:
   kubeRbacProxy:
     image: