1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

OSDOCS-4815: Updating 'plug-in' to 'plugin'

This commit is contained in:
Andrea Hoffer
2023-01-16 16:03:42 -05:00
committed by openshift-cherrypick-robot
parent eab99c748e
commit c7fcfb17d8
342 changed files with 862 additions and 869 deletions

View File

@@ -1,16 +1,15 @@
:_content-type: ASSEMBLY
[id="deploy-plug-in-cluster_{context}"]
= Deploy your plug-in on a cluster
= Deploy your plugin on a cluster
include::_attributes/common-attributes.adoc[]
:context: deploy-plug-in-cluster
toc::[]
You can deploy the plug-in to a {product-title} cluster.
You can deploy the plugin to a {product-title} cluster.
include::modules/build-image-docker.adoc[leveloffset=+1]
include::modules/deployment-plug-in-cluster.adoc[leveloffset=+1]
include::modules/disabling-plug-in-browser.adoc[leveloffset=+1]

View File

@@ -1,11 +1,11 @@
:_content-type: ASSEMBLY
[id="dynamic-plugin-example_{context}"]
= Dynamic plug-in example
= Dynamic plugin example
include::_attributes/common-attributes.adoc[]
:context: dynamic-plug-in-example
toc::[]
Before working through the example, verify that the plug-in is working by following the steps in xref:../../web_console/dynamic-plug-in/dynamic-plug-ins-get-started.adoc#dynamic-plugin-development_dynamic-plug-ins-get-started[Dynamic plug-in development]
Before working through the example, verify that the plugin is working by following the steps in xref:../../web_console/dynamic-plug-in/dynamic-plug-ins-get-started.adoc#dynamic-plugin-development_dynamic-plug-ins-get-started[Dynamic plugin development]
include::modules/adding-tab-pods-page.adoc[leveloffset=+1]

View File

