style(catalog-info): reformat catalog-info.yaml

elastic · Dec 27, 2023 · 9a507dd · 9a507dd
1 parent 9400504
commit 9a507dd
Showing 1 changed file with 36 additions and 20 deletions.
diff --git a/catalog-info.yaml b/catalog-info.yaml
@@ -1,7 +1,12 @@
-################################################################################
-###################### catalog-info for EUI ######################
-# Declare a Backstage Component that represents your application.
+# EUI Catalog info for Backstage
+# Docs: https://backstage.io/docs/features/software-catalog/descriptor-format/
+# DO NOT MODIFY THIS FILE UNLESS YOU KNOW WHAT YOU'RE DOING!
+
 ---
+##
+# EUI component
+##
+
 # yaml-language-server: $schema=https://json.schemastore.org/catalog-info.json
 apiVersion: backstage.io/v1alpha1
 kind: Component
@@ -22,11 +27,11 @@ spec:
   system: ci-systems
   lifecycle: production
 
-###############################################################################
-############################# Buildkite pipelines ##############################
-# Declare your Buildkite pipeline.
-# This declaration creates the Backstage entity and the pipeline in Buildkite.
 ---
+##
+# Example pipeline
+##
+
 # yaml-language-server: $schema=https://gist.githubusercontent.com/elasticmachine/988b80dae436cafea07d9a4a460a011d/raw/e57ee3bed7a6f73077a3f55a38e76e40ec87a7cf/rre.schema.json
 apiVersion: backstage.io/v1alpha1
 kind: Resource
@@ -39,7 +44,7 @@ metadata:
       url: "https://buildkite.com/elastic/eui",
     }
   ]
-      
+
 spec:
   type: buildkite-pipeline
   owner: group:eui-team
@@ -65,9 +70,12 @@ spec:
         everyone:
           access_level: READ_ONLY
 
-############################ Pull request test #############################
-# Run all unit and functional tests on PR
 ---
+##
+# buildkite-pipeline-eui-pull-request-test
+# Pull request - run all unit and functional tests
+##
+
 # yaml-language-server: $schema=https://gist.githubusercontent.com/elasticmachine/988b80dae436cafea07d9a4a460a011d/raw/e57ee3bed7a6f73077a3f55a38e76e40ec87a7cf/rre.schema.json
 apiVersion: backstage.io/v1alpha1
 kind: Resource
@@ -80,7 +88,7 @@ metadata:
       url: "https://buildkite.com/elastic/eui-pull-request-test",
     }
   ]
-      
+
 spec:
   type: buildkite-pipeline
   owner: group:eui-team
@@ -106,9 +114,12 @@ spec:
         everyone:
           access_level: BUILD_AND_READ
 
-############################ Pull request deploy docs #############################
-# Deploy docs to cloud on PR
 ---
+##
+# buildkite-pipeline-eui-pull-request-deploy-docs
+# Pull request - deploy docs website PR preview
+##
+
 # yaml-language-server: $schema=https://gist.githubusercontent.com/elasticmachine/988b80dae436cafea07d9a4a460a011d/raw/e57ee3bed7a6f73077a3f55a38e76e40ec87a7cf/rre.schema.json
 apiVersion: backstage.io/v1alpha1
 kind: Resource
@@ -121,7 +132,7 @@ metadata:
       url: "https://buildkite.com/elastic/eui-pull-request-deploy-docs",
     }
   ]
-      
+
 spec:
   type: buildkite-pipeline
   owner: group:eui-team
@@ -148,9 +159,12 @@ spec:
           access_level: BUILD_AND_READ
 
 
-############################ Pull request combined job #############################
-# Orchestrate tests and deploying docs to cloud on branch PR
 ---
+##
+# buildkite-pipeline-eui-pull-request-test-and-deploy
+# Pull request - run tests and deploy docs website PR preview
+##
+
 # yaml-language-server: $schema=https://gist.githubusercontent.com/elasticmachine/988b80dae436cafea07d9a4a460a011d/raw/e57ee3bed7a6f73077a3f55a38e76e40ec87a7cf/rre.schema.json
 apiVersion: backstage.io/v1alpha1
 kind: Resource
@@ -163,7 +177,7 @@ metadata:
       url: "https://buildkite.com/elastic/eui-pull-request-test-and-deploy",
     }
   ]
-      
+
 spec:
   type: buildkite-pipeline
   owner: group:eui-team
@@ -194,10 +208,12 @@ spec:
         everyone:
           access_level: BUILD_AND_READ
 
-
-############################ Release deploy docs #############################
-# Publish docs to EUI subdomain when we tag a new release
 ---
+##
+# buildkite-pipeline-eui-release-deploy-docs
+# EUI Release - publish docs to eui.elastic.co when we tag a new release
+##
+
 # yaml-language-server: $schema=https://gist.githubusercontent.com/elasticmachine/988b80dae436cafea07d9a4a460a011d/raw/e57ee3bed7a6f73077a3f55a38e76e40ec87a7cf/rre.schema.json
 apiVersion: backstage.io/v1alpha1
 kind: Resource