Page MenuHomeSoftware Heritage
Differential D5819

assets/webapp: Add UI guided tour
ClosedPublic
Actions

Authored by anlambert on Jun 3 2021, 6:19 PM.

Details

Reviewers
None
Group Reviewers
Reviewers
Maniphest Tasks
T3202: Help new users discover the features available in the archive browsing view
Commits
rDWAPPS992bea293d25: assets/webapp: Add UI guided tour to help users discover features
Summary

First draft of Web UI guided tour implementation based on the use of intro.js.

There is still improvements to bring and it is far from complete at the moment
but implementation skeleton should not change a lot apart adding and refining
guided tour steps.

So basically, the tour is configured from an array of JavaScript objects
containing the following:

  • the URL of the page a guided tour will be executed
  • the tour configuration in itself with the defined steps matching a DOM element to an help text
  • callback function to check if user can proceed to next step, it enables to make the tour more interactive

When the tour is executed, it will automatically move to the next page when all
steps of the current one have been followed.

The tour can be executed by clicking on the Help link in the main sidebar.


Related to T3202

Diff Detail

Repository
rDWAPPS Web applications
Branch
browse-ui-guided-tour-introjs
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 22495
Build 35047: Phabricator diff pipeline on jenkinsJenkins console · Jenkins
Build 35046: arc lint + arc unit

Unit TestsFailed
View All

TimeTest
24,190 msJenkins > should display badge integration info when clicking on it::Tests / Cypress tests / Run cypress tests / Persistent Identifiers Tests should display badge integration info when clicking on it
AssertionError: Timed out retrying after 20000ms: Expected to find content: 'http://localhost:5004/swh:1:cnt:b2613ff021265c651e06a8ce3845bf03d033172d;origin=https://github.com/wcoder/highlightjs-line-numbers.js;visit=swh:1:snp:da8abf3ec5203afa1561754a041aca64d7580ec2;anchor=swh:1:rel:6877028d6e5412780517d0bfa81f07f6c51abb41;path=/src/highlightjs-line-numbers.js;lines=6-12' within the element: <pre.swh-badge-html> but never did. at Context.eval (http://localhost:5004/__cypress/tests?p=cypress/integration/persistent-identifiers.spec.js:230:50)
224 msJenkins > .tox.py3.lib.python3.7.site-packages.swh.web.tests.admin.test_origin_save::Tests / Python tests / test_accept_pending_save_request
270 msJenkins > .tox.py3.lib.python3.7.site-packages.swh.web.tests.admin.test_origin_save::Tests / Python tests / test_add_authorized_origin_url
123 msJenkins > .tox.py3.lib.python3.7.site-packages.swh.web.tests.admin.test_origin_save::Tests / Python tests / test_add_unauthorized_origin_url
135 msJenkins > .tox.py3.lib.python3.7.site-packages.swh.web.tests.admin.test_origin_save::Tests / Python tests / test_reject_pending_save_request
View Full Test Results (1 Failed · 716 Passed · 5 Skipped)

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes
moranegg added inline comments.Jul 2 2021, 12:13 AM
assets/src/bundles/guided_tour/guided-tour-steps.yaml
96
Here you will find the list of releases for this software origin.

Maybe note the comment about "missing" releases?

103

Here you can find when did SWH captured and uploaded the source code. These visits are called snapshot and they can visualized in various ways:...
Like with a way-back machine, you can travel in time and see the code as it was.

113

You can easily switch between different branches and releases using this dropdown.

contained in a snapshot seems like too much information in a guided tour...

115

you lost me...
:-)
Can you explain?

123

visitor point of view:
"breadcrumbs??§?"

You can see here the current path you are taking in the code, which will make it easier to navigate back

I'm dropping here voluntarily tree and ancestor

139

using the dedicated buttons on the bottom-right

but if you are afraid that the interface will change and this will need maintenance, I don't mind leaving as is.

141
  1. add hint about the "contextual information"
  2. add hint about the SWHIDs types (cnt, dir, rev, snp)
  3. please add a one liner there "for reproducibility you should choose the directory type and add contextual information
  4. add badges
