From 857835b6710cbe0bb3e72b178465352547eb4ac2 Mon Sep 17 00:00:00 2001 From: Tomas Coufal Date: Thu, 4 May 2023 19:04:35 +0200 Subject: [PATCH] docs: use upstream schema and recognize the dependency Signed-off-by: Tomas Coufal --- README.md | 6 +++++- charts/backstage/Chart.yaml | 2 +- charts/backstage/README.md | 6 +++++- charts/backstage/README.md.gotmpl | 4 ++++ charts/backstage/values.schema.json | 2 +- 5 files changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 59fbc024..d6923051 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,13 @@ -# Backstage Helm Chart +# Backstage Helm Chart for OpenShift [Backstage](https://backstage.io) is an open platform for building developer portals. Powered by a centralized software catalog, Backstage restores order to your microservices and infrastructure and enables your product teams to ship high-quality code quickly — without compromising autonomy. Backstage unifies all your infrastructure tooling, services, and documentation to create a streamlined development environment from end to end. +**This chart offers an opinionated OpenShift-specific experience.** It is based on and directly depends on an upstream canonical [Backstage Helm chart](https://github.com/backstage/charts/tree/main/charts/backstage). For less opinionated experience, please consider using the upstream chart directly. + +This chart extends all the features in the upstream chart in addition to including OpenShift only features. It is not recommended to use this chart on other platforms. + ## Usage Charts are available in the following formats: diff --git a/charts/backstage/Chart.yaml b/charts/backstage/Chart.yaml index fba0422b..c4618f0d 100644 --- a/charts/backstage/Chart.yaml +++ b/charts/backstage/Chart.yaml @@ -42,4 +42,4 @@ sources: # 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: 1.0.2 +version: 1.0.3 diff --git a/charts/backstage/README.md b/charts/backstage/README.md index 9c71ac4d..77675984 100644 --- a/charts/backstage/README.md +++ b/charts/backstage/README.md @@ -1,7 +1,7 @@ # Janus-IDP Backstage Helm Chart -![Version: 1.0.2](https://img.shields.io/badge/Version-1.0.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) +![Version: 1.0.3](https://img.shields.io/badge/Version-1.0.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) A Helm chart for deploying a Backstage application @@ -26,6 +26,10 @@ A Helm chart for deploying a Backstage application Backstage unifies all your infrastructure tooling, services, and documentation to create a streamlined development environment from end to end. +**This chart offers an opinionated OpenShift-specific experience.** It is based on and directly depends on an upstream canonical [Backstage Helm chart](https://github.com/backstage/charts/tree/main/charts/backstage). For less opinionated experience, please consider using the upstream chart directly. + +This chart extends all the features in the upstream chart in addition to including OpenShift only features. It is not recommended to use this chart on other platforms. + ## TL;DR ```console diff --git a/charts/backstage/README.md.gotmpl b/charts/backstage/README.md.gotmpl index b2e2f6c1..de4b2b63 100644 --- a/charts/backstage/README.md.gotmpl +++ b/charts/backstage/README.md.gotmpl @@ -20,6 +20,10 @@ Backstage unifies all your infrastructure tooling, services, and documentation to create a streamlined development environment from end to end. +**This chart offers an opinionated OpenShift-specific experience.** It is based on and directly depends on an upstream canonical [Backstage Helm chart](https://github.com/backstage/charts/tree/main/charts/backstage). For less opinionated experience, please consider using the upstream chart directly. + +This chart extends all the features in the upstream chart in addition to including OpenShift only features. It is not recommended to use this chart on other platforms. + ## TL;DR ```console diff --git a/charts/backstage/values.schema.json b/charts/backstage/values.schema.json index 6bfa1e33..632b26de 100644 --- a/charts/backstage/values.schema.json +++ b/charts/backstage/values.schema.json @@ -6,7 +6,7 @@ "properties": { "upstream": { "title": "Upstream Backstage chart schema.", - "type": "object", + "$ref": "https://raw.githubusercontent.com/backstage/charts/main/charts/backstage/values.schema.json", "default": { "backstage": { "image": {