Skip to content

Commit 58fa44a

Browse files
committed
RHIDP-5422: Add Create proc + additional changes
1 parent 4eb8820 commit 58fa44a

File tree

5 files changed

+11
-7
lines changed

5 files changed

+11
-7
lines changed

modules/techdocs/proc-techdocs-addon-create.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,14 @@
88

99
If your organization has documentation needs that are not met by the functions of existing TechDocs add-ons, developers can create a new add-on for your TechDocs plugin.
1010

11-
A TechDocs add-on is a react component that is imported from a front-end plugin. If you do not have an existing plugin for your TechDocs add-on, you can create a new plugin by configuring the default front-end plugin files in the `backstage/community-plugins` repository. After you create a new front-end plugin and a new TechDocs add-on, you can use the new plugin to import the new TechDocs add-on into your {product} instance.
11+
A TechDocs add-on is a React component that is imported from a front-end plugin. If you do not have an existing plugin that you can use to export your TechDocs add-on, you can create a new plugin by using `backstage-cli` to generate a default front-end plugin structure that you can customize.
1212

13-
The folder structure of a new plugin looks similar to the following example:
13+
The folder structure of a new plugin that can be used to import TechDocs add-ons into the TechDocs plugin looks similar to the following example:
1414
[source,json,subs="+attributes,+quotes"]
1515
----
1616
_<new_plugin_for_techdocs_add-on>_/
1717
dev/
1818
index.ts
19-
node_modules/
2019
src/
2120
components/
2221
_<new_techdocs_add-on_component>_/
@@ -42,7 +41,7 @@ _<new_plugin_for_techdocs_add-on>_/
4241
* Docker v3.2.0 or later or Podman v3.2.0 or later is installed and running.
4342
4443
.Procedure
45-
. In the terminal, navigate to the root folder of your {product} instance.
44+
. In the terminal, navigate to the root folder of the repository where you want to create your new plugin.
4645
. To create a new front-end plugin, run the following command:
4746
+
4847
[source,terminal,subs="+attributes,+quotes"]

modules/techdocs/proc-techdocs-addon-install-helm.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88

99
You can use the {product} Helm chart to install a TechDocs add-on on your {product} instance as a dynamic plugin.
1010

11+
.Prerequisites
12+
* The TechDocs plugin is installed and enabled.
13+
1114
.Procedure
1215
. In your Helm chart, add the `global.dynamic` parameters required to install a dynamic plugin, as shown in link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_and_viewing_plugins_in_red_hat_developer_hub/rhdh-installing-rhdh-plugins_title-plugins-rhdh-about#con-install-dynamic-plugin-helm_rhdh-installing-rhdh-plugins[Installing dynamic plugins using the Helm chart ]
1316
+

modules/techdocs/proc-techdocs-addon-install-operator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You can use the {product} Operator to install a TechDocs add-on on your {product
1010

1111
.Prerequisites
1212
* An administrator has installed the {product} Operator.
13-
* You have installed the TechDocs plugin.
13+
* The TechDocs plugin is installed and enabled.
1414
1515
.Procedure
1616

modules/techdocs/proc-techdocs-addon-install-third-party.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ You can install compatible third-party TechDocs add-on on your {product} instanc
1010

1111
.Prerequisites
1212
* The third-party TechDocs add-on has a valid `package.json` file in its root directory, containing all required metadata and dependencies.
13-
* You have installed the @janus-idp/cli package.
13+
* The third-party plugin is packaged as a dynamic plugin in an OCI image. For alternative package types, see link:https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/release-1.5/plugins-rhdh-install/#assembly-install-third-party-plugins-rhdh[Installing third-party plugins in Red Hat Developer Hub].
1414
* You have installed the `yarn` package manager.
15-
* You have installed and configured Node.js and NPM.
15+
* The third-party plugin is packaged as a dynamic plugin in an OCI image.* You have installed and configured Node.js and NPM.
1616
1717
.Procedure
1818
. Install the third-party plugin that you want to use to import your third-party add-on by entering the following command:

titles/techdocs/master.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,5 @@ include::assemblies/assembly-techdocs-addons-installing.adoc[leveloffset=+2]
1818
include::assemblies/assembly-techdocs-addons-removing.adoc[leveloffset=+2]
1919

2020
include::assemblies/assembly-techdocs-addons-using.adoc[leveloffset=+2]
21+
22+
include::modules/techdocs/proc-techdocs-addon-create.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)