Bug #7607
closed
[Workbench] "Getting Started" popup is only appropriate for the public beta
Added by Brett Smith over 9 years ago.
Updated about 9 years ago.
Assigned To:
Radhika Chippada
Description
Problem¶
The text in the "Getting Started" popup more or less assumes you're viewing the public beta's Workbench.
- The whole general flow—getting you started by running a pipeline, and the illustrations provided in the GIFs—only makes sense if you have a Workbench that already has data on it. If you're starting from scratch, with no collections or pipelines, it's less useful as a starting point.
- The discussion of login assumes you're logging in with a Google account. This may not be true on other deployments.
- Page 2 refers to pipelines and data that may only exist on the public beta. They definitely won't exist on a new install.
- Page 3 assumes that the cluster has public pipelines you may want to learn more about.
Fix¶
Add a configuration flag enable_getting_started_popup
, default false. Only show the Getting Started popup when the setting is true.
- Description updated (diff)
- Description updated (diff)
- Story points set to 0.5
- Target version set to Arvados Future Sprints
- Status changed from New to In Progress
- Assigned To set to Nancy Ouyang
I am working on this with Radhika's help.
- Status changed from In Progress to New
I couldn't get the Workbench tests to run*, so I was not able to write tests for my code. I pushed the two or three lines of logic I added to branch 7607-getting-started-flag in case it's of use.
- Kept running into:
[keepproxy] 2015/12/11 13:28:17 Error setting up arvados client Missing required environment variable ARVADOS_API_HOST
Sorry I couldn't wrap up this ticket, and thanks to Radhika for getting me as far into running the tests as I got!
- Status changed from New to In Progress
- Assigned To changed from Nancy Ouyang to Radhika Chippada
Nancy's commit at dfbdc1ba1ae2d41aec76f6bd7a7afe538419a3f9 is good. The Getting started popup is shown on first access of workbench and the menu option is included in Help menu only when enabled. The integration tests are failing and need to be updated, and additional tests need to be added.
Branch 7607-getting-started-flag ready for review. This includes:
- Nancy's original code updates, where a config param is added to enable the getting started popup
- Added / updated workbench tests to meet the new default behavior.
- application_layout_test updates
- The previous tests are updated to not expect the getting started popup (with the default config of disabled)
- Added a new test with config enabled and expect the popup. Also added a new user with profile but no getting_started_shown property to test both flavors (user has seen it before + not yet seen)
- I also noticed that I had three different sets of tests doing check_help_menu, verify_homepage, verify_system_menu. These checks did not need separate tests doing the whole page loading all over. I consolidated these into a single test set and brought down the test run time from 90s to 60s.
7607-getting-started-flag LGTM
- Target version changed from Arvados Future Sprints to 2016-01-06 sprint
- Status changed from In Progress to Resolved
Applied in changeset arvados|commit:e1276d6ebfbf073b747825cfcbfdd0054b95efa4.
Also available in: Atom
PDF