Skip to content

Commit 0aba71e

Browse files
committed
chore: fix broken links
1 parent 514feda commit 0aba71e

File tree

5 files changed

+21
-27
lines changed

5 files changed

+21
-27
lines changed

README.md

+3-13
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# [Janus Showcase](https://showcase.janus-idp.io)
1+
# Janus Showcase
22

33
[0]: https://quay.io/repository/janus-idp/backstage-showcase
44

@@ -51,30 +51,20 @@ Dependencies:
5151
- [Node.js](https://nodejs.org/en/) 18
5252
- [yarn](https://classic.yarnpkg.com/en/docs/install#debian-stable)
5353

54-
Information on running the showcase app can be found in our [Getting Started](https://github.com/janus-idp/backstage-showcase/blob/main/showcase-docs/getting-started.md) documentation. In the documentation is how to set up and run an instance of the showcase app locally. We plan to expand upon the documentation at a later point if there is enough interest in other methods for getting the app up and running.
54+
Information on running the showcase app can be found in our [Getting Started](https://github.com/janus-idp/backstage-showcase/blob/main/docs/index.md) documentation. In the documentation is how to set up and run an instance of the showcase app locally. We plan to expand upon the documentation at a later point if there is enough interest in other methods for getting the app up and running.
5555

5656
We are excited to see people wanting to contribute to our project and welcome anyone who wishes to participate. You are more than welcome to browse through our open issues and tackle anything you feel confident in working on.
5757

5858
We also welcome non code contributions in the form of bug reporting and documentation writing. If you run across any bugs in the showcase app, please raise an issue here in [GitHub](https://github.com/janus-idp/backstage-showcase/issues/new?assignees=&labels=kind%2Fbug%2Cstatus%2Ftriage&template=bug.md).
5959

6060
## Community, Discussion, and Support
6161

62-
The Janus Community meeting is held biweekly on Thursday at 1:30 UTC via [Google Meet](https://meet.google.com/taq-tpfs-rre). An [agenda](https://docs.google.com/document/d/1RYkKxBRj6uMT5PTIugAuxAIYK9WxTkKgqdcdw1752Dc/edit?usp=sharing) can be found for the meeting and we encourage you to add any topics that you wish to discuss.
63-
64-
[Bugs](https://github.com/janus-idp/backstage-showcase/issues/new?assignees=&labels=kind%2Fbug%2Cstatus%2Ftriage&template=bug.md) should be filled out here on GitHub.
65-
66-
Join the [community slack channel](https://join.slack.com/t/janus-idp/shared_invite/zt-1pxtehxom-fCFtF9rRe3vFqUiFFeAkmg) for a quick way to reach us or members of the community for discussion and collaboration.
67-
68-
Want to see a plugin in the showcase? Create an [issue](https://github.com/janus-idp/backstage-showcase/issues/new?assignees=&labels=kind%2Ffeature%2Cstatus%2Ftriage&template=feature.md) and we will discuss if it is right for the project.
69-
70-
Have an idea for a plugin? Submit a [proposal](https://github.com/janus-idp/backstage-plugins/issues/new?assignees=&labels=plugin&template=plugin.yaml&title=%F0%9F%94%8C+Plugin%3A+) to the Janus IDP Backstage Plugins repo.
62+
[Bugs](https://issues.redhat.com/projects/RHIDP) should be filled out here on RHIDP Jira.
7163

7264
## Resources
7365

7466
Our [blog](https://janus-idp.io/blog) is a great way to see what we are up to.
7567

76-
You can find the Backstage Showcase app running at <https://showcase.janus-idp.io>.
77-
7868
For more information on our plugin offerings, consult the [Janus IDP Backstage Plugins](https://github.com/janus-idp/backstage-plugins) repo.
7969

8070
Want to know more about Backstage, consult the [documentation](https://backstage.io/docs/overview/what-is-backstage) and [GitHub](https://github.com/backstage/backstage) repo.

docs/dynamic-plugins.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
- **[Using a Custom NPM Registry](#using-a-custom-npm-registry)**
2727
- **[Air Gapped Environment](#air-gapped-environment)**
2828
- **[Plugin Configuration](#plugin-configuration)**
29-
- [**Frontend Layout Configuration**](frontend-layout-configuration)
29+
- [**Frontend Layout Configuration**](#frontend-layout-configuration)
3030
- **[Extend Internal Library of Available Icons](#extend-internal-library-of-available-icons)**
3131
- **[Dynamic Routes](#dynamic-routes)**
3232
- **[Menu Items](#menu-items)**
@@ -77,8 +77,8 @@ These recommended changes to the `package.json` are summarized below:
7777
}
7878
```
7979

80-
> [!NOTE]
81-
> The option `--embed-as-dependencies` includes embedded packages as private dependencies of backend plugins. When value is `false` (using `--no-embed-as-dependencies`), source code of embedded plugins is merged with the generated code, so that the embedded plugin packages are completly erased (only available for legacy reasons: use with care).
80+
> [!NOTE]
81+
> The option `--embed-as-dependencies` includes embedded packages as private dependencies of backend plugins. When value is `false` (using `--no-embed-as-dependencies`), source code of embedded plugins is merged with the generated code, so that the embedded plugin packages are completly erased (only available for legacy reasons: use with care).
8282
8383
#### Required entry points
8484

@@ -164,7 +164,7 @@ These recommended changes to the `package.json` are summarized below:
164164
...
165165
```
166166

167-
> [!NOTE]
167+
> [!NOTE]
168168
> The option `--in-place` can be used to add frontend dynamic plugin assets to the `dist-scalprum` folder of the original plugin package.
169169
170170
Our CLI can generate the default configuration for Scalprum on the fly. For generated defaults see logs when running `yarn export-dynamic`. We default to the following configuration:
@@ -342,10 +342,10 @@ Note: 2.12 is the last version released from <https://github.com/janus-idp/helm-
342342
- `package`: a [package specification](https://docs.npmjs.com/cli/v10/using-npm/package-spec) indicating the dynamic plugin package to install (can be from a local path, OCI registry path or an NPM repository).
343343
- `integrity`: (required for external packages) An integrity checksum in the [format of `<alg>-<digest>`](https://w3c.github.io/webappsec-subresource-integrity/#integrity-metadata-description) specific to the package. Supported algorithms include `sha256`, `sha384`, and `sha512`.
344344

345-
> [!NOTE]
345+
> [!NOTE]
346346
> For OCI images paths the integratiy field can be ommited and the [image digest](https://github.com/opencontainers/image-spec/blob/main/descriptor.md#digests) can be used in the plugin package path.
347347

348-
> [!NOTE]
348+
> [!NOTE]
349349
> For NPM packages You can easily obtain the integrity checksum using the following command:
350350
>
351351
> ```console
@@ -445,7 +445,7 @@ global:
445445

446446
### Example of external dynamic backend plugins
447447

448-
> [!IMPORTANT]
448+
> [!IMPORTANT]
449449
> This section is a subject to change to be replaced with plugins published in OCI images examples
450450

451451
If you wish to easily test the installation of dynamic backend plugins from an external NPM registry, you can utilize the example dynamic backend plugins outlined in the [dynamic backend plugin showcase repository](https://github.com/janus-idp/dynamic-backend-plugins-showcase/tree/main#provided-example-dynamic-plugins), which have been published to NPMJS for demonstration purposes.
@@ -482,7 +482,7 @@ By sequentially adding these plugins and allowing for a deployment restart after
482482

483483
### Using a custom NPM registry
484484

485-
> [!WARNING]
485+
> [!WARNING]
486486
> Using a custom NPM Registry and/or NPMJS is not recommended. A dynamic plugin is a runtime artifact, and that it is not the best usage of an NPM registry to deliver runtime artifacts, especially in a container-based environment such as OCP. Using [Container Registry](#consuming-dynamic-plugins-from-a-container-registry) or [Local Configuration](#local-configuration) is recommended and supported for dynamic plugins production environments.
487487

488488
To configure the NPM registry URL and authentication information for dynamic plugin packages obtained through `npm pack`, you can utilize a `.npmrc` file. When using the Helm chart, you can add this file by creating a secret named `dynamic-plugins-npmrc` with the following content:

docs/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -231,14 +231,14 @@ The easiest and fastest method for getting started: Backstage Showcase app, runn
231231
- Setup the PagerDuty plugin
232232

233233
- `${PAGERDUTY_TOKEN}` with the [API token](https://support.pagerduty.com/docs/api-access-keys#generating-a-general-access-rest-api-key) used to make requests to the [PagerDuty API](https://developer.pagerduty.com/docs/rest-api-v2/rest-api/). Note that this will require a PaperDuty Admin role.
234-
- To integrate with a PagerDuty Service, you will need to annotate the appropriate entity with the [PagerDuty Integration key](https://github.com/backstage/backstage/tree/master/plugins/pagerduty#integrating-with-a-pagerduty-service) in its `.yaml` configuration file:
234+
- To integrate with a PagerDuty Service, you will need to annotate the appropriate entity with the [PagerDuty Integration key](https://pagerduty.github.io/backstage-plugin-docs/getting-started/pagerduty/) in its `.yaml` configuration file:
235235

236236
```yaml
237237
annotations:
238238
pagerduty.com/integration-key: [INTEGRATION_KEY]
239239
```
240240

241-
- Alternatively, you can integrate with the [PagerDuty ServiceID](https://github.com/backstage/backstage/tree/master/plugins/pagerduty#annotating-with-service-id) instead of the integration key:
241+
- Alternatively, you can integrate with the [PagerDuty ServiceID](https://pagerduty.github.io/backstage-plugin-docs/getting-started/backstage/#annotating-entities) instead of the integration key:
242242

243243
```yaml
244244
annotations:
@@ -265,7 +265,7 @@ The easiest and fastest method for getting started: Backstage Showcase app, runn
265265

266266
- Setup the Dynatrace plugin
267267

268-
- This [URL](https://github.com/backstage/backstage/tree/master/plugins/dynatrace#getting-started) explains how to use the Dynatrace Plugin
268+
- This [URL](https://github.com/backstage/community-plugins/tree/main/workspaces/dynatrace/plugins/dynatrace#getting-started) explains how to use the Dynatrace Plugin
269269
- `${DYNATRACE_URL}`: The baseURL for rendering links to problems in the table
270270
- `${DYNATRACE_API_URL}`: The URL to the Dynatrace API
271271
- `{DYNATRACE_ACCESS_TOKEN}`: API access token (see [documentation](https://www.dynatrace.com/support/help/dynatrace-api/basics/dynatrace-api-authentication)) with `entities.read`,`problems.read` permissions. It will also need one of the following permissions: `DataExport`, `ExternalSyntheticIntegration`, or `ReadSyntheticData`.

docs/mkdocs.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
site_name: Documentation Site
2+
docs_dir: docs
3+
plugins:
4+
- techdocs-core

docs/monitoring-and-logging.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ When deploying Backstage Showcase onto a kubernetes cluster with the [RHDH Helm
1616

1717
### Enabling Metrics Monitoring on Openshift
1818

19-
To enable metrics monitoring on OpenShift, we need to create a `ServiceMonitor` resource in the OpenShift cluster that will be used by Prometheus to scrape metrics from your Backstage instance. For the metrics to be ingested by the built-in Prometheus instances in Openshift, please ensure you enabled [monitoring for user-defined projects](https://docs.openshift.com/container-platform/latest/monitoring/enabling-monitoring-for-user-defined-projects.html).
19+
To enable metrics monitoring on OpenShift, we need to create a `ServiceMonitor` resource in the OpenShift cluster that will be used by Prometheus to scrape metrics from your Backstage instance. For the metrics to be ingested by the built-in Prometheus instances in Openshift, please ensure you enabled [monitoring for user-defined projects](https://docs.openshift.com/container-platform/latest/observability/monitoring/enabling-monitoring-for-user-defined-projects.html).
2020

2121
#### Helm deployment
2222

@@ -174,13 +174,13 @@ For the _metrics_ add-on, we can modify the [`ama-metrics-settings-configmap`](h
174174

175175
Alternatively, we will can instead add/modify the `ama-metrics-prometheus-config` Config Map in the `kube-system` namespace of the AKS cluster to configure custom scrape jobs. In the [example Config Map](./configuration_files/ama-metrics-prometheus-config.yaml), please replace the values of namespace with the namespace you the backstage instance into. For more information on how to configure this refer to the [official Azure docs](https://learn.microsoft.com/en-us/azure/azure-monitor/containers/prometheus-metrics-scrape-configuration#configure-custom-prometheus-scrape-jobs).
176176

177-
To view the metrics, you can create a Grafana instance, [connect it to the Azure Monitor workspace](https://docs.microsoft.com/en-us/azure/azure-monitor/visualize/tutorial-logs-dashboards-with-grafana#connect-grafana-to-azure-monitor) and view the metrics using PromQL queries.
177+
To view the metrics, you can create a Grafana instance, [configure an Azure Monitor data source plug-in](https://learn.microsoft.com/en-us/azure/azure-monitor/visualize/grafana-plugin#configure-an-azure-monitor-data-source-plug-in) and view the metrics using PromQL queries.
178178

179179
#### Monitoring Add-on
180180

181181
For the _monitoring_ add-on, we will need to add the a modified instance of this [Config Map](https://raw.githubusercontent.com/microsoft/Docker-Provider/ci_prod/kubernetes/container-azm-ms-agentconfig.yaml) to the `kube-system` namespace of the AKS cluster. In the [example Config Map](./configuration_files/container-azm-ms-agentconfig.yaml), please replace the values of namespace with the namespace you deployed the backstage instance into. For more information refer to the [official Azure docs](https://learn.microsoft.com/en-us/azure/azure-monitor/containers/container-insights-prometheus-logs?tabs=cluster-wide).
182182

183-
To view the metrics, you can create a Grafana instance, [connect it to the Azure Monitor workspace](https://docs.microsoft.com/en-us/azure/azure-monitor/visualize/tutorial-logs-dashboards-with-grafana#connect-grafana-to-azure-monitor) and view the metrics using PromQL queries.
183+
To view the metrics, you can create a Grafana instance, [configure an Azure Monitor data source plug-in](https://learn.microsoft.com/en-us/azure/azure-monitor/visualize/grafana-plugin#configure-an-azure-monitor-data-source-plug-in) and view the metrics using PromQL queries.
184184

185185
Alternatively, you can use [Log Analytics](https://learn.microsoft.com/en-us/azure/azure-monitor/containers/container-insights-log-query#prometheus-metrics) to query the metrics using KQL. The following is an example query to get a custom metric for the Backstage instance:
186186

0 commit comments

Comments
 (0)