anlambert added a comment.Jul 2 2021, 4:51 PM
In D5819#152907, @moranegg wrote:

Great work!

I just suggested some UX changes to make it more fun, but the tour sounds really great.

What's the ETA on this? (not for urgency, just to know when to expect this for the ambassadors...)

@moranegg, thanks a lot for the review ! I am not a good english writer so your suggestions of improvements are more than welcolme !
I intend to deploy a first version of that tour next week only accessible to team members and ambassadors.
Let's integrate your suggestions of improvements now.

anlambert marked 14 inline comments as done.Jul 2 2021, 6:02 PM
anlambert added inline comments.
assets/src/bundles/guided_tour/guided-tour-steps.yaml
41

Downloads list is stored into browser local storage and thus are not tight to a user account (no keycloak at the time it was implemented). But it could be a good idea to store that list in swh-web database for authenticated users indeed.

66

here you go on a specific chosen url?

I choosed an URL that is also available when running cypress tests for commodity here
(the webapp populates a small archive with a couple of lightweight github repositories for
its tests).

Maybe something more sexy:
Come on in, let's check how it looks inside a source code library...
Maybe it is not explicit enough that the tour continues, it really depends on the UI

No you are right, "Next page" link is quite explicit about what will happen next.

79

Is the title visible in the tour?

Sure, title is displayed in popup header, intro in popup body.

96

Good point, having non annotated git tags in the branches list view is so disturbing for users.

113

Agreed, developer speaking here ;-)

115

You can easily hit a 404 when switching branches if the current browsed path does not exist in new selected branch.

But yes too much info here, let's keep the help text simple, I will remove that part.
Plus the 404 error messages are pretty clear about the missing path.

123

visitor point of view:
"breadcrumbs??§?"

Developer still speaking here ;-) Le's go for Current navigation path instead.

141

Sure, I was planning to add more steps for the SWHIDs tab as it is one of the most important part of the Web UI.
I will handle that next week.

anlambert updated this revision to Diff 21470.Jul 2 2021, 6:04 PM
anlambert marked 6 inline comments as done.

Update:

  • rebase
  • improve guided tour steps (thanks @moranegg !)
anlambert planned changes to this revision.Jul 2 2021, 6:11 PM

Almost there, a couple more steps to add in the tour and some polishing to do before landing this.

swh-public-ci added a comment.Jul 2 2021, 6:23 PM

Build has FAILED

Patch application report for D5819 (id=21470)

Rebasing onto 3c06b0331d...

Current branch diff-target is up to date.
Changes applied before test
commit 9521c45d346bf10f8c88858a9e48fc8d8672e2fb
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features (WIP)

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/922/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/922/console

Harbormaster failed remote builds in B22447: Diff 21470!Jul 2 2021, 6:23 PM
moranegg added a comment.Jul 4 2021, 10:54 PM

Thanks for the modifications!
Glad you found it useful.

I've created a task following a discussion on comment: T3419

I'll be glad to test it on staging, I can't test it locally at the moment.

vlorentz added a subscriber: vlorentz.EditedJul 5 2021, 12:15 PM

