docs: add known issues doc with some workarounds (#2331)

* docs: add known issues doc with some workarounds

Signed-off-by: Christoph Jerolimov <[email protected]>

* docs: update or remove outdated links

Signed-off-by: Christoph Jerolimov <[email protected]>

---------

Signed-off-by: Christoph Jerolimov <[email protected]>
Co-authored-by: Tomas Kral <[email protected]>

Author: christoph-jerolimov

docs/dynamic-plugins/export-derived-package.md

@@ -43,8 +43,10 @@ If you are developing your own plugin that is going to be used as a dynamic plug
 To be compatible with the showcase dynamic plugin support, and used as dynamic plugins, existing plugins must be based on, or compatible with, the new backend system, as well as rebuilt with a dedicated CLI command.
 
 The new backend system standard entry point (created using `createBackendPlugin()` or `createBackendModule()`) should be exported as the default export of either the main package or of an `alpha` package (if the new backend support is still provided as `alpha` APIs). This doesn't add any additional requirement on top of the standard plugin development guidelines of the new backend system.
+
 For a practical example of a dynamic plugin entry point built upon the new backend system, please refer to the [Backstage community plugins repository](https://github.com/backstage/community-plugins/blob/main/workspaces/3scale/plugins/3scale-backend/src/module.ts).
 
+
 The dynamic export mechanism identifies private, non-backstage dependencies, and sets the `bundleDependencies` field in the `package.json` file for them, so that the dynamic plugin package can be published as a self-contained package, along with its private dependencies bundled in a private `node_modules` folder.
 
 ### Shared dependencies

docs/dynamic-plugins/known-issues.md

@@ -0,0 +1,59 @@
+# Known Issues
+
+## MUI Version 5 releated issues
+
+### Styles are missing
+
+When your plugin uses MUI v5 and is loaded as a dynamic plugin, it will miss some of the default CSS declations from MUI and Backstage/RHDH.
+
+**Workaround:**
+
+Add the following source code to your `<plugin>/src/index.ts` before your plugin is exported:
+
+```tsx
+import { unstable_ClassNameGenerator as ClassNameGenerator } from '@mui/material/className';
+
+ClassNameGenerator.configure(componentName => {
+  return componentName.startsWith('v5-')
+    ? componentName
+    : `v5-${componentName}`;
+});
+
+export * from './plugin';
+```
+
+**Alternatives:**
+
+* Use Backstage Core Components or Material UI v4 components from `@material-ui/core/*`.
+
+**Related issues:**
+
+* [RHIDP-5170 - Dynamic plugin loaded plugins that uses MUI v5 looks different then static loaded plugins](https://issues.redhat.com/browse/RHIDP-5170)
+* [RHIDP-5847 - Narrow the accepted versions in the scalprum webpack federated module configuration](https://issues.redhat.com/browse/RHIDP-5847)
+
+### Grid cards/component misses the default spacing from Backstage
+
+When your plugin is using the Grid component from `@mui/material/Grid` the default spacing from the Backstage/RHDH theme is missing.
+
+**Workaround:**
+
+Manually apply the prop `spacing={2}` to the `Grid container`s:
+
+```tsx
+<Grid container spacing={2} ...>
+  <Grid item ...>
+    ...
+  </Grid>
+  <Grid item ...>
+    ...
+  </Grid>
+</Grid>
+```
+
+**Alternatives:**
+
+* Use Material UI v4 Grid from `@material-ui/core/Grid`.
+
+**Related issues:**
+
+* [RHIDP-5170 - Dynamic plugin loaded plugins that uses MUI v5 looks different then static loaded plugins](https://issues.redhat.com/browse/RHIDP-5170)

docs/index.md

@@ -8,7 +8,7 @@ The telemetry data collection feature is used to enhance your experience with th
 
 **Telemetry data collection is enabled by default.**
 
-To disable telemetry data collection, you need to disable the [`@janus-idp/backstage-plugin-analytics-provider-segment`](https://github.com/janus-idp/backstage-plugins/tree/main/plugins/analytics-provider-segment) plugin as documented below.
+To disable telemetry data collection, you need to disable the [`@backstage-community/plugin-analytics-provider-segment`](https://github.com/backstage/community-plugins/tree/main/workspaces/analytics/plugins/analytics-provider-segment) plugin as documented below.
 
 - **Anonymous configuration**:
 

packages/app/CHANGELOG.md

@@ -164,7 +164,7 @@
      generator:
   ```
 
-- cb6c541: The [Jfrog Artifactory plugin](https://github.com/janus-idp/backstage-plugins/tree/main/plugins/jfrog-artifactory) has been added with the `JfrogArtifactoryPage` in the Entity Page image registry tab.
+- cb6c541: The [Jfrog Artifactory plugin](https://github.com/backstage/community-plugins/tree/main/workspaces/jfrog-artifactory/plugins/jfrog-artifactory) has been added with the `JfrogArtifactoryPage` in the Entity Page image registry tab.
 
   These changes are **required** to `app-config.yaml` if you want to add the JFrog Artifactory plugin. Please read the [README](https://github.com/redhat-developer/rhdh/blob/main/README.md) and [Getting Started](https://github.com/redhat-developer/rhdh/blob/main/showcase-docs/getting-started.md) for more details.