chore: update github and gitlab register existing component GPT

janus-idp · Sep 22, 2023 · 920c396 · 920c396
1 parent 8595f3e
commit 920c396
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 11 deletions.
diff --git a/templates/github/register-github-component/README.md b/templates/github/register-github-component/README.md
@@ -4,8 +4,8 @@ This template is intended to be used as a starting point for registering an exis
 
 ## Prerequisites
 
-- Please ensure the github host is added to the `app-config.yaml` file in the backstage instance
-- If using a github enterprise instance, please make sure the `apiBaseUrl` is set correctly:
+- Ensure the github host is added to the `app-config.yaml` file in the backstage instance
+- If using a github enterprise instance, make sure the `apiBaseUrl` is set correctly:
 
   ```yaml
   integrations:

diff --git a/templates/gitlab/register-gitlab-component/README.md b/templates/gitlab/register-gitlab-component/README.md
@@ -4,15 +4,8 @@ This template is intended to be used as a starting point for registering an exis
 
 ## Prerequisites
 
-- Please make sure that the `add-catalog-info` branch and `catalog-info.yaml` file do not already exist in the project, or else the template will fail
-- If the a `catalog-info.yaml` file already exists in the repository, please use the built-in `Register Existing Component` button in the `Create...` page instead and provide the url to the `catalog-info.yaml`:
-  ![Built-in Register Existing Component](./images/built-in-register-existing-component.png)
-
-### Required Gitlab permissions
-
-- Please ensure the gitlab host is added to the `app-config.yaml` file in the backstage instance
-- The Gitlab access token needs to have `api` read & write scopes and be added to your gitlab integration
-- If using a private Gitlab instance, please make sure the `apiBaseUrl` is set correctly:
+- Ensure the gitlab host is added to the `app-config.yaml` file in the backstage instance
+- If using a private Gitlab instance, make sure the `apiBaseUrl` is set correctly:
 
   ```yaml
   integrations:
@@ -22,6 +15,14 @@ This template is intended to be used as a starting point for registering an exis
         apiBaseUrl: https://gitlab.mycompany.com/api/v4 # This field is optional if host is `gitlab.com`
   ```
 
+- Make sure that the `add-catalog-info` branch and `catalog-info.yaml` file do not already exist in the project, or else the template will fail
+- If a `catalog-info.yaml` file already exists in the repository, please use the built-in `Register Existing Component` button in the `Create...` page instead and provide the url to the `catalog-info.yaml`:
+  ![Built-in Register Existing Component](./images/built-in-register-existing-component.png)
+
+### Required Gitlab permissions
+
+- The Gitlab access token needs to have `api` read & write scopes and be added to your gitlab integration
+
 ## Usage
 
 ![gitlab-location-info-image](./images/gitlab-location-info.png)