Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an IDE-only workspace sample in the Dashboard getting started (without project) #21554

Closed
ibuziuk opened this issue Jul 18, 2022 · 9 comments · Fixed by eclipse-che/che-dashboard#602
Assignees
Labels
area/dashboard area/ux Issues related to User Experience Design kind/task Internal things, technical debt, and to-do tasks to be performed. new&noteworthy For new and/or noteworthy issues that deserve a blog post, new docs, or emphasis in release notes severity/P1 Has a major impact to usage or development of the system. status/analyzing An issue has been proposed and it is currently being analyzed for effort and implementation approach
Milestone

Comments

@ibuziuk
Copy link
Member

ibuziuk commented Jul 18, 2022

Is your task related to a problem? Please describe

Currently from the UD, it is not possible to start an empty workspace. This story should target the following flow:

  • As a user, I create an empty workspace from the dashboard UI
  • Workspace is empty and I can clone any repository from the terminal
  • Once the workspace is cloned I can generate a minimal devfile using the dedicated command e.g. "Generate Devfile"
  • As I work on the project from the workspace I can update devfile accordingly, e.g. add extra commands and push it to the remote
  • Once the changes are pushed I can share the repository with another user that would be able to replicate the same development environment

Describe the solution you'd like

There should be a dedicated "Blank / Empty / Scratch" devfile or a button "Start from scratch" / "Empty workspace" that would:

  1. Create a workspace without any project based on the UDI image
  2. Had the command for generating a minimal devfile v2 using the "Generate Devfile" command

Release Notes Text

A new example has been added in the Getting Started section of Eclipse Che Dashboard that allows users to start the IDE without any source code project. Git repositories can be opened from the IDE once the workspace is started.

@ibuziuk ibuziuk added kind/task Internal things, technical debt, and to-do tasks to be performed. status/analyzing An issue has been proposed and it is currently being analyzed for effort and implementation approach area/dashboard area/ux Issues related to User Experience Design labels Jul 18, 2022
@ibuziuk ibuziuk mentioned this issue Jul 18, 2022
51 tasks
@l0rd l0rd added the severity/P1 Has a major impact to usage or development of the system. label Jul 19, 2022
@l0rd
Copy link
Contributor

l0rd commented Jul 22, 2022

Starting from scratch could also be a good first use case for a chrome/firefox extension.

@olexii4 olexii4 self-assigned this Jul 25, 2022
@ibuziuk ibuziuk changed the title As a user I want to have a posibility to start from scratch / create an empty workspace As a user I want to have a possibility to start from scratch / create an empty workspace Jul 26, 2022
@ibuziuk
Copy link
Member Author

ibuziuk commented Jul 28, 2022

@l0rd wdyt if we simply contribute a new empty / scratch devfile to the registry (both che and devfile.io for future) with the following content:

schemaVersion: 2.2.0
metadata:
  generateName: scratch

On the dashboard level we will always display it as the very first one on the Getting Started

@l0rd
Copy link
Contributor

l0rd commented Jul 28, 2022

We can do that but that would not be in che-samples right? Because today all samples in the devfile registry come from the devfiles.yaml in the che-samples organization repositories. For this special case I think it makes sense to have the definition in the dashboard or in the devfile registry repositories. And I would not call it scratch but rather playground or empty workspace

@ibuziuk
Copy link
Member Author

ibuziuk commented Aug 1, 2022

We can do that but that would not be in che-samples right?

@svor do you happen to know if we can reference the raw definition of the devfile v2 from the registry e.g.

---
displayName: Empty Workspace
description: Empty Workspace
tags: ["Community", "Empty"]
icon: /images/empty.svg
links:
  v2: /devfiles/empty.yaml

in general, we would really like to avoid embedding the devfile in dashboard as much as possible.

Another idea would be contributing the empty devfile to https://registry.devfile.io/viewer and storing it there. From the dashboard side, we would just get it by name from the devfile.io registry and display it in the first place on "Getting Started". This could be also treated as the first step of switching to devfile.io registry

@l0rd
Copy link
Contributor

l0rd commented Aug 2, 2022

I would prefer to embed it in the Dashboard to be honest. I don't think that the empty workspace should be managed as a sample. Adding it in the devfile registry is a shortcut that I am afraid will introduce new technical debt as that's an "exceptional" sample. Moreover there is no such a devfile in the devfile.io registry and we need to have a discussion with devfile services, openshift console and odo teams about the value of an empty stack/sample.

@ibuziuk
Copy link
Member Author

ibuziuk commented Aug 2, 2022

I would prefer to embed it in the Dashboard to be honest.

Ok, let's proceed that way for now and embed it in Dashboard

Moreover there is no such a devfile in the devfile.io registry and we need to have a discussion with devfile services, openshift console, and odo teams about the value of an empty stack/sample.

I opened the PR to start this discussion devfile/registry#118

@ibuziuk ibuziuk mentioned this issue Aug 9, 2022
67 tasks
@l0rd l0rd added this to the 7.53 milestone Sep 1, 2022
@l0rd l0rd added new&noteworthy For new and/or noteworthy issues that deserve a blog post, new docs, or emphasis in release notes status/release-notes-review-needed Issues that needs to be reviewed by the doc team for the Release Notes wording labels Sep 1, 2022
@l0rd l0rd changed the title As a user I want to have a possibility to start from scratch / create an empty workspace Add an IDE-only workspace sample in the Dashboard getting started (without project) Sep 1, 2022
@max-cx
Copy link

max-cx commented Dec 16, 2022

Sync'd with Red Hat JIRA https://issues.redhat.com/browse/CRW-3627

@max-cx max-cx removed the status/release-notes-review-needed Issues that needs to be reviewed by the doc team for the Release Notes wording label Jan 12, 2023
@devstudio-release
Copy link

sync'd to Red Hat JIRA https://issues.redhat.com/browse/CRW-3857

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/dashboard area/ux Issues related to User Experience Design kind/task Internal things, technical debt, and to-do tasks to be performed. new&noteworthy For new and/or noteworthy issues that deserve a blog post, new docs, or emphasis in release notes severity/P1 Has a major impact to usage or development of the system. status/analyzing An issue has been proposed and it is currently being analyzed for effort and implementation approach
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants