osm icon indicating copy to clipboard operation
osm copied to clipboard

Make manual bookstore demo terminal friendly without needing UI navigation

Open shashankram opened this issue 1 year ago • 5 comments

Please describe the Improvement and/or Feature Request Currently, the manual bookstore demo documented in the getting started guide requires a bunch of additional scripts (port-forward, tail, etc.) and UI navigation with multiple windows to understand the demo.

This issue proposes to make the manual bookstore demo purely an experience that can be visualized on the terminal without needing to run several scripts and UI navigation. It's also inconvenient for users to checkout the osm repo and run these scripts, so replacing these scripts with individual commands would render a better user experience.

This will reduce the maintenance burden that comes from having scripts specifically targeting the manual demo experience and UI rendering on the browser.

Scope (please mark with X where applicable)

  • Demo [X]

Possible use cases

Make the manual demo a purely terminal experience.

shashankram avatar Jul 18 '22 16:07 shashankram

Added default label size/needed. Please consider re-labeling this issue appropriately.

github-actions[bot] avatar Jul 27 '22 00:07 github-actions[bot]

Added default label kind/needed. Please consider re-labeling this issue appropriately.

github-actions[bot] avatar Jul 27 '22 00:07 github-actions[bot]

I thought about re-architecting the demo app down to a single view to show all the activity. I'm thinking we should decouple it from the build as well as a separate project. Thoughts?

phillipgibson avatar Aug 02 '22 13:08 phillipgibson

I thought about re-architecting the demo app down to a single view to show all the activity. I'm thinking we should decouple it from the build as well as a separate project. Thoughts?

Currently, it's a hassle to maintain the demo specific scripts such as the port-forwarding ones. I'd rather we drop the UI from the demo and make it a purely terminal experience so that the documented demo is testable on the CI as well.

I didn't get the part about decoupling it from the main repo. Could you share the motivation for that?

shashankram avatar Aug 02 '22 15:08 shashankram

I'd rather we drop the UI from the demo and make it a purely terminal experience so that the documented demo is testable on the CI as well.

+1 from me

keithmattix avatar Sep 07 '22 19:09 keithmattix

This issue will be closed due to a long period of inactivity. If you would like this issue to remain open then please comment or update.

github-actions[bot] avatar Jan 10 '23 00:01 github-actions[bot]

Issue closed due to inactivity.

github-actions[bot] avatar Jan 18 '23 00:01 github-actions[bot]