docs: Adding 'Integrating with Kubernetes' user guide #2250

ibuziuk · 2022-03-28T11:39:53Z

What does this pull request change

Adding 'Integrating with Kubernetes' user guide

Adding automatic token injection section
Updating image in the navigation from OpenShift web console to Che
Adding a section for navigating from dashboard to OpenShift web console

The PR does not contain optional Managing workspaces via kubectl (optional) section that might be provided later on as a separate PR

What issues does this pull request fix or reference

eclipse-che/che#21300

Specify the version of the product this pull request applies to

for master branch

cherry-picking to the main branch is expected to be handled by the docs team

Pull request checklist

The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.

Any procedure:
- Successfully tested.
Any page or link rename:
- The page contains a redirection for the previous URL.
- Propagate the URL change in:
  - Dashboard default branding data
  - Chectl constants.ts
Builds on Eclipse Che hosted by Red Hat.
the Validate language on files added or modified step reports no vale warnings.

github-actions · 2022-03-28T11:40:05Z

Click here to review and test in web IDE:

themr0c · 2022-03-28T12:13:38Z

modules/end-user-guide/pages/navigating-openshift-web-console-from-che.adoc

+[id="navigating-openshift-web-console-from-{prod-id-short_{context}"]
+= Navigating OpenShift web console from {prod-short}
+
+This section describes how to access OpenShif web console from {prod-short}.


Suggested change

This section describes how to access OpenShif web console from {prod-short}.

This section describes how to access OpenShift web console from {prod-short}.

themr0c · 2022-03-28T12:42:55Z

modules/end-user-guide/pages/integrating-with-kubernetes.adoc

@@ -1,8 +1,9 @@
-:navtitle: Integrating with {orch-name}
+:navtitle: {orch-name} integrations


Keep the gerund in the title. It is part of our requirements.

ok, this was how the issue was titled see - eclipse-che/che#21300

themr0c · 2022-03-28T12:43:15Z

modules/end-user-guide/pages/integrating-with-kubernetes.adoc

 :keywords: overview, integrating with {orch-name}
 :page-aliases: 

 [id="integrating-with-kubernetes_{context}"]
-= Integrating with {orch-name}
+= {orch-name} integrations


Keep the gerund in the title. It is part of our requirements.

ok, this was how the issue was titled see - eclipse-che/che#21300

Integrating with Kubernetes vs Kubernetes integrations
those titles have different meanings and the current one is ambiguous imo

reverted back to Integrating with Kubernetes as per request

modules/end-user-guide/pages/navigating-openshift-web-console-from-che.adoc

modules/end-user-guide/pages/automatic-token-injection.adoc

modules/end-user-guide/pages/navigating-openshift-web-console-from-che.adoc

Eva-Lotte · 2022-03-31T11:49:13Z

modules/end-user-guide/pages/automatic-token-injection.adoc

+
+image::integration/token-injection.png[Token Injection in IDE,link="../_images/integration/token-injection.png"]
+
+WARNING: The automatic token injection functionality currently works only on the OpenShift infrastructure.


"function" is easier than "functionality" and provides the same content.

I decided to drop functionality wording since it is redundant

Eva-Lotte · 2022-03-31T11:50:32Z

modules/end-user-guide/pages/automatic-token-injection.adoc

+[id="automatic-token-injection_{context}"]
+= Automatic {orch-name} token injection
+
+This section describes how to use the {orch-name} user token that is automatically injected into workspace containers.


It would be cool if this sentence could provide information on what you can do with the user token.

fair point, will rework it

Eva-Lotte · 2022-03-31T11:51:21Z

modules/end-user-guide/pages/navigating-openshift-web-console-from-che.adoc

+[id="navigating-openshift-web-console-from-{prod-id-short_{context}"]
+= Navigating OpenShift web console from {prod-short}
+
+This section describes how to access OpenShift web console from {prod-short}.


The OS web console.

we do not use such contractions I believe - the official naming is OpenShift web console

I didn't mean to contract, I meant to add an article.

modules/end-user-guide/pages/automatic-token-injection.adoc

Eva-Lotte · 2022-03-31T12:17:18Z

modules/end-user-guide/pages/navigating-openshift-web-console-from-che.adoc

+[id="navigating-openshift-web-console-from-{prod-id-short_{context}"]
+= Navigating OpenShift web console from {prod-short}
+
+This section describes how to access OpenShift web console from {prod-short}.


I didn't mean to contract, I meant to add an article.

modules/end-user-guide/pages/navigating-openshift-web-console-from-che.adoc

