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

[Epic/ODO-93] Integrate devfile.odo.dev website into odo #6895

Closed
19 tasks done
rm3l opened this issue Jun 15, 2023 · 4 comments
Closed
19 tasks done

[Epic/ODO-93] Integrate devfile.odo.dev website into odo #6895

rm3l opened this issue Jun 15, 2023 · 4 comments
Labels
area/Dev-UI Issues or PRs related to the odo dev Web UI, a.k.a Devfile Builder estimated-size/L (20-40) Rough sizing for Epics. About 2 sprints of work for a person. kind/epic An issue categorized as a high-level Epic. Needs to be scoped and broken down in 1+ stories/tasks
Milestone

Comments

@rm3l
Copy link
Member

rm3l commented Jun 15, 2023

/kind epic

Copied from ODO-93

Problem statement

One of the biggest challenges for users is devfile customization to fit their project. 

Solution

We need to make customizing devfiles simpler, ideally to the point that users don’t have to deal with or understand devfiles.

We could try to create a Web UI that will abstract devfile structure to a better digestible form. This new form doesn’t have to; in fact, it should not resemble the devfile file structure.  


User Story

As an odo user, I want a better and simpler way to visualize and edit my local Devfile, So that I don't struggle with manually tailoring the Devfile to my project needs.

Acceptance Criteria

  • It should expose a Web UI integrated with odo dev and connected to the local Devfile for visualization and editing
  • It should not be hidden in experimental mode
  • API/web server should by started by default in odo dev
  • The output of the odo dev should show on which host an port the web interface and API is served

Links

  • ODO-93

Sub-stories / tasks

Enhancements

Bugs

/kind user-story

@openshift-ci openshift-ci bot added kind/epic An issue categorized as a high-level Epic. Needs to be scoped and broken down in 1+ stories/tasks kind/user-story An issue of user-story kind labels Jun 15, 2023
@github-actions github-actions bot added the needs-triage Indicates an issue or PR lacks a `triage/*` and requires one. label Jun 15, 2023
@rm3l rm3l added triage/needs-information Indicates an issue needs more information in order to work on it. and removed kind/user-story An issue of user-story kind needs-triage Indicates an issue or PR lacks a `triage/*` and requires one. labels Jun 15, 2023
@rm3l
Copy link
Member Author

rm3l commented Jun 15, 2023

Grooming (2023-06-15)

  • Integrate @feloy's POC in odo: https://devfile.odo.dev/
  • Integrate telemetry into that as well (enabled only if odo telemetry is enabled)
    • Current POC is a single page application => track what info people are modifying
  • Website should use the API we are developing
  • 1 website per dev session; so 2 dev sessions for the same component on different platforms might modify the same devfile. Look for a way to propagate changes.
  • Experimental mode
  • Work on raw Devfile
  • Make it clear that parent is not fully supported yet.

Actions / Issues to create

For the future

  • Vision: This web UI will serve as the console of odo dev (logs, controls to trigger sync, ...)
  • Living chart with the current state

@rm3l
Copy link
Member Author

rm3l commented Jun 15, 2023

/remove-triage needs-information

Issue groomed and broken down into smaller issues that we will consider sizing later.

@openshift-ci openshift-ci bot added needs-triage Indicates an issue or PR lacks a `triage/*` and requires one. and removed triage/needs-information Indicates an issue needs more information in order to work on it. labels Jun 15, 2023
@rm3l rm3l removed the needs-triage Indicates an issue or PR lacks a `triage/*` and requires one. label Jun 15, 2023
@jasperchui jasperchui added 2023Q3 and removed 2023Q3 labels Jun 26, 2023
@rm3l
Copy link
Member Author

rm3l commented Jul 11, 2023

@kadel Per your recent update on this issue, I've created a specific task to track the last 3 acceptance criteria (to move the UI and API out of the experimental mode): #6963

@rm3l rm3l changed the title [Epic/ODO-93] Simplifying devfile customization [Epic/ODO-93] Integrate devfile.odo.dev website into odo Jul 11, 2023
@rm3l rm3l added the area/Dev-UI Issues or PRs related to the odo dev Web UI, a.k.a Devfile Builder label Aug 4, 2023
@feloy
Copy link
Contributor

feloy commented Sep 5, 2023

All issues have been done

@feloy feloy closed this as completed Sep 5, 2023
@rm3l rm3l added this to the v3.15.0 🚀 milestone Sep 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/Dev-UI Issues or PRs related to the odo dev Web UI, a.k.a Devfile Builder estimated-size/L (20-40) Rough sizing for Epics. About 2 sprints of work for a person. kind/epic An issue categorized as a high-level Epic. Needs to be scoped and broken down in 1+ stories/tasks
Projects
Archived in project
Development

No branches or pull requests

3 participants