Skip to content

Commit

Permalink
chore: fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
kadel committed Oct 17, 2024
1 parent 640a440 commit 8fdd316
Show file tree
Hide file tree
Showing 5 changed files with 892 additions and 10 deletions.
16 changes: 8 additions & 8 deletions docs/dynamic-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
- **[Using a Custom NPM Registry](#using-a-custom-npm-registry)**
- **[Air Gapped Environment](#air-gapped-environment)**
- **[Plugin Configuration](#plugin-configuration)**
- [**Frontend Layout Configuration**](frontend-layout-configuration)
- [**Frontend Layout Configuration**](#frontend-layout-configuration)
- **[Extend Internal Library of Available Icons](#extend-internal-library-of-available-icons)**
- **[Dynamic Routes](#dynamic-routes)**
- **[Menu Items](#menu-items)**
Expand Down Expand Up @@ -77,8 +77,8 @@ These recommended changes to the `package.json` are summarized below:
}
```

> [!NOTE]
> 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).
> [!NOTE]
> 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).
#### Required entry points

Expand Down Expand Up @@ -164,7 +164,7 @@ These recommended changes to the `package.json` are summarized below:
...
```

> [!NOTE]
> [!NOTE]
> The option `--in-place` can be used to add frontend dynamic plugin assets to the `dist-scalprum` folder of the original plugin package.
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:
Expand Down Expand Up @@ -342,10 +342,10 @@ Note: 2.12 is the last version released from <https://github.com/janus-idp/helm-
- `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).
- `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`.

> [!NOTE]
> [!NOTE]
> 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.

> [!NOTE]
> [!NOTE]
> For NPM packages You can easily obtain the integrity checksum using the following command:
>
> ```console
Expand Down Expand Up @@ -445,7 +445,7 @@ global:

### Example of external dynamic backend plugins

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

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.
Expand Down Expand Up @@ -482,7 +482,7 @@ By sequentially adding these plugins and allowing for a deployment restart after

### Using a custom NPM registry

> [!WARNING]
> [!WARNING]
> 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.

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:
Expand Down
Loading

0 comments on commit 8fdd316

Please sign in to comment.