(edit: forget the error, it's not related to the diff)

yarn.lock
13591–13601

why are there two yaml versions given these requirements?

anlambert added inline comments.Jul 5 2021, 1:03 PM
yarn.lock
13591–13601

The yaml module is also a dependency of other modules located in node_modules folder:

(swh) ✔ ~/swh/swh-environment/swh-web [browse-ui-guided-tour-introjs L|⚑ 70] 
12:54 $ find . -name package.json | xargs grep \"yaml\"
./node_modules/generate-robotstxt/node_modules/cosmiconfig/package.json:    "yaml": "^1.7.2"
./node_modules/yaml/package.json:  "name": "yaml",
./node_modules/cosmiconfig/package.json:    "yaml": "^1.10.0"
./node_modules/mocha/node_modules/js-yaml/package.json:    "yaml",
./node_modules/@cypress/code-coverage/node_modules/js-yaml/package.json:    "yaml",
./node_modules/interpret/package.json:    "yaml",
./node_modules/yaml-loader/package.json:    "yaml",
./node_modules/yaml-loader/package.json:    "yaml": "^1.8.3"
./node_modules/yaml-loader/node_modules/yaml/package.json:  "name": "yaml",
./node_modules/bootstrap-loader/node_modules/js-yaml/package.json:    "yaml",
./node_modules/js-yaml/package.json:    "yaml",

As I added the yaml-loader dependency with that command: yarn add yaml-loader --dev, my guess is that yarn did not merge properly the data in the lock file. If I remove the lock file and call yarn install, only one entry for yaml is generated in the lock file, will update then.

ardumont added a subscriber: ardumont.Jul 5 2021, 2:10 PM
ardumont added inline comments.
assets/src/bundles/guided_tour/guided-tour-steps.yaml
138
anlambert added inline comments.Jul 5 2021, 2:15 PM
assets/src/bundles/guided_tour/guided-tour-steps.yaml
138

I think I would rather go for its permalink. to match button texts.

vlorentz added a comment.Jul 5 2021, 2:47 PM

I found a bug:

  • click "Help"
  • wait for the popup to appear
  • click anywhere outside the popup (could happen by accident)
  • click "Help" again, directs me to /?guided_tour=0&guided_tour_next=http://127.0.0.1:5004/# but does not start a tour
  • clicking "Help" again does nothing
vlorentz added a comment.Jul 5 2021, 2:52 PM

Two other bugs at once:

  • while on the "Search archived software origins" modal, make sure the "Next" button is selected
  • Press space -> bug #2: it makes the page scroll instead of having the same action as pressing Enter or clicking the button
  • Actually click the button
  • bug #3: Because the page scrolled at the previous step, it highlights the wrong part of the page as the "Save Code Now" button:

anlambert added a comment.Jul 5 2021, 2:53 PM
In D5819#153336, @vlorentz wrote:

I found a bug:

  • click "Help"
  • wait for the popup to appear
  • click anywhere outside the popup (could happen by accident)
  • click "Help" again, directs me to /?guided_tour=0&guided_tour_next=http://127.0.0.1:5004/# but does not start a tour
  • clicking "Help" again does nothing

Yes, i know this one, I planned to fix it once I enhanced tour steps.

vlorentz added a comment.Jul 5 2021, 2:56 PM

Very nice!

I'm now at the "Highlight a source code line" step, the "Back" button is disabled, and the "Next" button doesn't do anything. Is this a WIP?

assets/src/bundles/guided_tour/guided-tour-steps.yaml
53–56
108–112
anlambert added a comment.Jul 5 2021, 3:02 PM
In D5819#153337, @vlorentz wrote:

Two other bugs at once:

  • while on the "Search archived software origins" modal, make sure the "Next" button is selected
  • Press space -> bug #2: it makes the page scroll instead of having the same action as pressing Enter or clicking the button
  • Actually click the button
  • bug #3: Because the page scrolled at the previous step, it highlights the wrong part of the page as the "Save Code Now" button:

Looks like intro.js did not set up a keyboard shortcut for the space key and it gets forwarded to swh page instead.
I think we should forbid page scrolling when the tour runs to avoid that kind of behaviors.

anlambert added a comment.Jul 5 2021, 3:04 PM

I'm now at the "Highlight a source code line" step, the "Back" button is disabled, and the "Next" button doesn't do anything. Is this a WIP?

Yes I did not finish that page yet. To get the next link activated, you have to click first on the line number indicated in the tour in order to select it.

anlambert marked 2 inline comments as done.Jul 5 2021, 5:40 PM
anlambert updated this revision to Diff 21494.Jul 5 2021, 5:42 PM

Update:

  • Add more steps to origin browse view tour (notably for the SWHIDs tab)
  • Fix bugs spotted by @vlorentz

Remains the content view tour to complete with more steps.

anlambert planned changes to this revision.Jul 5 2021, 5:47 PM
swh-public-ci added a comment.Jul 5 2021, 6:02 PM

Build has FAILED

Patch application report for D5819 (id=21494)

Rebasing onto 3c06b0331d...

Current branch diff-target is up to date.
Changes applied before test
commit 3be55c320d80bc539905d55cd35119ba69c4bb50
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features (WIP)

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/924/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/924/console

Harbormaster failed remote builds in B22468: Diff 21494!Jul 5 2021, 6:02 PM
anlambert updated this revision to Diff 21522.Jul 6 2021, 4:52 PM

Update:

  • add more steps to origin browse view
  • add more steps to content browse view and use more relevant source code file as example
  • polish js code
  • fix some spotted issues while testing the tour
  • improve interactive part of the tour regarding source code lines selection
  • update cypress tests

I will stop putting that diff in "Planned Changes" state from now on as I
think we are close to deploy a first shot of that tour to production now.

anlambert retitled this revision from assets/webapp: Add UI guided tour (WIP) to assets/webapp: Add UI guided tour.Jul 6 2021, 4:56 PM
anlambert edited the summary of this revision. (Show Details)
swh-public-ci added a comment.Jul 6 2021, 5:16 PM

Build has FAILED

Patch application report for D5819 (id=21522)

Rebasing onto 36b44ef08e...

Current branch diff-target is up to date.
Changes applied before test
commit a41cfca5c078056de57b5c18a409d3c3719304e1
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/931/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/931/console

Harbormaster failed remote builds in B22495: Diff 21522!Jul 6 2021, 5:16 PM
swh-public-ci added a comment.Jul 6 2021, 5:38 PM

Build was aborted

Patch application report for D5819 (id=21522)

Rebasing onto 36b44ef08e...

Current branch diff-target is up to date.
Changes applied before test
commit a41cfca5c078056de57b5c18a409d3c3719304e1
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/932/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/932/console

swh-public-ci added a comment.Jul 7 2021, 11:43 AM

Build was aborted

Patch application report for D5819 (id=21522)

Rebasing onto 36b44ef08e...

Current branch diff-target is up to date.
Changes applied before test
commit a41cfca5c078056de57b5c18a409d3c3719304e1
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/936/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/936/console

swh-public-ci added a comment.Jul 7 2021, 11:48 AM

Build was aborted

Patch application report for D5819 (id=21522)

Rebasing onto 36b44ef08e...

Current branch diff-target is up to date.
Changes applied before test
commit a41cfca5c078056de57b5c18a409d3c3719304e1
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/937/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/937/console

swh-public-ci added a comment.Jul 7 2021, 11:53 AM

Build has FAILED

Patch application report for D5819 (id=21522)

Rebasing onto 36b44ef08e...

Current branch diff-target is up to date.
Changes applied before test
commit a41cfca5c078056de57b5c18a409d3c3719304e1
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/938/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/938/console

swh-public-ci added a comment.Jul 7 2021, 12:05 PM

Build has FAILED

Patch application report for D5819 (id=21522)

Rebasing onto 36b44ef08e...

Current branch diff-target is up to date.
Changes applied before test
commit a41cfca5c078056de57b5c18a409d3c3719304e1
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/939/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/939/console

swh-public-ci added a comment.Jul 7 2021, 12:12 PM

Build was aborted

Patch application report for D5819 (id=21522)

Rebasing onto 36b44ef08e...

Current branch diff-target is up to date.
Changes applied before test
commit a41cfca5c078056de57b5c18a409d3c3719304e1
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/940/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/940/console

swh-public-ci added a comment.Jul 7 2021, 12:35 PM

Build was aborted

Patch application report for D5819 (id=21522)

Rebasing onto 36b44ef08e...

Current branch diff-target is up to date.
Changes applied before test
commit a41cfca5c078056de57b5c18a409d3c3719304e1
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/941/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/941/console

swh-public-ci added a comment.Jul 7 2021, 12:56 PM

Build has FAILED

Patch application report for D5819 (id=21522)

Rebasing onto 36b44ef08e...

Current branch diff-target is up to date.
Changes applied before test
commit a41cfca5c078056de57b5c18a409d3c3719304e1
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/942/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/942/console

swh-public-ci added a comment.Jul 7 2021, 1:00 PM

Build was aborted

Patch application report for D5819 (id=21522)

Rebasing onto 36b44ef08e...

Current branch diff-target is up to date.
Changes applied before test
commit a41cfca5c078056de57b5c18a409d3c3719304e1
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/943/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/943/console

swh-public-ci added a comment.Jul 7 2021, 1:06 PM

Build was aborted

Patch application report for D5819 (id=21522)

Rebasing onto 36b44ef08e...

Current branch diff-target is up to date.
Changes applied before test
commit a41cfca5c078056de57b5c18a409d3c3719304e1
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/944/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/944/console

swh-public-ci added a comment.Jul 7 2021, 1:11 PM

Build was aborted

Patch application report for D5819 (id=21522)

Rebasing onto 36b44ef08e...

Current branch diff-target is up to date.
Changes applied before test
commit a41cfca5c078056de57b5c18a409d3c3719304e1
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/945/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/945/console

swh-public-ci added a comment.Jul 7 2021, 2:18 PM

Build was aborted

Patch application report for D5819 (id=21522)

Rebasing onto 36b44ef08e...

Current branch diff-target is up to date.
Changes applied before test
commit a41cfca5c078056de57b5c18a409d3c3719304e1
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/946/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/946/console

swh-public-ci added a comment.Jul 7 2021, 2:52 PM

Build was aborted

Patch application report for D5819 (id=21522)

Rebasing onto 36b44ef08e...

Current branch diff-target is up to date.
Changes applied before test
commit a41cfca5c078056de57b5c18a409d3c3719304e1
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/948/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/948/console

swh-public-ci added a comment.Jul 7 2021, 3:31 PM

Build has FAILED

Patch application report for D5819 (id=21522)

Rebasing onto 36b44ef08e...

Current branch diff-target is up to date.
Changes applied before test
commit a41cfca5c078056de57b5c18a409d3c3719304e1
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/949/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/949/console

anlambert updated this revision to Diff 21535.Jul 7 2021, 4:09 PM

Fix cypress test

swh-public-ci added a comment.Jul 7 2021, 4:30 PM

Build has FAILED

Patch application report for D5819 (id=21535)

Rebasing onto 36b44ef08e...

Current branch diff-target is up to date.
Changes applied before test
commit ff36b36299cefb5c84b521aa90e19137af902e3f
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/952/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/952/console

Harbormaster failed remote builds in B22510: Diff 21535!Jul 7 2021, 4:30 PM
swh-public-ci added a comment.Jul 7 2021, 4:58 PM

Build is green

Patch application report for D5819 (id=21535)

Rebasing onto 36b44ef08e...

Current branch diff-target is up to date.
Changes applied before test
commit ff36b36299cefb5c84b521aa90e19137af902e3f
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

See https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/953/ for more details.

Harbormaster completed remote builds in B22510: Diff 21535.Jul 7 2021, 4:58 PM
anlambert updated this revision to Diff 21588.Jul 9 2021, 4:17 PM

Rebase

swh-public-ci added a comment.Jul 9 2021, 4:37 PM

Build has FAILED

Patch application report for D5819 (id=21588)

Rebasing onto 3bfc6942fe...

Current branch diff-target is up to date.
Changes applied before test
commit c8e32e745aa3e76fc8d972cc89f6d01757e34e73
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/962/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/962/console

Harbormaster failed remote builds in B22563: Diff 21588!Jul 9 2021, 4:37 PM
anlambert added a comment.Jul 9 2021, 4:39 PM
In D5819#154171, @swh-public-ci wrote:

Build has FAILED

Patch application report for D5819 (id=21588)

Rebasing onto 3bfc6942fe...

Current branch diff-target is up to date.
Changes applied before test
commit c8e32e745aa3e76fc8d972cc89f6d01757e34e73
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/962/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/962/console

Looks like D5982 did not fix that flaky cypress test as I expected, sigh ...

swh-public-ci added a comment.Jul 9 2021, 4:56 PM

Build is green

Patch application report for D5819 (id=21588)

Rebasing onto 3bfc6942fe...

Current branch diff-target is up to date.
Changes applied before test
commit c8e32e745aa3e76fc8d972cc89f6d01757e34e73
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

See https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/963/ for more details.

Harbormaster completed remote builds in B22563: Diff 21588.Jul 9 2021, 4:56 PM
anlambert updated this revision to Diff 21685.Jul 19 2021, 11:18 AM

Rebase

swh-public-ci added a comment.Jul 19 2021, 11:37 AM

Build has FAILED

Patch application report for D5819 (id=21685)

Rebasing onto 4a9cf1d618...

Current branch diff-target is up to date.
Changes applied before test
commit 89456bf130652da964ec62fa75979ac8a4601e4d
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/968/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/968/console

Harbormaster failed remote builds in B22653: Diff 21685!Jul 19 2021, 11:37 AM
swh-public-ci added a comment.Jul 19 2021, 12:41 PM

Build is green

Patch application report for D5819 (id=21685)

Rebasing onto 4a9cf1d618...

Current branch diff-target is up to date.
Changes applied before test
commit 89456bf130652da964ec62fa75979ac8a4601e4d
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

See https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/969/ for more details.

anlambert updated this revision to Diff 21688.Jul 19 2021, 2:04 PM

Fix a guided tour step, element id was removed after a rebase.

swh-public-ci added a comment.Jul 19 2021, 2:21 PM

Build is green

Patch application report for D5819 (id=21688)

Rebasing onto 4a9cf1d618...

Current branch diff-target is up to date.
Changes applied before test
commit 992bea293d2588855e2e72c918f392085462da14
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 12 11:42:40 2021 +0200

    assets/webapp: Add UI guided tour to help users discover features
    
    Add a Web UI guided tour implemented using the intro.js library.
    
    The tour showcases the main browsing features offered by Software
    Heritage web application by highlighting the relevant DOM elements
    and displaying help texts in tooltips.
    
    The tour can span multiple web pages and steps are configured in
    a YAML file for help texts writing commodity.
    
    Currently, the homepage, the main origin browsing view and content
    browsing view are covered by the tour.
    
    Related to T3202

See https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/970/ for more details.

Harbormaster completed remote builds in B22655: Diff 21688.Jul 19 2021, 2:21 PM
This revision was not accepted when it landed; it landed in state Needs Review.Jul 19 2021, 2:25 PM
Closed by commit rDWAPPS992bea293d25: assets/webapp: Add UI guided tour to help users discover features (authored by anlambert). · Explain Why
This revision was automatically updated to reflect the committed changes.
anlambert added a commit: rDWAPPS992bea293d25: assets/webapp: Add UI guided tour to help users discover features.

Revision Contents
Changeset List

PathSize
assets/
config/
5 lines
src/
bundles/
browse/
8 lines
guided_tour/
306 lines
182 lines
18 lines
webapp/
49 lines
utils/
47 lines
cypress/
integration/
123 lines
4 lines
swh/
web/
templates/
4 lines
includes/
4 lines
34 lines
10 lines
4 lines
2 lines
6 lines
21 lines
18 lines

Diff 21522

View Options

assets/config/webpack.config.development.js

Loading...
View Options

assets/src/bundles/browse/swhid-utils.js

Loading...
View Options

assets/src/bundles/guided_tour/guided-tour-steps.yaml

Loading...
View Options

assets/src/bundles/guided_tour/index.js

Loading...
View Options

assets/src/bundles/guided_tour/swh-introjs.css

Loading...
View Options

assets/src/bundles/webapp/code-highlighting.js

Loading...
View Options

assets/src/utils/scrolling.js

Loading...
View Options

cypress/integration/guided-tour.spec.js

Loading...
View Options

package.json

Loading...
View Options

swh/web/templates/homepage.html

Loading...
View Options

swh/web/templates/includes/revision-info.html

Loading...
View Options

swh/web/templates/includes/show-swhids.html

Loading...
View Options

swh/web/templates/includes/snapshot-context.html

Loading...
View Options

swh/web/templates/includes/take-new-snapshot.html

Loading...
View Options

swh/web/templates/includes/top-navigation.html

Loading...
View Options

swh/web/templates/includes/vault-create-tasks.html

Loading...
View Options

swh/web/templates/layout.html

Loading...
View Options

yarn.lock

Loading...
About · Developer information · Legal