Skip to content

Add end user restore documentation#3045

Open
dkwon17 wants to merge 17 commits intoeclipse-che:mainfrom
dkwon17:restore-docs
Open

Add end user restore documentation#3045
dkwon17 wants to merge 17 commits intoeclipse-che:mainfrom
dkwon17:restore-docs

Conversation

@dkwon17
Copy link
Contributor

@dkwon17 dkwon17 commented Mar 23, 2026

Assisted-by: gemini-2.5-pro

What does this pull request change?

Adds restore documentation for the dashboard.

The doc is available in the new Restoring a workspace from backup section in the end user guide.

image

What issues does this pull request fix or reference?

Documentation is for functionality added from these PRs:

Specify the version of the product this pull request applies to

DS 3.27

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:
  • Builds on Eclipse Che hosted by Red Hat.
  • the Validate language on files added or modified step reports no vale warnings.

Signed-off-by: David Kwon <dakwon@redhat.com>
Assisted-by: gemini-2.5-pro
@dkwon17 dkwon17 requested a review from l0rd March 23, 2026 22:01
@github-actions
Copy link

github-actions bot commented Mar 23, 2026

⚡️ Deploying pull request preview...

@github-actions
Copy link

github-actions bot commented Mar 23, 2026

Click here to review and test in web IDE: Contribute

[id="restoring-a-workspace-from-backup"]
= Restoring a workspace from backup

When backup is enabled for {devworkspace} instances on your cluster, workspace data can be captured when a workspace stops.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When backup is enabled for {devworkspace} instances on your cluster, workspace data can be captured when a workspace stops.
When backups are enabled for {devworkspace} instances on your cluster, the system captures workspace data when a workspace stops. You can start a new workspace from an existing backup by using the {prod-short} dashboard.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to:

When backups are enabled for {devworkspace} instances on your cluster, a cron job will backup workspace data for stopped workspaces.

@gtrivedi88
Copy link
Contributor

gtrivedi88 commented Mar 24, 2026

Hi @dkwon17 We have a concept module and two procedures module in here. As a results, based on mod docs guide lines we need 3 files.

  • con-workspace-backups.adoc[leveloffset=+1] - Please apply the suggestions and remove the procedures and if possible rename the file to reflect that it is a concept.
  • proc-viewing-backups-in-the-dashboard.adoc[leveloffset=+1] - Provided end-to-end content for this in comments
  • proc-restoring-a-workspace-from-backup.adoc[leveloffset=+1] - Provided end-to-end content for this in comments

Please let me know if you have questions.

….adoc

Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
*Internal* backups are backups the {prod-short} dashboard detects and lists.
On {ocp}, they are represented as `ImageStream` resources in your namespace.

*External* backups are backups from a registry not specified by the administrator when cofiguring cluster-wide backups.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

External backups can also be defined by the cluster administrator if not using the built-in registry. This sentence is a bit confusing.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My latest change updates it to the following:
image

This is referring to the Default registry (ie, choosing from dropdown, it works for both internal openshift registry and other registries like quay.io) and External registry (manually input container image) section in the UI:
image

Basically, External registry in the UI is not referring registries that are not the internal openshift registry, it's referring to any registry not defined in the DevWorkspaceOperatorConfig .

dkwon17 and others added 6 commits March 24, 2026 09:57
….adoc

Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
….adoc

Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
….adoc

Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
….adoc

Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
….adoc

Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
….adoc

Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
dkwon17 and others added 8 commits March 24, 2026 10:02
….adoc

Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
….adoc

Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
….adoc

Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
Signed-off-by: dkwon17 <dakwon@redhat.com>
Signed-off-by: dkwon17 <dakwon@redhat.com>
Signed-off-by: dkwon17 <dakwon@redhat.com>
Signed-off-by: dkwon17 <dakwon@redhat.com>
Signed-off-by: dkwon17 <dakwon@redhat.com>
….adoc

Co-authored-by: Rohan Kumar  <rohan.kumar.kanojia@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants