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

GUI for confiugration/help setting up webviz configuration file #504

Closed
anders-kiaer opened this issue Sep 15, 2021 · 3 comments
Closed
Assignees
Labels
enhancement 🚀 New feature or request epic

Comments

@anders-kiaer
Copy link
Collaborator

anders-kiaer commented Sep 15, 2021

A web GUI for help setting up (or modify existing) webviz-config configuration files would be useful.

  • We already have JSON schema that can be used...
  • ...so maybe https://github.com/rjsf-team/react-jsonschema-form can give a good starting point?
  • First iteration scope: Simply help setting up the configuration file, and show e.g. what the resulting menu/overall layout will be, and for the plugins themselves you only show some styled placeholder divs (with e.g. plugin title).

We might want to do #357 first (especially @typing.overload there will provide useful information to the generated json schema, which will be valuable input to the GUI tool).

@anders-kiaer anders-kiaer added enhancement 🚀 New feature or request epic labels Sep 15, 2021
@anders-kiaer
Copy link
Collaborator Author

anders-kiaer commented Sep 15, 2021

To start the editor, we could perhaps see something like webviz config [existing-file-if-the-user-has.yaml], which opens a non-Dash based localhost server with the GUI editor? (webviz docs is an example of non-Dash based localhost server, in that case purely based on https://docsify.js.org/#/ + static server).

@anders-kiaer
Copy link
Collaborator Author

anders-kiaer commented Sep 15, 2021

@rubenthoms also had a good idea/possibility: we might be able to reuse the web preview part of the GUI as a VS code extension as well (a random example of file-to-live-preview: https://marketplace.visualstudio.com/items?itemName=auchenberg.vscode-browser-preview)

@rubenthoms
Copy link
Collaborator

rubenthoms commented Mar 1, 2022

We implemented the first version of an editor which meets the above-mentioned requirements. The repo of the webviz-config-editor can be found here: github.com/equinor/webviz-config-editor. Further requirements should be posted directly in the respective repo. Hence, I am closing this issue. Any objections, @anders-kiaer?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement 🚀 New feature or request epic
Projects
Archived in project
Development

No branches or pull requests

2 participants