@@ -1,20 +1,20 @@
:_content-type: ASSEMBLY
[id="overview-of-dynamic-plug-ins_{context}"]
= Overview of dynamic plug-ins
= Overview of dynamic plugins
include::_attributes/common-attributes.adoc[]
:context: overview-of-dynamic-plug-ins
toc::[]
[id="dynamic-plug-in-overview"]
== About dynamic plug-ins
== About dynamic plugins
A dynamic plug-in allows you to add custom pages and other extensions to your interface at runtime. The `ConsolePlugin` custom resource registers plug-ins with the console, and a cluster administrator enables plug-ins in the `console-operator` configuration.
A dynamic plugin allows you to add custom pages and other extensions to your interface at runtime. The `ConsolePlugin` custom resource registers plugins with the console, and a cluster administrator enables plugins in the `console-operator` configuration.
[id="dynamic-plugins-features"]
== Key features
A dynamic plug-in allows you to make the following customizations to the {product-title} experience:
A dynamic plugin allows you to make the following customizations to the {product-title} experience:
* Add custom pages.
* Add perspectives beyond administrator and developer.
@@ -23,12 +23,12 @@ A dynamic plug-in allows you to make the following customizations to the {produc
[id="general-plug-in-guidelines"]
== General guidelines
When creating your plug-in, follow these general guidelines:
When creating your plugin, follow these general guidelines:
* link:https://nodejs.org/en/[`Node.js`] and link:https://yarnpkg.com/[`yarn`] are required to build and run your plug-in.
* Prefix your CSS class names with your plug-in name to avoid collisions. For example, `my-plugin_\_heading` and `my-plugin_\_icon`.
* link:https://nodejs.org/en/[`Node.js`] and link:https://yarnpkg.com/[`yarn`] are required to build and run your plugin.
* Prefix your CSS class names with your plugin name to avoid collisions. For example, `my-plugin_\_heading` and `my-plugin_\_icon`.
* Maintain a consistent look, feel, and behavior with other console pages.
* Follow link:https://www.i18next.com/[react-i18next] localization guidelines when creating your plug-in. You can use the `useTranslation` hook like the one in the following example:
* Follow link:https://www.i18next.com/[react-i18next] localization guidelines when creating your plugin. You can use the `useTranslation` hook like the one in the following example:
+
[source,ymal]
----
@@ -38,12 +38,12 @@ conster Header: React.FC = () => {
};
----
* Avoid selectors that could affect markup outside of your plug-ins components, such as element selectors. These are not APIs and are subject to change. Using them might break your plug-in. Avoid selectors like element selectors that could affect markup outside of your plug-ins components.
* Avoid selectors that could affect markup outside of your plugins components, such as element selectors. These are not APIs and are subject to change. Using them might break your plugin. Avoid selectors like element selectors that could affect markup outside of your plugins components.
[discrete]
== PatternFly 4 guidelines
When creating your plug-in, follow these guidelines for using PatternFly:
When creating your plugin, follow these guidelines for using PatternFly:
* Use link:https://www.patternfly.org/v4/[PatternFly4] components and PatternFly CSS variables. Core PatternFly components are available through the SDK. Using PatternFly components and variables help your plug-in look consistent in future console versions.
* Make your plug-in accessible by following link:https://www.patternfly.org/v4/accessibility/accessibility-fundamentals/[PatternFly's accessibility fundamentals].
* Avoid using other CSS libraries such as Bootstrap or Tailwind. They can conflict with PatternFly and will not match the console look and feel.
* Use link:https://www.patternfly.org/v4/[PatternFly4] components and PatternFly CSS variables. Core PatternFly components are available through the SDK. Using PatternFly components and variables help your plugin look consistent in future console versions.
* Make your plugin accessible by following link:https://www.patternfly.org/v4/accessibility/accessibility-fundamentals/[PatternFly's accessibility fundamentals].
* Avoid using other CSS libraries such as Bootstrap or Tailwind. They can conflict with PatternFly and will not match the console look and feel.

View File

@@ -1,11 +1,11 @@
:_content-type: ASSEMBLY
[id="getting-started-with-dynamic-plugins_{context}"]
= Getting started with dynamic plug-ins
= Getting started with dynamic plugins
include::_attributes/common-attributes.adoc[]
:context: dynamic-plug-ins-get-started
toc::[]
To get started using the dynamic plug-in, you must set up your environment to write a new {product-title} dynamic plug-in. For an example of how to write a new plug-in, see xref:../../web_console/dynamic-plug-in/dynamic-plug-in-example.html#adding-tab-to-pods-page_dynamic-plug-in-example[Adding a tab to the pods page].
To get started using the dynamic plugin, you must set up your environment to write a new {product-title} dynamic plugin. For an example of how to write a new plugin, see xref:../../web_console/dynamic-plug-in/dynamic-plug-in-example.html#adding-tab-to-pods-page_dynamic-plug-in-example[Adding a tab to the pods page].
include::modules/dynamic-plug-in-development.adoc[leveloffset=+1]

View File

@@ -1,12 +1,12 @@
:_content-type: ASSEMBLY
[id="dynamic-plugins-reference_{context}"]
= Dynamic plug-in reference
= Dynamic plugin reference
include::_attributes/common-attributes.adoc[]
:context: dynamic-plug-ins-reference
toc::[]
You can add extensions that allow you to customize your plug-in. Those extensions are then loaded to the console at run-time.
You can add extensions that allow you to customize your plugin. Those extensions are then loaded to the console at run-time.
include::modules/dynamic-plug-in-sdk-extensions.adoc[leveloffset=+1]
@@ -16,4 +16,4 @@ include::modules/troubleshooting-dynamic-plug-in.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
xref:../../security/certificates/service-serving-certificate.adoc#understanding-service-serving_service-serving-certificate[Understanding service serving certificates]
xref:../../security/certificates/service-serving-certificate.adoc#understanding-service-serving_service-serving-certificate[Understanding service serving certificates]