Skip to content

Commit e628a2b

Browse files
authored
chore(migration): refactor repo and image (redhat-developer#2181)
* chore(CI): refactor repo URL and image repo - E2E * Dynamic plugins package.json * Docs * Others
1 parent ee3bde5 commit e628a2b

File tree

106 files changed

+140
-140
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

106 files changed

+140
-140
lines changed

.ibm/pipelines/env_variables.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ HELM_IMAGE_NAME=backstage
1414
HELM_REPO_NAME=rhdh-chart
1515
HELM_REPO_URL="https://redhat-developer.github.io/rhdh-chart"
1616
K8S_CLUSTER_TOKEN_ENCODED=$(printf "%s" $K8S_CLUSTER_TOKEN | base64 | tr -d '\n')
17-
QUAY_REPO="${QUAY_REPO:-janus-idp/backstage-showcase}"
17+
QUAY_REPO="${QUAY_REPO:-rhdh-community/rhdh}"
1818

1919
RELEASE_NAME=rhdh
2020
RELEASE_NAME_RBAC=rhdh-rbac

.ibm/pipelines/resources/postgres-db/values-showcase-postgres.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ upstream:
1111
image:
1212
pullPolicy: Always
1313
registry: quay.io
14-
repository: janus-idp/backstage-showcase
14+
repository: rhdh-community/rhdh
1515
tag: next
1616
appConfig:
1717
app:

.ibm/pipelines/value_files/values_showcase-rbac.yaml

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ global:
33
# -- Array of YAML files listing dynamic plugins to include with those listed in the `plugins` field.
44
# Relative paths are resolved from the working directory of the initContainer that will install the plugins (`/opt/app-root/src`).
55
includes:
6-
# -- List of dynamic plugins included inside the `janus-idp/backstage-showcase` container image, some of which are disabled by default.
7-
# This file ONLY works with the `janus-idp/backstage-showcase` container image.
6+
# -- List of dynamic plugins included inside the `rhdh-community/rhdh` container image, some of which are disabled by default.
7+
# This file ONLY works with the `rhdh-community/rhdh` container image.
88
- 'dynamic-plugins.default.yaml'
99

1010
# -- List of dynamic plugins, possibly overriding the plugins listed in `includes` files.
@@ -117,9 +117,9 @@ upstream:
117117
backstage:
118118
image:
119119
pullPolicy: Always
120-
# using test image from https://quay.io/repository/janus-idp/backstage-showcase
120+
# using test image from https://quay.io/repository/rhdh-community/rhdh
121121
registry: quay.io
122-
repository: janus-idp/backstage-showcase
122+
repository: rhdh-community/rhdh
123123
tag: next
124124
appConfig:
125125
app:
@@ -205,7 +205,7 @@ upstream:
205205
- name: install-dynamic-plugins
206206
# -- Image used by the initContainer to install dynamic plugins into the `dynamic-plugins-root` volume mount.
207207
# It could be replaced by a custom image based on this one.
208-
# @default -- `quay.io/janus-idp/backstage-showcase:latest`
208+
# @default -- `quay.io/rhdh-community/rhdh:latest`
209209
image: '{{ include "backstage.image" . }}'
210210
command:
211211
- sh

.ibm/pipelines/value_files/values_showcase.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ global:
33
# -- Array of YAML files listing dynamic plugins to include with those listed in the `plugins` field.
44
# Relative paths are resolved from the working directory of the initContainer that will install the plugins (`/opt/app-root/src`).
55
includes:
6-
# -- List of dynamic plugins included inside the `janus-idp/backstage-showcase` container image, some of which are disabled by default.
7-
# This file ONLY works with the `janus-idp/backstage-showcase` container image.
6+
# -- List of dynamic plugins included inside the `rhdh-community/rhdh` container image, some of which are disabled by default.
7+
# This file ONLY works with the `rhdh-community/rhdh` container image.
88
- 'dynamic-plugins.default.yaml'
99

1010
# -- List of dynamic plugins, possibly overriding the plugins listed in `includes` files.
@@ -127,7 +127,7 @@ upstream:
127127
image:
128128
pullPolicy: Always
129129
registry: quay.io
130-
repository: janus-idp/backstage-showcase
130+
repository: rhdh-community/rhdh
131131
tag: next
132132
extraEnvVars:
133133
- name: BACKEND_SECRET

CONTRIBUTING.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ yarn tsc # Run type ge
1515

1616
### Run the Showcase App
1717

18-
We currently have quite a bit of moving parts for the showcase application. As such, we have documentation dedicated to the requirements for running the showcase app under [getting-started.md](https://github.com/janus-idp/backstage-showcase/blob/main/docs/index.md).
18+
We currently have quite a bit of moving parts for the showcase application. As such, we have documentation dedicated to the requirements for running the showcase app under [getting-started.md](https://github.com/redhat-developer/rhdh/blob/main/docs/index.md).
1919

2020
### Useful Scripts
2121

@@ -40,11 +40,11 @@ We welcome code and non-code contributions to our project. Non-code contribution
4040

4141
### Finding Issues to Work On
4242

43-
Want to submit some changes to the code? The best place to start is to look through our issues for [bugs](https://github.com/janus-idp/backstage-showcase/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fbug), [good first issues](https://github.com/janus-idp/backstage-showcase/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), and [help wanted](https://github.com/janus-idp/backstage-showcase/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). These are a great starting point for new contributors.
43+
Want to submit some changes to the code? The best place to start is to look through our issues for [bugs](https://github.com/redhat-developer/rhdh/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fbug), [good first issues](https://github.com/redhat-developer/rhdh/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), and [help wanted](https://github.com/redhat-developer/rhdh/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). These are a great starting point for new contributors.
4444

4545
### Bug Reporting
4646

47-
If you found a bug in our showcase app, please submit an [issue](https://github.com/janus-idp/backstage-showcase/issues/new?assignees=&labels=kind%2Fbug%2Cstatus%2Ftriage&template=bug.md) describing the problem that you ran into. Important information to include:
47+
If you found a bug in our showcase app, please submit an [issue](https://github.com/redhat-developer/rhdh/issues/new?assignees=&labels=kind%2Fbug%2Cstatus%2Ftriage&template=bug.md) describing the problem that you ran into. Important information to include:
4848

4949
- Steps to reproduce the bug
5050
- The `app-config.yaml` that is being used (**remember to remove all secrets before sharing**)
@@ -62,15 +62,15 @@ yarn versions:bump # Updates Backstage dependencies
6262

6363
### Enhancement Requests
6464

65-
If you want an enhancement of a feature or workflow, you can submit an [issue](https://github.com/janus-idp/backstage-showcase/issues/new?assignees=&labels=kind%2Fenhancement%2Cstatus%2Ftriage&template=enhancement.md) describing the enhancement. Include:
65+
If you want an enhancement of a feature or workflow, you can submit an [issue](https://github.com/redhat-developer/rhdh/issues/new?assignees=&labels=kind%2Fenhancement%2Cstatus%2Ftriage&template=enhancement.md) describing the enhancement. Include:
6666

6767
- What you are wanting to see improved
6868
- The current behavior
6969
- The new behavior you wish to see
7070

7171
### Feature Requests
7272

73-
If you want to see a new feature within the showcase app, file an [issue](https://github.com/janus-idp/backstage-showcase/issues/new?assignees=&labels=kind%2Ffeature%2Cstatus%2Ftriage&template=feature.md) detailing the new feature. Include:
73+
If you want to see a new feature within the showcase app, file an [issue](https://github.com/redhat-developer/rhdh/issues/new?assignees=&labels=kind%2Ffeature%2Cstatus%2Ftriage&template=feature.md) detailing the new feature. Include:
7474

7575
- What you are trying to achieve with the new feature
7676
- What you will need
@@ -179,4 +179,4 @@ You can reach out to us in our [community Slack channel](https://join.slack.com/
179179

180180
## License
181181

182-
By contributing, you agree that your contributions will be licensed under the [Apache-2.0 License](https://github.com/janus-idp/backstage-showcase/blob/main/LICENSE).
182+
By contributing, you agree that your contributions will be licensed under the [Apache-2.0 License](https://github.com/redhat-developer/rhdh/blob/main/LICENSE).

app-config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ catalog:
151151
- allow: [Component, System, Group, Resource, Location, Template, API]
152152
locations:
153153
- type: url
154-
target: https://github.com/janus-idp/backstage-showcase/blob/main/catalog-entities/all.yaml
154+
target: https://github.com/redhat-developer/rhdh/blob/main/catalog-entities/all.yaml
155155

156156
- type: url
157157
target: https://github.com/redhat-developer/red-hat-developer-hub-software-templates/blob/main/templates.yaml

catalog-entities/apis/nexus-repo-manager-3.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ spec:
1515
owner: janus-authors
1616
lifecycle: production
1717
definition:
18-
$openapi: https://github.com/janus-idp/backstage-showcase/blob/main/catalog-entities/apis/nexus-swagger.json
18+
$openapi: https://github.com/redhat-developer/rhdh/blob/main/catalog-entities/apis/nexus-swagger.json

catalog-entities/components/showcase.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ metadata:
1717
annotations:
1818
argocd/app-name: 'janus-idp'
1919
backstage.io/kubernetes-id: 'janus-idp'
20-
github.com/project-slug: janus-idp/backstage-showcase
21-
quay.io/repository-slug: janus-idp/backstage-showcase
22-
backstage.io/techdocs-ref: url:https://github.com/janus-idp/backstage-showcase
20+
github.com/project-slug: redhat-developer/rhdh
21+
quay.io/repository-slug: rhdh-community/rhdh
22+
backstage.io/techdocs-ref: url:https://github.com/redhat-developer/rhdh
2323
backstage.io/kubernetes-namespace: janus-idp-prod
2424
sonarqube.org/project-key: janus-idp_backstage-showcase
2525
spec:

catalog-entities/resources/github.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ metadata:
55
title: GitHub Showcase repository
66
description: We store our deployment manifests and code for the janus showcase in this GitHub repository.
77
links:
8-
- url: https://github.com/janus-idp/backstage-showcase
8+
- url: https://github.com/redhat-developer/rhdh
99
title: GitHub Repository
1010
icon: web
1111
spec:

docker/README.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ If you want an image that runs on Mac M1 (arm64/aarch64) or another architecture
1111
Check out this repo, choose the branch or tag you want to use, then build an image:
1212

1313
```
14-
podman build -f docker/Dockerfile . -t janus-idp/backstage-showcase:local
14+
podman build -f docker/Dockerfile . -t redhat-developer/rhdh:local
1515
```
1616

1717
## Downstream builds

docs/customization.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ dynamicPlugins:
4444

4545
See [Menu items](dynamic-plugins/frontend-plugin-wiring.md#menu-items) from dynamic-plugins documentation for more details.
4646

47-
See [DefaultMainMenuItems](https://github.com/janus-idp/backstage-showcase/blob/main/packages/app/src/consts.ts#L1) for a list of main menu items, including their default priorities.
47+
See [DefaultMainMenuItems](https://github.com/redhat-developer/rhdh/blob/main/packages/app/src/consts.ts#L1) for a list of main menu items, including their default priorities.
4848

4949
## Changing the favicon and tab title
5050

@@ -143,12 +143,12 @@ Example configurations:
143143
```
144144
app:
145145
support:
146-
url: https://github.com/janus-idp/backstage-showcase/issues # Used as contact support link on common ErrorPage
146+
url: https://github.com/redhat-developer/rhdh/issues # Used as contact support link on common ErrorPage
147147
items: # Used by common SupportButton component
148148
- title: Issues
149149
icon: github
150150
links:
151-
- url: https://github.com/janus-idp/backstage-showcase/issues
151+
- url: https://github.com/redhat-developer/rhdh/issues
152152
title: GitHub Issues
153153
- title: Join the community
154154
icon: chat

docs/dynamic-plugins/frontend-plugin-wiring.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ Up to 3 levels of nested menu items are supported.
172172
- For `path: /docs`, the `menu_item_name` should be `docs`.
173173
- For `path: /metrics/users`, the `menu_item_name` should be `metrics.users`.
174174

175-
- `icon` - Optional. Defines the icon for the menu item, which refers to a Backstage system icon. See [Backstage system icons](https://backstage.io/docs/getting-started/app-custom-theme/#icons) for the default list, or extend the icon set using dynamic plugins. RHDH also provides additional icons in its internal library. See [CommonIcons.tsx](https://github.com/janus-idp/backstage-showcase/blob/main/packages/app/src/components/DynamicRoot/CommonIcons.tsx) for reference. If the icon is already defined in the `dynamicRoutes` configuration under `menuItem.icon`, it can be omitted in the `menuItems` configuration.
175+
- `icon` - Optional. Defines the icon for the menu item, which refers to a Backstage system icon. See [Backstage system icons](https://backstage.io/docs/getting-started/app-custom-theme/#icons) for the default list, or extend the icon set using dynamic plugins. RHDH also provides additional icons in its internal library. See [CommonIcons.tsx](https://github.com/redhat-developer/rhdh/blob/main/packages/app/src/components/DynamicRoot/CommonIcons.tsx) for reference. If the icon is already defined in the `dynamicRoutes` configuration under `menuItem.icon`, it can be omitted in the `menuItems` configuration.
176176
- `title` - Optional. Specifies the display title of the menu item. This can also be omitted if it has already been defined in the `dynamicRoutes` configuration under `menuItem.text`.
177177
- `priority` - Optional. Defines the order in which menu items appear. The default priority is `0`, which places the item at the bottom of the list. A higher priority value will position the item higher in the sidebar.
178178
- `parent` - Optional. Defines the parent menu item to nest the current item under. If specified, the parent menu item must be defined somewhere else in the `menuItems` configuration of any enabled plugin.
@@ -459,7 +459,7 @@ dynamicPlugins:
459459
- `importName` is an optional import name that reference a `AnyApiFactory<{}>` implementation. Defaults to `default` export.
460460
- `module` is an optional argument which allows you to specify which set of assets you want to access within the plugin. If not provided, the default module named `PluginRoot` is used. This is the same as the key in `scalprum.exposedModules` key in plugin's `package.json`.
461461

462-
There are a set of [API factories](https://github.com/janus-idp/backstage-showcase/blob/main/packages/app/src/apis.ts) already initialized by the Developer Hub application shell. These API factories can be overridden by an API factory provided by a dynamic plugin by specifying the same API ref ID, for example a dynamic plugin could export the following `AnyApiFactory<{}>` to cater for some specific use case:
462+
There are a set of [API factories](https://github.com/redhat-developer/rhdh/blob/main/packages/app/src/apis.ts) already initialized by the Developer Hub application shell. These API factories can be overridden by an API factory provided by a dynamic plugin by specifying the same API ref ID, for example a dynamic plugin could export the following `AnyApiFactory<{}>` to cater for some specific use case:
463463

464464
```typescript
465465
export const customScmAuthApiFactory = createApiFactory({

docs/dynamic-plugins/installing-plugins.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Plugins are defined in the `plugins` array in the `dynamic-plugin-config.yaml` f
1414

1515
## Dynamic plugins included in the Showcase container image
1616

17-
The showcase container image is preloaded with a variety of dynamic plugins, the majority of which are initially disabled due to mandatory configuration requirements. The comprehensive list of these plugins is outlined in the [`dynamic-plugins.default.yaml`](https://github.com/janus-idp/backstage-showcase/blob/main/dynamic-plugins.default.yaml) file.
17+
The showcase container image is preloaded with a variety of dynamic plugins, the majority of which are initially disabled due to mandatory configuration requirements. The comprehensive list of these plugins is outlined in the [`dynamic-plugins.default.yaml`](https://github.com/redhat-developer/rhdh/blob/main/dynamic-plugins.default.yaml) file.
1818

1919
Upon the application startup, for each plugin disabled by default, the `install-dynamic-plugins` init container within the `backstage` Pod's log will exhibit a line similar to the following:
2020

0 commit comments

Comments
 (0)