Skip to content

Commit

Permalink
sh tools/substitutions.sh (#1040)
Browse files Browse the repository at this point in the history
* sh tools/substitutions.sh

* Update src/main/pages/che-7/administration-guide/assembly_collecting-logs-using-chectl.adoc

Co-Authored-By: Robert Krátký <rkratky@redhat.com>

* Update src/main/pages/che-7/end-user-guide/ref_che-theia-plug-in-metadata.adoc

Co-Authored-By: Robert Krátký <rkratky@redhat.com>

* Update src/main/pages/che-7/end-user-guide/ref_che-theia-plug-in-metadata.adoc

Co-Authored-By: Robert Krátký <rkratky@redhat.com>

* Update src/main/pages/che-7/administration-guide/assembly_collecting-logs-using-chectl.adoc

Co-Authored-By: Robert Krátký <rkratky@redhat.com>

* Update src/main/pages/che-7/end-user-guide/ref_che-theia-plug-in-metadata.adoc

Co-Authored-By: Robert Krátký <rkratky@redhat.com>

* Che Plugin vs. {prod-short} plug-in - first disambiguation attempt

* Che Plugin vs. {prod-short} plug-in - more

Co-authored-by: Robert Krátký <rkratky@redhat.com>
  • Loading branch information
themr0c and Robert Krátký committed Jan 15, 2020
1 parent cdacd86 commit 4e6e388
Show file tree
Hide file tree
Showing 24 changed files with 52 additions and 80 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ ifdef::context[:parent-context-of-collecting-logs-using-chectl: {context}]
= Collecting logs using chectl


It is possible to get all Eclipse Che logs from k8s cluster using `chectl` tool
It is possible to get all {prod} logs from a Kubernetes cluster using the `chectl` tool.

- `chectl server:start` automatically starts collecting Eclipse Che servers logs during installation of Eclipse Che
- `chectl server:logs` collects existed Eclipse Che servers logs
- `chectl server:start` automatically starts collecting {prod} servers logs during installation of {prod}
- `chectl server:logs` collects existing {prod} server logs
- `chectl workspace:logs` collects running workspace logs
- `chectl workspace:logs --follow` starts collecting logs of all new workspaces

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ summary:

:context: customizing-the-devfile-and-plug-in-registries

{prod-short} {prod-ver} introduces two registries: the plug-in registry and the devfile registry. They are static websites where the metadata of {prod-short} plug-ins and {prod-short} devfiles is published.
{prod-short} {prod-ver} introduces two registries: the plug-ins registry and the devfile registry. They are static websites where the metadata of {prod-short} plug-ins and {prod-short} devfiles is published.

The plug-in registry makes it possible to share a plug-in definition across all the users of the same instance of {prod-short}. Only plug-ins that are published in a registry can be used in a devfile.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The following sections describe the installation methods for the Jaeger tracing

Installation methods available:

* xref:installing-the-jaeger-tracing-tool-for-che-on-openshift-4_installing-the-jaeger-tracing-tool[]
* xref:installing-the-jaeger-tracing-tool-for-{prod-id-short}-on-openshift-4_installing-the-jaeger-tracing-tool[]
* xref:installing-jaeger-using-operatorhub-on-openshift-4_installing-the-jaeger-tracing-tool[]
* xref:installing-jaeger-locally-using-a-pre-built-container-image_installing-the-jaeger-tracing-tool[]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This is a catalog of the location and instructions to retrieve application logs
* link:{site-baseurl}che-7/viewing-external-service-logs[Viewing external service logs]
* link:{site-baseurl}che-7/viewing-che-workspaces-logs[Viewing {prod-short} workspaces logs]
* link:{site-baseurl}che-7/viewing-plug-in-broker-logs[Viewing the plug-in broker logs]
* link:{site-baseurl}che-7/collecting-logs-using-chectl[Collecting Eclipse Che logs using chectl]
* link:{site-baseurl}che-7/collecting-logs-using-chectl[Collecting {prod} logs using chectl]

// TODO: include::proc_viewing-che-operator-logs.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ $ INDEX_JSON=$(curl -sSL http://$\{URL}/v3/plugins/index.json)
$ echo $\{INDEX_JSON} | grep -A 4 -B 5 "\"name\":\"my-plug-in\""
,\{
"id": "my-org/my-plug-in/1.0.0",
"displayName":"This is my first {prod-short} plug-in",
"displayName":"This is my first plug-in for {prod-short}",
"version":"1.0.0",
"type":"VS Code extension",
"name":"my-plug-in",
Expand All @@ -73,7 +73,7 @@ $ echo $\{INDEX_JSON} | grep -A 4 -B 5 "\"name\":\"my-plug-in\""
--
,\{
"id": "my-org/my-plug-in/latest",
"displayName":"This is my first {prod-short} plug-in",
"displayName":"This is my first plug-in for {prod-short}",
"version":"latest",
"type":"VS Code extension",
"name":"my-plug-in",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

.Prerequisites

* Installed Jaeger v1.12.0 or above. See instructions at xref:installing-the-jaeger-tracing-tool_tracing-che[]
* Installed Jaeger v1.12.0 or above. See instructions at xref:installing-the-jaeger-tracing-tool_tracing-{prod-id-short}[]

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To install the Jaeger tracing tool from the OperatorHub interface in {ocp}, foll
. Select the installation method: `A specific namespace on the cluster` where the {prod-short} is deployed and leave the rest in its default values.
. Click the *Subscribe* button.
. From the left menu of the main {ocp} screen, navigate to the *Operators → Installed Operators* section.
. Eclipse Che is displayed as an Installed Operator, as indicated by the *InstallSucceeded* status.
. {prod} is displayed as an Installed Operator, as indicated by the *InstallSucceeded* status.
. Click the *Jaeger Operator* name in the list of installed operators.
. Navigate to the *Overview* tab.
. In the Conditions sections at the bottom of the page, wait for this message: `install strategy completed with no errors`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
// installing-the-jaeger-tracing-tool

[id="installing-the-jaeger-tracing-tool-for-che-on-openshift-4_{context}"]
= Installing the Jaeger tracing tool for Che on OpenShift 4
[id="installing-the-jaeger-tracing-tool-for-{prod-id-short}-on-openshift-4_{context}"]
= Installing the Jaeger tracing tool for {prod-short} on OpenShift 4

To install the Jaeger tracing tool from a Che project in {ocp}, follow the instructions below.
To install the Jaeger tracing tool from a {prod-short} project in {ocp}, follow the instructions below.

.Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ image::extensibility/controlling-hosted-che-theia.png[]

== Using code completion

There is a full code completion provided to help you write your plug-in. Code completion covers both the Che-Theia plug-in API and the {prod-short} plug-in API.
There is a full code completion provided to help you write your plug-in. Code completion covers both the `Che Editor` plug-in API and the `Che Plugin` plug-in API.

.Code-completion example
[example]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This section describes how to test a customized Che-Theia by opening a new works

.Procedure

To test a custom Che-Theia image, create a new `meta.yaml` file describing a custom {prod-short} editor, and use it in a devfile for the testing workspace.
To test a custom Che-Theia image, create a new `meta.yaml` file describing a custom `cheEditor`, and use it in a devfile for the testing workspace.

. Download the latest Che-Theia `meta.yaml` from the link:https://github.com/eclipse/che-plugin-registry/tree/master/v3/plugins/eclipse/che-theia[plug-in registry]
. Replace the `image` value in the `containers` section to point to the custom Che-Theia container image.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

To add the VS Code extension using the *{prod-short} Plugins* panel:

. Open the *{prod-short} Plugin* panel.
. Open the *{prod-short} Plugins* panel.

. Change the current registry to the registry in which the VS Code extension was added.

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ spec:
----
<1> Version of the file structure.
<2> Name of the plug-in publisher. Must be the same as the publisher in the path.
<3> Plug-in name. Must be the same as in path.
<4> The {prod-short} plug-in version. Must be the same as in path.
<5> Type of the {prod-short} plug-in. For VS Code extensions, it must be `VS Code extension`.
<3> Name of the plug-in. Must be the same as in path.
<4> Version of the plug-in. Must be the same as in path.
<5> Type of the plug-in. Possible values: `Che Plugin`, `Che Editor`, `Theia plugin`, `VS Code extension`.
<6> A short name of the plug-in.
<7> Plug-in title.
<7> Title of the plug-in.
<8> A brief explanation of the plug-in and what it does.
<9> The link to the plug-in logo.
<10> Optional. The link to the source-code repository of the plug-in.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The link:https://github.com/eclipse/che-plugin-registry/tree/master/v3/plugins[c
.`spec` attributes
:===
`endpoints`: plugin endpoints
`containers`: sidecar containers for plugin. `Che Plugin` and `VS Code extension` supports only one container.
`containers`: sidecar containers for plug-in. `Che Plugin` and `VS Code extension` supports only one container.
`initContainers`: sidecar init containers for plugin
`workspaceEnv`: environment variables for the workspace.
`extensions`: For a VisualStudio Code Extension, list of U4`image`: URI of the container image
Expand Down Expand Up @@ -91,13 +91,13 @@ The link:https://github.com/eclipse/che-plugin-registry/tree/master/v3/plugins[c
:===


.Example `meta.yaml` for a Che-Theia plug-in: the Che machine-exec Service
.Example `meta.yaml` for a Che-Theia plug-in: the {prod-short} machine-exec Service
[source,yaml]
----
apiVersion: v2
category: Other
description: Che Plug-in with che-machine-exec service to provide creation terminal or tasks for Eclipse CHE workspace containers.
displayName: Che machine-exec Service
description: Che Plugin with che-machine-exec service to provide creation terminal or tasks for {prod} workspace containers.
displayName: {prod-short} machine-exec Service
firstPublicationDate: "2019-12-02"
icon: https://www.eclipse.org/che/images/logo-eclipseche.svg
name: che-machine-exec-plugin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Describes plug-ins in a workspace by defining their `id`. It is allowed to have
----

Both types above use an ID, which is slash-separated publisher, name and version of plug-in from the {prod-short} Plug-in registry. +
List of available {prod-short} plugins and more information about registry can be found in the link:https://github.com/eclipse/che-plugin-registry[{prod-short} plug-in registry] GitHub repository.
List of available {prod-short} plug-ins and more information about registry can be found in the link:https://github.com/eclipse/che-plugin-registry[{prod-short} plug-in registry] GitHub repository.

=== Specifying an alternative component registry

Expand Down Expand Up @@ -762,7 +762,7 @@ The example above opens `++http://__<server-domain>__/myweb++`, where `_<server-

By default, a notification is displayed to ask the user how the URL should be opened. To specify the preferred way of previewing a service URL, use preferences.

. Open {prod-short} preferences in *File -> Settings -> Open Preferences* and find `che.task.preview.notifications` in the *Che* section.
. Open {prod-short} preferences in *File -> Settings -> Open Preferences* and find `che.task.preview.notifications` in the *{prod-short}* section.

. Choose from the list of possible values:
+
Expand Down
4 changes: 2 additions & 2 deletions src/main/pages/che-7/extensions/che4z-installing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ video::O2kIFFDACE0[youtube]
. In a web browser, load the following URL: +
`++https://++__<CHE_HOST>__/f?url=https://github.com/eclipse/che-che4z/raw/1.0.0/mainframe-basic-stack.yaml`
+
* `++https://++__<CHE_HOST>__` specifies the Che Server URL, for example: `++https://++my-che-server.com`.
* `++https://++__<CHE_HOST>__` specifies the {prod-short} Server URL, for example: `++https://++my-che-server.com`.

* `/f?url=` links the Che Server URL to the Eclipse Che4z basic stack URL.
* `/f?url=` links the {prod-short} Server URL to the Eclipse Che4z basic stack URL.

* `++https://++github.com/eclipse/che-che4z/raw/1.0.0/mainframe-basic-stack.yaml` is the Eclipse Che4z basic stack URL.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ The images _essential_ to starting a workspace are infrastructure images that ar

| `docker.io/eclipse/che-unified-plugin-broker` +
`docker.io/eclipse/che-init-plugin-broker`
| Images for adding plug-ins to workspaces. See link:{site-baseurl}che-7/che-workspaces-architecture/#che-plug-in-broker_che-workspace-components[{prod-short} plug-in broker].
| Images for adding plug-ins to workspaces. See link:{site-baseurl}che-7/che-workspaces-architecture/#che-plug-in-broker_che-workspace-components[{prod-short} plug-ins broker].

| `quay.io/eclipse/che-plugin-registry` +
`quay.io/eclipse/che-devfile-registry`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ To limit the number of concurrently running workspaces per user to one (1):

== Allowing user-defined workspace namespaces

Che server can be configured to honor the user selection of a namespace when a workspace is created. This feature is
{prod-short} server can be configured to honor the user selection of a namespace when a workspace is created. This feature is
disabled by default. To allow user-defined workspace namespaces, set:

[subs="+quotes"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This section describes how to uninstall {prod-short} from a cluster using the Op

.Prerequsities

* Che was installed on an OpenShift cluster using OperatorHub.
* {prod-short} was installed on an OpenShift cluster using OperatorHub.

.Procedure: deleting the {prod-short} deployment

Expand All @@ -36,7 +36,7 @@ This section describes how to uninstall {prod-short} from a cluster using the Op
//+
//image::uninstall/che-uninstall-operator.png[link="{imagesdir}/uninstall/che-uninstall-operator.png"]
. Accept the selected option, *Also completely remove the Operator from the selected namespace*.
. Alternatively, uninstall the {prod} Operator by clicking the displayed {prod} Operator, `Eclipse Che`, followed by selecting the *Uninstall Operator* option in the *Actions* drop-down menu on the top right.
. Alternatively, uninstall the {prod} Operator by clicking the displayed {prod} Operator, `{prod}`, followed by selecting the *Uninstall Operator* option in the *Actions* drop-down menu on the top right.


== Uninstalling {prod-short} using `oc` commands
Expand Down
4 changes: 2 additions & 2 deletions src/main/pages/che-7/overview/con_che-editor-plug-in.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[id="{prod-id-short}-editor-plug-in_{context}"]
= {prod-short} editor plug-in
= `Che Editor` plug-in

A {prod-short} editor is a {prod-short} workspace plug-in.
A `Che Editor` plug-in is a {prod-short} workspace plug-in.
It defines the web application that is used as an editor in a workspace.
The default {prod-short} workspace editor is called Che-Theia.

Expand Down
8 changes: 4 additions & 4 deletions src/main/pages/che-7/overview/con_che-plug-in-broker.adoc
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
[id="{prod-id-short}-plug-in-broker_{context}"]
= {prod-short} plug-in broker
= {prod-short} plug-ins broker

Plug-in brokers are special services that, given a plug-in `meta.yaml` file:

* Gather all the information to provide a {prod-short} plug-in definition that the {prod-short} server knows.
* Gather all the information to provide a plug-in definition that the {prod-short} server knows.

* Perform preparation actions in the workspace namespace (download, unpack files, process configuration).

The main goal of the plug-in broker is to decouple the {prod-short} plug-in definition from the actual plug-ins that {prod-short} can support. With brokers, {prod-short} can support different plug-ins without updating the {prod-short} server.
The main goal of the plug-in broker is to decouple the {prod-short} plug-ins definitions from the actual plug-ins that {prod-short} can support. With brokers, {prod-short} can support different plug-ins without updating the {prod-short} server.

The {prod-short} server starts the plug-in broker. The plug-in broker runs in the same Kubernetes namespace as the workspace. It has access to the plug-ins and project persistent volumes.

A plug-in broker is defined as a container image (for example, `eclipse/che-plugin-broker`). The plug-in type determines the type of the broker that is started. Two types of plug-ins are supported: {prod-short} plug-in and {prod-short} editor.
A plug-ins broker is defined as a container image (for example, `eclipse/che-plugin-broker`). The plug-in type determines the type of the broker that is started. Two types of plug-ins are supported: `Che Plugin` and `Che Editor`.

[cols=2*]
|===
Expand Down
6 changes: 3 additions & 3 deletions src/main/pages/che-7/overview/con_che-plug-ins.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[id="{prod-id-short}-plug-ins_{context}"]
= {prod-short} plug-ins
= `Che Plugin` plug-ins

{prod-short} plug-ins are special services that extend {prod-short} workspace capabilities. {prod-short} plug-ins are packaged as containers. Packaging plug-ins into a container has the following benefits:
`Che Plugin` plug-ins are special services that extend {prod-short} workspace capabilities. `Che Plugin` plug-ins are packaged as containers. Packaging plug-ins into a container has the following benefits:

* It isolates the plug-ins from the main IDE, thus limiting the resources that a plug-in has access to.

Expand All @@ -11,4 +11,4 @@ The containers that plug-ins are packaged into run as sidecars of the {prod-shor

Visual Studio Code extensions packaged in containers are {prod-short} plug-ins for the Che-Theia editor.

Multiple {prod-short} plug-ins can run in the same container (for better resource use), or a {prod-short} plug-in can run in its dedicated container (for better isolation).
Multiple {prod-short} plug-ins can run in the same container (for better resource use), or a Che Plugin can run in its dedicated container (for better isolation).
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ The following is a {prod-short} workspace creation flow:

. *wsmaster* retrieves the editor and plug-in metadata from the plug-in registry.
. For every plug-in type, *wsmaster* starts a specific plug-in broker.
. The {prod-short} plug-in broker transforms the plug-in metadata into a {prod-short} plug-in definition. It executes the following steps:
. The {prod-short} plug-ins broker transforms the plug-in metadata into a Che Plugin definition. It executes the following steps:
+
.. Downloads a plug-in and extracts its content.
.. Processes the plug-in `meta.yaml` file and sends it back to *wsmaster* in the format of a {prod-short} plug-in.
.. Processes the plug-in `meta.yaml` file and sends it back to *wsmaster* in the format of a Che Plugin.

. *wsmaster* starts the editor and the plug-in sidecars.
. The editor loads the plug-ins from the plug-in persistent volume.
10 changes: 9 additions & 1 deletion tools/substitutions.sed
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,12 @@ s/{site-baseurl}{prod-id-short}-{prod-ver}/{site-baseurl}che-7/g

# Revert back Che-Theia
s/{prod-short}-Theia/Che-Theia/g
s/{prod-id-short}-theia/che-theia/g
s/{prod-id-short}-theia/che-theia/g

# Revert back {prod-short} plug-ins types: `type: Che Plugin` `Che Editor`
s/{prod-short} plug-in\b/Che Plugin/g
s/{prod-short} Plugin\b/Che Plugin/g
s/Che Plugin metadata/{prod-short} plug-in metadata/g
s/Che Plugin registry/{prod-short} plug-in registry/g
#s/metadata of Che Plugin/metadata of {prod-short} plug-in/g
s/{prod-short} Editor/Che Editor/g

0 comments on commit 4e6e388

Please sign in to comment.