Skip to content

Commit

Permalink
docs: fix argocd naming (#1904)
Browse files Browse the repository at this point in the history
  • Loading branch information
christoph-jerolimov authored Jul 18, 2024
1 parent e0f7866 commit 3173d79
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions plugins/argocd/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
# Argocd plugin for Backstage

Welcome to the argocd plugin!

_This plugin was created through the Backstage CLI_
# Argo CD plugin for Backstage

## Getting started

Expand All @@ -25,7 +21,7 @@ It is only meant for local development, and the setup for it can be found inside
yarn workspace app add @roadiehq/backstage-plugin-argo-cd-backend
```

- Create plugin file for ArgoCD backend in your `packages/backend/src/plugins/` directory.
- Create plugin file for Argo CD backend in your `packages/backend/src/plugins/` directory.

```ts
// packages/backend/src/plugins/argocd.ts
Expand All @@ -42,7 +38,7 @@ export default async function createPlugin({
}
```

- Modify your backend router to expose the APIs for ArgoCD backend
- Modify your backend router to expose the APIs for Argo CD backend

```ts
// packages/backend/src/index.ts
Expand Down Expand Up @@ -120,7 +116,7 @@ const cicdcontent = (
);
```

- The following annotation is added to the entity's `catalog-info.yaml` file to enable argocd features in the backstage instance:
- The following annotation is added to the entity's `catalog-info.yaml` file to enable Argo CD features in the backstage instance:

```yaml
annotations:
Expand All @@ -138,7 +134,7 @@ const cicdcontent = (
argocd/instance-name: 'argoInstance2'
```
**_Note: If this annotation is not set, the plugin will defaultto the first argocd instance configured in the `app.config.yaml`_**
**_Note: If this annotation is not set, the plugin will default to the first Argo CD instance configured in the `app.config.yaml`_**

## Loading as Dynamic Plugin

Expand Down

0 comments on commit 3173d79

Please sign in to comment.