Signed-off-by: Ilya Buziuk <ibuziuk@redhat.com>

che-bot added the status/code-review label Mar 28, 2022

themr0c reviewed Mar 28, 2022

View reviewed changes

modules/end-user-guide/pages/navigating-openshift-web-console-from-che.adoc Outdated Show resolved Hide resolved

ibuziuk force-pushed the che-21300 branch 6 times, most recently from ea3fd6a to dc6f567 Compare March 29, 2022 07:33

swatikarmarkar reviewed Mar 29, 2022

View reviewed changes

modules/end-user-guide/pages/automatic-token-injection.adoc Show resolved Hide resolved

swatikarmarkar reviewed Mar 29, 2022

View reviewed changes

modules/end-user-guide/pages/automatic-token-injection.adoc Outdated Show resolved Hide resolved

swatikarmarkar reviewed Mar 29, 2022

View reviewed changes

modules/end-user-guide/pages/automatic-token-injection.adoc Outdated Show resolved Hide resolved

swatikarmarkar reviewed Mar 29, 2022

View reviewed changes

modules/end-user-guide/pages/navigating-openshift-web-console-from-che.adoc Show resolved Hide resolved

swatikarmarkar reviewed Mar 29, 2022

View reviewed changes

modules/end-user-guide/pages/navigating-openshift-web-console-from-che.adoc Show resolved Hide resolved

ibuziuk force-pushed the che-21300 branch 2 times, most recently from 7f54516 to 714773a Compare March 29, 2022 09:49

ibuziuk marked this pull request as ready for review March 29, 2022 09:50

ibuziuk requested a review from rkratky as a code owner March 29, 2022 09:50

ibuziuk requested a review from l0rd March 29, 2022 10:09

ibuziuk mentioned this pull request Mar 29, 2022

che-docs v1 devfile fails to be automatically converted to v2 eclipse-che/che#21307

Closed

Eva-Lotte reviewed Mar 31, 2022

View reviewed changes

ibuziuk force-pushed the che-21300 branch from 080b562 to 34f96b6 Compare March 31, 2022 12:35

docs: Adding 'Integrating with Kubernetes' user guide

9f64d31

Signed-off-by: Ilya Buziuk <ibuziuk@redhat.com>

ibuziuk force-pushed the che-21300 branch from ef0c79c to 9f64d31 Compare March 31, 2022 12:37

Eva-Lotte approved these changes Mar 31, 2022

View reviewed changes

ibuziuk merged commit 81118eb into eclipse-che:master Mar 31, 2022

che-bot removed the status/code-review label Mar 31, 2022

themr0c added this to the 7.44 milestone Apr 1, 2022

ibuziuk mentioned this pull request Apr 6, 2022

User guide: update content for devworkspace, in the master branch eclipse-che/che#21285

Closed

13 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Adding 'Integrating with Kubernetes' user guide #2250

docs: Adding 'Integrating with Kubernetes' user guide #2250

ibuziuk commented Mar 28, 2022 •

edited

Loading

github-actions bot commented Mar 28, 2022

themr0c Mar 28, 2022

themr0c Mar 28, 2022 •

edited

Loading

ibuziuk Mar 28, 2022

themr0c Mar 28, 2022

ibuziuk Mar 28, 2022

ibuziuk Mar 28, 2022

ibuziuk Mar 28, 2022

Eva-Lotte Mar 31, 2022

ibuziuk Mar 31, 2022

Eva-Lotte Mar 31, 2022

ibuziuk Mar 31, 2022

Eva-Lotte Mar 31, 2022

ibuziuk Mar 31, 2022

Eva-Lotte Mar 31, 2022

Eva-Lotte Mar 31, 2022

	This section describes how to access OpenShif web console from {prod-short}.
	This section describes how to access OpenShift web console from {prod-short}.

		@@ -1,8 +1,9 @@
		:navtitle: Integrating with {orch-name}
		:navtitle: {orch-name} integrations

docs: Adding 'Integrating with Kubernetes' user guide #2250

docs: Adding 'Integrating with Kubernetes' user guide #2250

Conversation

ibuziuk commented Mar 28, 2022 • edited Loading

What does this pull request change

What issues does this pull request fix or reference

Specify the version of the product this pull request applies to

Pull request checklist

github-actions bot commented Mar 28, 2022

Choose a reason for hiding this comment

themr0c Mar 28, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ibuziuk commented Mar 28, 2022 •

edited

Loading

themr0c Mar 28, 2022 •

edited

Loading