chore: update and aligned catalog-info.yamls from plugins (#291)

* chore: update and aligned all catalog-infos

Signed-off-by: Christoph Jerolimov <[email protected]>

* chore(homepage): move docs from the frontend plugin to the workspace

Signed-off-by: Christoph Jerolimov <[email protected]>

* chore: split plugins and plugin-packages

Signed-off-by: Christoph Jerolimov <[email protected]>

---------

Signed-off-by: Christoph Jerolimov <[email protected]>

Author: christoph-jerolimov

catalog-info-plugins-packages.yaml

@@ -0,0 +1,20 @@
+apiVersion: backstage.io/v1alpha1
+kind: Location
+metadata:
+  name: rhdh-plugins
+  title: RHDH plugins
+  description: Backstage Plugins by Red Hat
+spec:
+  targets:
+    # This list contains all packages (=frontend plugins, backend plugins, etc.)
+    # for the plugins=workspace you cans ee in `catalog-info-plugins.yaml`.
+    # For maintance reasons, please keep this list alphabetically sorted.
+    - ./workspaces/bulk-import/plugins/bulk-import-backend/catalog-info.yaml
+    - ./workspaces/bulk-import/plugins/bulk-import-common/catalog-info.yaml
+    - ./workspaces/bulk-import/plugins/bulk-import/catalog-info.yaml
+    - ./workspaces/homepage/plugins/dynamic-home-page/catalog-info.yaml
+    - ./workspaces/openshift-image-registry/plugins/openshift-image-registry/catalog-info.yaml
+    - ./workspaces/orchestrator/plugins/orchestrator-backend/catalog-info.yaml
+    - ./workspaces/orchestrator/plugins/orchestrator-common/catalog-info.yaml
+    - ./workspaces/orchestrator/plugins/orchestrator-swf-editor-envelope/catalog-info.yaml
+    - ./workspaces/orchestrator/plugins/orchestrator/catalog-info.yaml

catalog-info-plugins.yaml

@@ -0,0 +1,21 @@
+apiVersion: backstage.io/v1alpha1
+kind: Location
+metadata:
+  name: rhdh-plugins
+  title: RHDH plugins
+  description: Backstage Plugins by Red Hat
+spec:
+  targets:
+    # This list contains just the high-level entities for each workspace=plugin
+    # while the file `catalog-info-plugin-packages.yaml` contains all
+    # included packages (=frontend plugins, backend plugins, etc.).
+    # For maintance reasons, please keep this list alphabetically sorted.
+    - ./workspaces/bulk-import/catalog-info.yaml
+    - ./workspaces/global-floating-action-button/catalog-info.yaml
+    - ./workspaces/global-header/catalog-info.yaml
+    - ./workspaces/homepage/catalog-info.yaml
+    - ./workspaces/lightspeed/catalog-info.yaml
+    - ./workspaces/marketplace/catalog-info.yaml
+    - ./workspaces/openshift-image-registry/catalog-info.yaml
+    - ./workspaces/orchestrator/catalog-info.yaml
+    - ./workspaces/theme/catalog-info.yaml

catalog-info-teams.yaml

@@ -0,0 +1,50 @@
+# NOTICE: In our internal Red Hat DevHub instance this groups are automatically imported due Rover/LDAP.
+# This is duplication is for the purpose of using this groups in another test or public Backstage instance.
+---
+apiVersion: backstage.io/v1alpha1
+kind: Group
+metadata:
+  name: rhdh-team
+spec:
+  type: team
+  children: [rhdh-core-team, rhdh-dynamic-plugin-team, rhdh-ui-team]
+---
+apiVersion: backstage.io/v1alpha1
+kind: Group
+metadata:
+  name: rhdh-core-team
+spec:
+  type: team
+  children: []
+---
+apiVersion: backstage.io/v1alpha1
+kind: Group
+metadata:
+  name: rhdh-dynamic-plugin-team
+spec:
+  type: team
+  children: []
+---
+apiVersion: backstage.io/v1alpha1
+kind: Group
+metadata:
+  name: rhdh-ui-team
+spec:
+  type: team
+  children: []
+---
+apiVersion: backstage.io/v1alpha1
+kind: Group
+metadata:
+  name: rhtap-team
+spec:
+  type: team
+  children: []
+---
+apiVersion: backstage.io/v1alpha1
+kind: Group
+metadata:
+  name: orchestrator-team
+spec:
+  type: team
+  children: []

catalog-info.yaml

@@ -0,0 +1,15 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: rhdh-plugins
+  title: RHDH plugins
+  description: Backstage Plugins by Red Hat
+  annotations:
+    github.com/project-slug: redhat-developer/rhdh-plugins
+    github.com/team-slug: redhat-developer/rhdh-plugins-contributers
+    #sonarqube.org/project-key: redhat-developer_rhdh-plugins
+spec:
+  type: plugins
+  lifecycle: production
+  owner: rhdh-team
+  system: rhdh

workspaces/bulk-import/catalog-info.yaml

@@ -1,13 +1,24 @@
+# https://backstage.io/docs/features/software-catalog/descriptor-format#kind-component
 apiVersion: backstage.io/v1alpha1
 kind: Component
 metadata:
-  name: bulk-import
-  description: An example of a Backstage application.
-  # Example for optional annotations
-  # annotations:
-  #   github.com/project-slug: backstage/backstage
-  #   backstage.io/techdocs-ref: dir:.
+  name: red-hat-developer-hub-bulk-import
+  title: RHDH Bulk Import plugin
+  annotations:
+    backstage.io/source-location: url:https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/bulk-import/plugins/bulk-import
+    backstage.io/view-url: https://github.com/redhat-developer/rhdh-plugins/blob/main/workspaces/bulk-import/plugins/bulk-import/catalog-info.yaml
+    backstage.io/edit-url: https://github.com/redhat-developer/rhdh-plugins/edit/main/workspaces/bulk-import/plugins/bulk-import/catalog-info.yaml
+    github.com/project-slug: red-hat-developer-hub/backstage-plugins
+    github.com/team-slug: rhdh/maintainers-plugins
+    sonarqube.org/project-key: red_hat_developer_hub_plugins
+  links:
+    - url: https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/bulk-import/plugins/bulk-import
+      title: GitHub Source
+      icon: source
+      type: source
 spec:
-  type: website
-  owner: [email protected]
-  lifecycle: experimental
+  type: backstage-plugin
+  lifecycle: production
+  owner: rhdh-team
+  system: rhdh
+  subcomponentOf: rhdh-plugins

workspaces/bulk-import/plugins/bulk-import-backend/catalog-info.yaml

@@ -32,7 +32,7 @@ apiVersion: backstage.io/v1alpha1
 kind: API
 metadata:
   name: red-hat-developer-hub-bulk-import-backend-api
-  title: '@red-hat-developer-hub/backstage-plugin-bulk-import-backend'
+  title: '@red-hat-developer-hub/backstage-plugin-bulk-import-backend API'
   description: Bulk Import Backend Plugin
   annotations:
     backstage.io/source-location: url:https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/bulk-import/plugins/bulk-import-backend

workspaces/bulk-import/plugins/bulk-import/catalog-info.yaml

@@ -1,31 +1,6 @@
 # https://backstage.io/docs/features/software-catalog/descriptor-format#kind-component
 apiVersion: backstage.io/v1alpha1
 kind: Component
-metadata:
-  name: red-hat-developer-hub-bulk-import
-  title: Bulk import plugin
-  annotations:
-    backstage.io/source-location: url:https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/bulk-import/plugins/bulk-import
-    backstage.io/view-url: https://github.com/redhat-developer/rhdh-plugins/blob/main/workspaces/bulk-import/plugins/bulk-import/catalog-info.yaml
-    backstage.io/edit-url: https://github.com/redhat-developer/rhdh-plugins/edit/main/workspaces/bulk-import/plugins/bulk-import/catalog-info.yaml
-    github.com/project-slug: red-hat-developer-hub/backstage-plugins
-    github.com/team-slug: rhdh/maintainers-plugins
-    sonarqube.org/project-key: red_hat_developer_hub_plugins
-  links:
-    - url: https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/bulk-import/plugins/bulk-import
-      title: GitHub Source
-      icon: source
-      type: source
-spec:
-  type: backstage-plugin
-  lifecycle: production
-  owner: rhdh-team
-  system: rhdh
-  subcomponentOf: red-hat-developer-hub-plugins
----
-# https://backstage.io/docs/features/software-catalog/descriptor-format#kind-component
-apiVersion: backstage.io/v1alpha1
-kind: Component
 metadata:
   name: red-hat-developer-hub-bulk-import-frontend
   title: '@red-hat-developer-hub/backstage-plugin-bulk-import'

workspaces/global-floating-action-button/catalog-info.yaml

@@ -1,13 +1,16 @@
 apiVersion: backstage.io/v1alpha1
 kind: Component
 metadata:
-  name: global-floating-action-button
-  description: An example of a Backstage application.
-  # Example for optional annotations
-  # annotations:
-  #   github.com/project-slug: backstage/backstage
-  #   backstage.io/techdocs-ref: dir:.
+  name: red-hat-developer-hub-global-floating-action-button
+  title: RHDH Global Floating Action Button plugin
+  description: The global floating action button plugin allows other plugins to add a floating action button to the RHDH app.
+  annotations:
+    github.com/project-slug: redhat-developer/rhdh-plugins
+    github.com/team-slug: redhat-developer/rhdh-plugins-contributers
+    #sonarqube.org/project-key: redhat-developer_rhdh-plugins
 spec:
-  type: website
-  owner: [email protected]
-  lifecycle: experimental
+  type: backstage-plugin
+  lifecycle: production
+  owner: rhdh-team
+  system: rhdh
+  subcomponentOf: rhdh-plugins

workspaces/global-header/catalog-info.yaml

@@ -1,13 +1,20 @@
 apiVersion: backstage.io/v1alpha1
 kind: Component
 metadata:
-  name: global-header
-  description: An example of a Backstage application.
-  # Example for optional annotations
-  # annotations:
-  #   github.com/project-slug: backstage/backstage
-  #   backstage.io/techdocs-ref: dir:.
+  name: red-hat-developer-hub-global-header
+  title: RHDH Global Header plugin
+  description: The global header plugins provides an extendable way for the RHDH header. It provides a set of default components and also allow other plugins can contribute components to the header.
+  annotations:
+    github.com/project-slug: redhat-developer/rhdh-plugins
+    github.com/team-slug: redhat-developer/rhdh-plugins-contributers
+    #sonarqube.org/project-key: redhat-developer_rhdh-plugins
+  tags:
+    - backstage
+    - rhdh
+    - plugin
 spec:
-  type: website
-  owner: [email protected]
-  lifecycle: experimental
+  type: backstage-plugin
+  lifecycle: production
+  owner: rhdh-team
+  system: rhdh
+  subcomponentOf: rhdh-plugins

workspaces/homepage/catalog-info.yaml

@@ -2,15 +2,17 @@
 apiVersion: backstage.io/v1alpha1
 kind: Component
 metadata:
-  name: rhdh-plugins-homepage
-  title: Home Page plugin
+  name: red-hat-developer-hub-homepage
+  title: RHDH Home Page plugin
   description: Home Page plugin based on the upstream `home` plugin that can be extended and customized with the RHDH dynamic plugin feature.
   annotations:
-    {}
-    # github.com/project-slug: janus-idp/backstage-showcase
-    # github.com/team-slug: janus-idp/maintainers-plugins
-    # sonarqube.org/project-key: janus-idp_backstage-showcase
+    backstage.io/techdocs-ref: dir:.
+    github.com/project-slug: redhat-developer/rhdh-plugins
+    github.com/team-slug: redhat-developer/rhdh-plugins-contributers
+    #sonarqube.org/project-key: redhat-developer_rhdh-plugins
   tags:
+    - rhdh
+    - plugin
     - homepage
   links:
     - url: https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/homepage
@@ -22,3 +24,4 @@ spec:
   lifecycle: production
   owner: rhdh-team
   system: rhdh
+  subcomponentOf: rhdh-plugins

workspaces/homepage/plugins/dynamic-home-page/docs/catalog-starred.md workspaces/homepage/docs/catalog-starred.md

@@ -0,0 +1,4 @@
+site_name: RHDH Home Page plugin
+docs_dir: docs
+plugins:
+  - techdocs-core

workspaces/homepage/plugins/dynamic-home-page/docs/catalog-starred.png workspaces/homepage/docs/catalog-starred.png

@@ -6,10 +6,10 @@ metadata:
   title: '@red-hat-developer-hub/backstage-plugin-dynamic-home-page'
   description: Dynamic Home Page plugin based on the upstream `home` plugin that can be extended and customized with the RHDH dynamic plugin feature.
   annotations:
-    {}
-    # github.com/project-slug: janus-idp/backstage-showcase
-    # github.com/team-slug: janus-idp/maintainers-plugins
-    # sonarqube.org/project-key: janus-idp_backstage-showcase
+    backstage.io/techdocs-entity: component:default/red-hat-developer-hub-homepage
+    github.com/project-slug: redhat-developer/rhdh-plugins
+    github.com/team-slug: redhat-developer/rhdh-plugins-contributers
+    #sonarqube.org/project-key: redhat-developer_rhdh-plugins
   tags:
     - homepage
   links:
@@ -22,7 +22,7 @@ spec:
   lifecycle: production
   owner: rhdh-team
   system: rhdh
-  subcomponentOf: rhdh-plugins-homepage
+  subcomponentOf: red-hat-developer-hub-homepage
   dependsOn:
     - component:backstage-plugin-home
     - component:backstage-plugin-home-react

workspaces/homepage/plugins/dynamic-home-page/docs/create-a-new-card.md workspaces/homepage/docs/create-a-new-card.md

@@ -1,13 +1,11 @@
 apiVersion: backstage.io/v1alpha1
 kind: Component
 metadata:
-  name: lightspeed
-  description: An example of a Backstage application.
-  # Example for optional annotations
-  # annotations:
-  #   github.com/project-slug: backstage/backstage
-  #   backstage.io/techdocs-ref: dir:.
+  name: red-hat-developer-hub-lightspeed
+  title: RHDH Lightspeed plugin
 spec:
-  type: website
-  owner: [email protected]
-  lifecycle: experimental
+  type: backstage-plugin
+  lifecycle: production
+  owner: rhdh-team
+  system: rhdh
+  subcomponentOf: rhdh-plugins

workspaces/homepage/plugins/dynamic-home-page/docs/customization.md workspaces/homepage/docs/customization.md

@@ -1,13 +1,20 @@
 apiVersion: backstage.io/v1alpha1
 kind: Component
 metadata:
-  name: marketplace
-  description: An example of a Backstage application.
-  # Example for optional annotations
-  # annotations:
-  #   github.com/project-slug: backstage/backstage
-  #   backstage.io/techdocs-ref: dir:.
+  name: red-hat-developer-hub-marketplace
+  title: RHDH Marketplace plugin
+  description: WIP Marketplace plugin. We want move it to Backstage Community Plugin as soon as possible.
+  annotations:
+    github.com/project-slug: redhat-developer/rhdh-plugins
+    github.com/team-slug: redhat-developer/rhdh-plugins-contributers
+    #sonarqube.org/project-key: redhat-developer_rhdh-plugins
+  tags:
+    - backstage
+    - rhdh
+    - plugin
 spec:
-  type: website
-  owner: [email protected]
-  lifecycle: experimental
+  type: backstage-plugin
+  lifecycle: production
+  owner: rhdh-team
+  system: rhdh
+  subcomponentOf: rhdh-plugins

workspaces/homepage/plugins/dynamic-home-page/docs/default-homepage.png workspaces/homepage/docs/default-homepage.png

@@ -1,13 +1,27 @@
 apiVersion: backstage.io/v1alpha1
 kind: Component
 metadata:
-  name: openshift-image-registry
-  description: An example of a Backstage application.
-  # Example for optional annotations
-  # annotations:
-  #   github.com/project-slug: backstage/backstage
-  #   backstage.io/techdocs-ref: dir:.
+  name: red-hat-developer-hub-openshift-image-registry
+  title: RHDH OpenShift Image Registry plugin
+  description: OpenShift Image Registry plugin for Backstage
+  annotations:
+    backstage.io/source-location: url:https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/openshift-image-registry/plugins/openshift-image-registry
+    backstage.io/view-url: https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/openshift-image-registry/plugins/openshift-image-registry/catalog-info.yaml
+    backstage.io/edit-url: https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/openshift-image-registry/plugins/openshift-image-registry/catalog-info.yaml
+    github.com/project-slug: red-hat-developer-hub/backstage-plugins
+    github.com/team-slug: red-hat-developer-hub/maintainers-plugins
+    sonarqube.org/project-key: red-hat-developer-hub_backstage-plugins
+  tags:
+    - kubernetes
+    - openshift
+  links:
+    - url: https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/openshift-image-registry/plugins/openshift-image-registry
+      title: GitHub Source
+      icon: source
+      type: source
 spec:
-  type: website
-  owner: [email protected]
-  lifecycle: experimental
+  type: backstage-plugin
+  lifecycle: production
+  owner: rhdh-team
+  system: rhdh
+  subcomponentOf: rhdh-plugins