update core.history tour for changes as of 26.0

Author: ahmedhamidawan

client/src/components/History/CurrentHistory/HistoryNavigation.vue

@@ -50,7 +50,13 @@ function userTitle(title: string) {
         <nav
             :class="{ 'd-flex justify-content-between mx-3 my-2': !props.minimal }"
             aria-label="current history management">
-            <GButton v-if="!props.minimal" size="small" transparent @click="emit('show', false)">
+            <GButton
+                v-if="!props.minimal"
+                size="small"
+                data-description="hide history panel"
+                title="Hide history panel"
+                transparent
+                @click="emit('show', false)">
                 <FontAwesomeIcon fixed-width :icon="faChevronRight" />
                 <span v-localize>History</span>
             </GButton>

client/src/utils/navigation/navigation.yml

@@ -334,6 +334,11 @@ history_panel:
 
     annotation_done: '.details .history-annotation .annotation button'
 
+    filter_input: '#current-history-panel .content-operations-filters [data-description="filter text input"]'
+    filter_advanced_toggle: '#current-history-panel .content-operations-filters [data-description="toggle advanced search"]'
+    filter_reset: '#current-history-panel .content-operations-filters [data-description="reset query"]'
+    filter_advanced: '#current-history-panel .content-operations-filters [data-description="advanced filters"]'
+
     options_button: '[data-description="history options"]'
     options_button_icon: '[data-description="history options"] button'
     options_menu: '.history-options-button-menu'

config/plugins/tours/core.history.yaml

@@ -8,6 +8,11 @@ tags:
 steps:
     - content: "This short tour will guide you through <b>Galaxy's History</b> and datasets."
 
+    - title: "Your History in Galaxy"
+      element: "#current-history-panel"
+      prerequisites: ["ensure_history_panel_open"]
+      intro: "This is your <i>current</i> history! All analysis steps will be recorded here and can be redone at any time."
+
     - title: "Open the Upload Dialog"
       component: upload.start
       intro: |
@@ -41,15 +46,16 @@ steps:
       intro: Hit the close button to close the upload dialog.
       postclick: true
 
-    - title: "History"
+    - title: "Your History is Populated!"
       element: "#current-history-panel"
       prerequisites: ["ensure_history_panel_open"]
-      intro: "This is your history! All analysis steps will be recorded and can be redone at any time."
+      intro: "Your history is now populated with the two uploaded datasets.<br />
+              Any more tools you run on these will also be added to the history, so that you can keep track of your analysis steps and results."
 
     - title: "Dataset information"
       element: "div.content-item .content-title"
       prerequisites: ["ensure_history_panel_open"]
-      intro: "This is one of your uploaded datasets. You can get more informations and options like different visualizations by clicking on it."
+      intro: "This is one of your uploaded datasets. You can get more information and options like different visualizations by clicking on it."
       postclick: true
 
     - title: "Metadata"
@@ -66,16 +72,19 @@ steps:
       title: "Inspect your data"
       prerequisites: ["ensure_history_panel_open"]
       intro: "The eye symbol can be used to look at your data."
-      preclick: true
+      postclick: true
+
+    - title: "Dataset View"
+      intro: "This is the dataset view. It is a centralized place to view, visualize, edit attributes and get more information about your dataset."
 
     - component: dataset_view.details_tab
       title: "Even more information"
-      intro: "Get an overview of all metadata associated with your dataset by using the Information symbol."
+      intro: "Get an overview of all metadata associated with your dataset by clicking on the <b>Details</b> tab."
       preclick: true
 
     - component: dataset_view.edit_tab
       title: "Edit metadata"
-      intro: "With the pencil button you can edit metadata attributes of your dataset, like the associated filetype or the dataset name."
+      intro: "Edit metadata attributes of your dataset, like the associated filetype or the dataset name, by clicking on the <b>Edit</b> tab."
       preclick: true
 
     - element: "#current-history-panel div.content-item .delete-btn"
@@ -84,7 +93,7 @@ steps:
       intro: "You can remove a dataset from the history with the trash can symbol."
       postclick: true
 
-    - element: "#current-history-panel .content-operations-filters input[data-description='filter text input']"
+    - component: history_panel.filter_input
       title: "Filter your datasets"
       prerequisites: ["ensure_history_panel_open"]
       intro: "By default your history will hide all deleted datasets from you. You can visualize them by filtering."
@@ -98,17 +107,56 @@ steps:
             Please note that datasets marked as deleted can be purged by your administrator at any time.
       postclick: true
 
-    - element: "#current-history-panel .content-operations-filters input[data-description='filter text input']"
-      title: "Search your History"
+    - component: history_panel.filter_reset
+      title: "Clear the search"
+      prerequisites: ["ensure_history_panel_open"]
+      intro: "Use the reset button to clear any active filters and return to the full history view."
+      preclick: true
+
+    - component: history_panel.filter_advanced_toggle
+      title: "Advanced Filters"
+      prerequisites: ["ensure_history_panel_open"]
+      intro: "By clicking on the advanced filters button, you can see and try all of the different filter options available for your history."
+      preclick: true
+      postclick: true
+
+    - element: "#current-history-panel .content-operations .show-history-content-selectors-btn"
+      title: "Selection Operations"
       prerequisites: ["ensure_history_panel_open"]
-      intro: "You can filter your history by typing your search term in here. Galaxy supports more advanced filters that can be seen here."
-      textinsert: ""
+      intro: "This will show checkboxes next to each dataset, which you can use to select multiple datasets and then perform operations on them, like deleting or building lists out of them."
+      postclick: true
 
-    - element: "#current-history-panel [data-description='history options']"
+    - element: "#current-history-panel .content-operations .show-history-content-selectors-btn"
+      title: "Selection Operations"
+      prerequisites: ["ensure_history_panel_open"]
+      intro: "Note that you can also select datasets by Ctrl/Cmd + Click on the dataset itself, and range select datasets by Shift + Click."
+      postclick: true
+
+    - component: history_panel.options_button_icon
       title: "History Options"
       prerequisites: ["ensure_history_panel_open"]
       intro: "In the History menu you will find a lot more useful History options."
-      postclick: true
+      preclick: true
+
+    - element: "#current-history-panel [data-description='create new history']"
+      title: "Create new history"
+      prerequisites: ["ensure_history_panel_open"]
+      intro: "You can have multiple histories in Galaxy. Click this button to create a new history. This is useful to keep different analyses separate from each other."
+
+    - element: "#current-history-panel [data-description='switch to another history']"
+      title: "Switch between histories"
+      prerequisites: ["ensure_history_panel_open"]
+      intro: "You can switch between your histories by clicking on this button and selecting the history you want to switch to."
+
+    - element: "#current-history-panel [data-description='hide history panel']"
+      title: "Hide the history panel"
+      prerequisites: ["ensure_history_panel_open"]
+      intro: "If you want more space for your analysis, you can hide the history panel by clicking this button. You can get it back by clicking the same button again on the top right"
+
+    - component: histories.activity
+      title: "History List"
+      intro: "This will take you to the history list page, where you can see all your histories and their contents at a glance."
+      preclick: true
 
     - title: "Enjoy your Galaxy Histories"
       intro: "Thanks for taking this tour! Happy research with Galaxy!"