[release-1.9] RHDHBUGS-2007: Do not use "foo" (#1820)

Co-authored-by: BigEars <lhite@redhat.com>
Co-authored-by: Fabrice Flore-Thébault <ffloreth@redhat.com>

Author: 3 people

modules/configuring-a-proxy/proc-configuring-proxy-in-helm-deployment.adoc

@@ -30,7 +30,7 @@ Where,
 
 `<http_proxy_url>`:: Denotes a variable that you must replace with the HTTP proxy URL.
 `<https_proxy_url>`:: Denotes a variable that you must replace with the HTTPS proxy URL.
-`<no_proxy_settings>`:: Denotes a variable that you must replace with comma-separated URLs, which you want to exclude from proxying, for example, `foo.com,baz.com`.
+`<no_proxy_settings>`:: Denotes a variable that you must replace with comma-separated URLs, which you want to exclude from proxying, for example, `__<example1>__.com,__<example2>__.com`.
 +
 .Example: Setting proxy variables using Helm Chart
 

modules/customizing-the-appearance/proc-configuring-dynamic-plugin-menuitem.adoc

@@ -9,13 +9,13 @@ Configure a dynamic plugin menu item using the following step:
 
 * In the `{my-app-config-file}` file, update the `menuItems` section of your _<plugin_name>_ plugin. For example:
 +
-[source,yaml]
+[source,yaml,subs="+quotes"]
 ----
 dynamicPlugins:
   frontend:
     _<plugin_name>_:
       menuItems:
-        <menu_item_name>: 
+        __<menu_item_name>__: 
           icon: # home | group | category | extension | school | _<my_icon>_ 
           title: _<plugin_page_title>_
           priority: 10
@@ -50,18 +50,18 @@ Enter a unique name in the main sidebar navigation for either a standalone menu
 Enter `true` to display the menu item in the sidebar.
 
 +
-[source,yaml,subs="+attributes"]
+[source,yaml,subs="+quotes,+attributes"]
 ----
 dynamicPlugins:
   frontend:
     _<package_name>_:
       dynamicRoutes:
-        - path: /my-plugin
+        - path: __</my-plugin>__
           module: CustomModule
-          importName: FooPluginPage
+          importName: __<my-plugin>__PluginPage
           menuItem:
-            icon: fooIcon
-            text: Foo Plugin Page
+            icon: # home | group | category | extension | school | _<my_icon>_
+            text: __<my-plugin label>__
       menuItems:
         my-plugin:
           priority: 10

modules/dynamic-plugins/proc-binding-to-existing-plugins.adoc

@@ -5,11 +5,11 @@
 
 You can bind to existing plugins and their routes, and declare new targets sourced from dynamic plugins as shown in the following `routeBindings` configuration:
 
-[source,yaml]
+[source,yaml,subs="+quotes"]
 ----
 # dynamic-plugins-config.yaml
 plugins:
-  - plugin: <plugin_path_or_url>
+  - plugin: __<plugin_path_or_url>__
     disabled: false
     pluginConfig:
       dynamicPlugins:
@@ -18,15 +18,15 @@ plugins:
             routeBindings:
               targets: # A new bind target
                   # (Optional): Defaults to importName. Explicit name of the plugin that exposes the bind target.
-                - name: barPlugin
+                - name: __<plugin_name>__Plugin
                   # (Required): Explicit import name that reference a BackstagePlugin<{}> implementation.
-                  importName: barPlugin
+                  importName: __<plugin_key>__Plugin
                   # # (Optional): Same as key in `scalprum.exposedModules` key in the `package.json` file of the plugin.
                   module: CustomModule
               bindings:
-                - bindTarget: "barPlugin.externalRoutes" # (Required): One of the supported or imported bind targets
+                - bindTarget: "__<plugin_name>__Plugin.externalRoutes" # (Required): One of the supported or imported bind targets
                   bindMap: #  A required map of route bindings similar to `bind` function options
-                    headerLink: "fooPlugin.routes.root"
+                    headerLink: "__<plugin_name>__Plugin.routes.root"
 ----
 
 To configure `routeBindings`, complete the following steps:

modules/dynamic-plugins/proc-customizing-entity-page.adoc

@@ -101,7 +101,7 @@ The available mount points include the following:
 
 [NOTE]
 ====
-Mount points within catalog such as `entity.page.` are rendered as tabs and become visible only if at least one plugin contributes to them, or if they can render static content.
+Mount points within a catalog such as `entity.page.` are rendered as tabs and become visible only if at least one plugin contributes to them, or if they can render static content.
 ====
 
 Each `entity.page.` mount point contains the following variations:
@@ -111,20 +111,20 @@ Each `entity.page.` mount point contains the following variations:
 
 The following is an example of the overall configuration structure of a mount point:
 
-[source,yaml]
+[source,yaml,subs="+quotes"]
 ----
 # dynamic-plugins-config.yaml
 plugins:
-  - plugin: <plugin_path_or_url>
+  - plugin: __<plugin_path_or_url>__
     disabled: false
     pluginConfig:
       dynamicPlugins:
         frontend:
           my-plugin: # The plugin package name
             mountPoints: # (Optional): Uses existing mount points
-              - mountPoint: <mountPointName>/[cards|context]
+              - mountPoint: __<mountPointName>__/[cards|context]
                 module: CustomModule
-                importName: FooPluginPage
+                importName: __<pluginName>__PluginPage
                 config: # (Optional): Allows you to pass additional configuration to the component
                   layout: {} # Used only in `/cards` type which renders visible content
                   # Use only in `/cards` type which renders visible content. `if` is passed to `<EntitySwitch.Case if={<here>}`.
@@ -162,11 +162,11 @@ export type SimpleDialogProps = {
 
 You can configure the context menu entry using the props configuration entry for the mount point. The `title` and `icon` properties sets the text and icon of the menu item. You can use any system icon or icon added through a dynamic plugin. The following is an example configuration:
 
-[source,yaml]
+[source,yaml,subs="+quotes"]
 ----
 # dynamic-plugins-config.yaml
 plugins:
-  - plugin: <plugin_path_or_url>
+  - plugin: __<plugin_path_or_url>__
     disabled: false
     pluginConfig:
       dynamicPlugins:

modules/dynamic-plugins/proc-customizing-sidebar-menu-items.adoc

@@ -5,23 +5,23 @@
 
 You can customize the order and parent-child relationships of plugin menu items in the main sidebar navigation using the menu items configuration as shown in the following example:
 
-[source,yaml]
+[source,yaml,subs="+quotes"]
 ----
 # dynamic-plugins-config.yaml
 plugins:
-  - plugin: <plugin_path_or_url>
+  - plugin: __<plugin_path_or_url>__
     disabled: false
     pluginConfig:
       dynamicPlugins:
         frontend:
           my-plugin: # The plugin package name
             menuItems:
               # The unique name in the main sidebar navigation (for example, either a standalone menu item or a parent menu item)
-              <menu_item_name>:
+              __<menu_item_name>__:
                 # (Optional): The icon for the menu item, which refers to a Backstage system icon
-                icon: fooIcon
+                icon: __<icon_name>__Icon
                 # (Optional): The display title of the menu item
-                title: Foo Plugin Page
+                title: __<plugin_name>__ Plugin Page
                 # (Optional): The order in which menu items appear. The default priority is `0`.
                 priority: 10
                 # (Optional): Defines the parent menu item to nest the current item under

modules/dynamic-plugins/proc-defining-dynamic-routes-for-new-plugin-pages.adoc

@@ -7,12 +7,12 @@
 . Define each route by specifying a unique `path` and, if needed, an `importName` if it is different from the `default` export.
 . Expose additional routes in a dynamic plugin by configuring `dynamicRoutes` as shown in the following example:
 +
-[source,yaml]
+[source,yaml,subs="+quotes"]
 +
 ----
 # dynamic-plugins-config.yaml
 plugins:
-  - plugin: <plugin_path_or_url>
+  - plugin: __<plugin_path_or_url>__
     disabled: false
     pluginConfig:
       dynamicPlugins:
@@ -24,11 +24,11 @@ plugins:
                 # (Optional): The set of assets to access within the plugin. If not specified, the system uses the `PluginRoot` module.
                 module: CustomModule
                 # (Optional): The component name as a standalone page. If not specified, the system uses the `default` export.
-                importName: FooPluginPage
+                importName: __<my-plugin>__PluginPage
                 # Allows you to extend the main sidebar navigation and point to a new route.
                 menuItem:
-                  icon: fooIcon
-                  text: Foo Plugin Page
+                  icon: # home | group | category | extension | school | _<my_icon>_
+                  text: __<my-plugin label>__ 
                   enabled: false
                 config: # (Optional): Passes `props` to a custom sidebar item
                   props: ...
@@ -51,11 +51,11 @@ export type MySidebarItemProps = {
 ----
 
 .Example specifying a custom `SidebarItem` component:
-[source,yaml]
+[source,yaml,subs="+quotes"]
 ----
 # dynamic-plugins-config.yaml
 plugins:
-  - plugin: <plugin_path_or_url>
+  - plugin: __<plugin_path_or_url>__
     disabled: false
     pluginConfig:
       dynamicPlugins:

modules/dynamic-plugins/proc-export-third-party-plugins-rhdh.adoc

@@ -89,8 +89,8 @@ You can add a `scalprum` section to the `package.json` file. For example:
 "scalprum": {
   "name": "custom-package-name",
   "exposedModules": {
-    "FooModuleName": "./src/foo.ts",
-    "BarModuleName": "./src/bar.ts"
+    "BazModuleName": "./src/baz.ts",
+    "QuxModuleName": "./src/qux.ts"
     // Define multiple modules here, with each exposed as a separate entry point in the Webpack container.
   }
 }

modules/dynamic-plugins/proc-extending-internal-icon-catalog.adoc

@@ -8,22 +8,22 @@ You can use the internal catalog to fetch icons for configured routes with sideb
 .Procedure
 * Add a custom icon to the internal icon catalog for use in the menu item of a plugin by using the `appIcons` configuration as shown in the following example:
 
-[source,yaml]
+[source,yaml,subs="+quotes"]
 ----
 # dynamic-plugins-config.yaml
 plugins:
-  - plugin: <plugin_path_or_url>
+  - plugin: __<plugin_path_or_url>__
     disabled: false
     pluginConfig:
       dynamicPlugins:
         frontend:
           my-plugin:  # The plugin package name
             appIcons:
-              - name: fooIcon # The icon catalog name
+              - name: __<catalogName>__ # The icon catalog name
                 # (Optional): The set of assets to access within the plugin. If not specified, the system uses the `PluginRoot` module.
                 module: CustomModule
                 # (Optional): The actual component name to be rendered as a standalone page. If not specified, the system uses the `default` export.
-                importName: FooIcon
+                importName: __<CustomIcon>__
 ----
 
 [NOTE]

modules/dynamic-plugins/ref-community-plugins-migration.template.adoc

@@ -4,8 +4,8 @@
 // This page is generated! Do not edit the .adoc file, but instead run rhdh-supported-plugins.sh to regen this page from the latest plugin metadata.
 
 :_mod-docs-content-type: REFERENCE
-[id="ref-community-plugins-migration_{context}"]
-= Community plugins migration to the GitHub Container Registry
+[id="ref-community-plugins-migration-template_{context}"]
+= Template for community plugins migration to the GitHub Container Registry
 
 [IMPORTANT]
 ====