Skip to content

Quickstart guide improvements#2391

Closed
MetRonnie wants to merge 2 commits intocylc:masterfrom
MetRonnie:quickstart-animation
Closed

Quickstart guide improvements#2391
MetRonnie wants to merge 2 commits intocylc:masterfrom
MetRonnie:quickstart-animation

Conversation

@MetRonnie
Copy link
Member

@MetRonnie MetRonnie commented Dec 23, 2025

Add link to quickstart guide in the workflow toolbar avatar menu

Check List

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • Contains logically grouped changes (else tidy your branch by rebase).
  • Does not contain off-topic changes (use other PRs for other changes).
  • Tests included
  • Changelog entry not needed as minor
  • Docs not needed

@MetRonnie MetRonnie added this to the 2.x milestone Dec 23, 2025
@MetRonnie MetRonnie changed the title Quickstart animation Quickstart guide improvements Dec 23, 2025
@MetRonnie MetRonnie self-assigned this Dec 23, 2025
@oliver-sanders
Copy link
Member

oliver-sanders commented Dec 29, 2025

Redirecting the user to another page for the help might not be ideal as it takes them away from what they're doing. A couple of folks have requested to have the quickstart content available in a Lumino tab so they can have it open whilst working.

There's an issue for this here - #1184 (see #1884 (comment) for clarification), it was also requested recentlyish by our operators to facilitate acclimatation.

Trivial to implement:

diff --git a/src/views/views.js b/src/views/views.js
index 8b32cf18..0845abc5 100644
--- a/src/views/views.js
+++ b/src/views/views.js
@@ -26,6 +26,7 @@ import {
   mdiTree,
   mdiChartGantt,
   mdiInformationOutline,
+  mdiHelp,
 } from '@mdi/js'
 
 // Use dynamic async components for lazy loading:
@@ -37,6 +38,7 @@ const AnalysisView = defineAsyncComponent(() => import('@/views/Analysis.vue'))
 const GanttView = defineAsyncComponent(() => import('@/views/Gantt.vue'))
 const SimpleTreeView = defineAsyncComponent(() => import('@/views/SimpleTree.vue'))
 const InfoView = defineAsyncComponent(() => import('@/views/Info.vue'))
+const GuideView = defineAsyncComponent(() => import('@/views/Guide.vue'))
 
 /**
  * @typedef {Object} CylcView
@@ -60,6 +62,7 @@ export const workflowViews = new Map([
   ['Log', { component: LogView, icon: mdiFileDocumentMultipleOutline }],
   ['Analysis', { component: AnalysisView, icon: mdiChartLine }],
   ['Gantt', { component: GanttView, icon: mdiChartGantt }],
+  ['Guide', { component: GuideView, icon: mdiHelp }],
 ])
 
 // Development views that we don't want in production:

@oliver-sanders
Copy link
Member

We've had another request for documentation (n-window) and a request to advertise the tab layout feature, so opened #2392 (built on this).

@MetRonnie
Copy link
Member Author

Superseded by #2392

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants