docs: manage workspaces with kubectl #2510

dkwon17 · 2022-12-01T17:59:40Z

Signed-off-by: dkwon17 dakwon@redhat.com

Adds the steps for:

Listing all workspaces
Creating workspaces
Stopping workspaces
Starting stopped workspaces
Removing workspaces

The Restarting workpsaces section was removed, as it can be done by following the Stopping workspaces and then the Starting stopped workspaces sections

What does this pull request change?

What issues does this pull request fix or reference?

eclipse-che/che#21808

Specify the version of the product this pull request applies to

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.

Signed-off-by: dkwon17 <dakwon@redhat.com>

github-actions · 2022-12-01T17:59:54Z

Click here to review and test in web IDE:

github-actions · 2022-12-01T17:59:55Z

Click here to review and test in web IDE:

github-actions · 2022-12-01T17:59:55Z

🎊 Navigate the preview: https://63d4499186bbfd55660285c1--eclipse-che-docs-pr.netlify.app 🎊

modules/end-user-guide/pages/managing-workspaces-with-apis.adoc

Signed-off-by: dkwon17 <dakwon@redhat.com>

modules/end-user-guide/partials/proc_creating-workspaces.adoc

modules/end-user-guide/partials/proc_listing-workspaces.adoc

modules/end-user-guide/partials/proc_removing-workspaces.adoc

modules/end-user-guide/partials/proc_starting-stopped-workspaces.adoc

modules/end-user-guide/partials/proc_stopping-workspaces.adoc

modules/end-user-guide/partials/proc_starting-stopped-workspaces.adoc

modules/end-user-guide/partials/proc_removing-workspaces.adoc

l0rd

LGTM, great contribution @dkwon17 @max-cx

modules/end-user-guide/partials/proc_creating-workspaces.adoc

Signed-off-by: David Kwon <dakwon@redhat.com>

ibuziuk · 2023-02-01T17:16:08Z

@max-cx can we merge and resolve - eclipse-che/che#21808 ?

max-cx · 2023-02-03T12:32:05Z

@ibuziuk, yes, I'm merging and backporting it now. I had to get up to date with a few Slack conversations and confirm in #2510 (comment) that the URL was the same and correct for both docs.

* edits * move the page from admin to user guide * Update modules/end-user-guide/pages/managing-workspaces-with-apis.adoc * Update modules/end-user-guide/pages/managing-workspaces-with-apis.adoc * docs: manage workspaces with kubectl (#2510) * docs: manage workspaces with kubectl Signed-off-by: dkwon17 <dakwon@redhat.com> * Add more clarity to "Creating workspaces" section Signed-off-by: dkwon17 <dakwon@redhat.com> * first edit * first edit * edits * edits * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc Co-authored-by: Max Leonov <mleonov@redhat.com> * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc Co-authored-by: Max Leonov <mleonov@redhat.com> * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc Co-authored-by: Mario Loriedo <mario.loriedo@gmail.com> * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc Co-authored-by: Mario Loriedo <mario.loriedo@gmail.com> * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc Co-authored-by: Mario Loriedo <mario.loriedo@gmail.com> * Add new bullet points for benefits of using dashboard Signed-off-by: David Kwon <dakwon@redhat.com> * name to lowercase (otherwise the devworkspace cannot be created) Signed-off-by: David Kwon <dakwon@redhat.com> * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc Co-authored-by: Max Leonov <mleonov@redhat.com> * Make bullet concise Signed-off-by: David Kwon <dakwon@redhat.com> * Small rearranging Signed-off-by: David Kwon <dakwon@redhat.com> * Remove . Signed-off-by: David Kwon <dakwon@redhat.com> * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc Co-authored-by: Max Leonov <mleonov@redhat.com> * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc Co-authored-by: Max Leonov <mleonov@redhat.com> * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc Co-authored-by: Max Leonov <mleonov@redhat.com> * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc Co-authored-by: Angel Misevski <amisevsk@redhat.com> * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc Co-authored-by: Angel Misevski <amisevsk@redhat.com> * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc * PR feedback update Signed-off-by: David Kwon <dakwon@redhat.com> * Add tip about referencing using IDE devfile Signed-off-by: David Kwon <dakwon@redhat.com> * Add another tip Signed-off-by: David Kwon <dakwon@redhat.com> * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc Co-authored-by: Valeriy Svydenko <vsvydenk@redhat.com> * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc * Reference IDE using devfile url Signed-off-by: David Kwon <dakwon@redhat.com> * Remove DWT details Signed-off-by: David Kwon <dakwon@redhat.com> * Update modules/end-user-guide/partials/proc_listing-workspaces.adoc * Update modules/end-user-guide/partials/proc_listing-workspaces.adoc * Replace TIP content with a link to OCP docs * Update modules/end-user-guide/partials/proc_stopping-workspaces.adoc * Update modules/end-user-guide/partials/proc_stopping-workspaces.adoc * Update modules/end-user-guide/pages/managing-workspaces-with-apis.adoc * Replace TIP content with a link to OCP docs * Apply suggestions from code review * Update modules/end-user-guide/partials/proc_listing-workspaces.adoc * Replace TIP content with a link to OCP docs * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc Co-authored-by: Max Leonov <mleonov@redhat.com> * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc * Apply suggestions from code review * Apply suggestions from code review * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc * Update modules/end-user-guide/partials/proc_creating-workspaces.adoc * Remove /main from url path Signed-off-by: David Kwon <dakwon@redhat.com> --------- Signed-off-by: dkwon17 <dakwon@redhat.com> Signed-off-by: David Kwon <dakwon@redhat.com> Co-authored-by: Max Leonov <mleonov@redhat.com> Co-authored-by: Mario Loriedo <mario.loriedo@gmail.com> Co-authored-by: Angel Misevski <amisevsk@redhat.com> Co-authored-by: Valeriy Svydenko <vsvydenk@redhat.com> --------- Signed-off-by: dkwon17 <dakwon@redhat.com> Signed-off-by: David Kwon <dakwon@redhat.com> Co-authored-by: Fabrice Flore-Thébault <ffloreth@redhat.com> Co-authored-by: Nick Boldt <nickboldt@gmail.com> Co-authored-by: David Kwon <dakwon@redhat.com> Co-authored-by: Mario Loriedo <mario.loriedo@gmail.com> Co-authored-by: Angel Misevski <amisevsk@redhat.com> Co-authored-by: Valeriy Svydenko <vsvydenk@redhat.com>

docs: manage workspaces with kubectl

fe62b3f

Signed-off-by: dkwon17 <dakwon@redhat.com>

dkwon17 requested review from rkratky, themr0c, max-cx and a team as code owners December 1, 2022 17:59

dkwon17 requested review from azatsarynnyy and removed request for a team December 1, 2022 17:59

che-bot added this to Triage in Reviews Dec 1, 2022

che-bot added status/code-review target/branch labels Dec 1, 2022

dkwon17 commented Dec 1, 2022

View reviewed changes

modules/end-user-guide/pages/managing-workspaces-with-apis.adoc Show resolved Hide resolved

max-cx self-assigned this Dec 1, 2022

che-bot moved this from Triage to In progress in Reviews Dec 1, 2022

azatsarynnyy approved these changes Dec 6, 2022

View reviewed changes

Reviews automation moved this from In progress to Approved Dec 6, 2022

ibuziuk approved these changes Dec 13, 2022

View reviewed changes

ibuziuk mentioned this pull request Dec 13, 2022

[docs] Managing workspaces via kubectl eclipse-che/che#21808

Closed

7 tasks

Add more clarity to "Creating workspaces" section

d276149

Signed-off-by: dkwon17 <dakwon@redhat.com>

dkwon17 force-pushed the apiissues branch from b62480c to d276149 Compare January 3, 2023 22:53

ibuziuk mentioned this pull request Jan 10, 2023

Sprint 230 eclipse-che/che#21925

Closed

60 tasks

tolusha mentioned this pull request Jan 13, 2023

How to run customized che-theia eclipse-che/che#21934

Closed

max-cx mentioned this pull request Jan 17, 2023

procedures: List, create, start, stop, and remove one or more workspaces by using APIs #2487

Closed

6 tasks

max-cx added 4 commits January 19, 2023 10:30

first edit

388d8a8

first edit

4f002b7

edits

04918a7

edits

b7c07b4

max-cx mentioned this pull request Jan 19, 2023

docs: review and edits of PR #2510 docs: manage workspaces with kubectl dkwon17/che-docs#14

Merged

6 tasks

Update modules/end-user-guide/partials/proc_creating-workspaces.adoc

7e75ff8