document product tours

Ganymede-Bio · Dec 6, 2024 · deb888c · deb888c
1 parent 64e8a01
commit deb888c
Show file tree

Hide file tree

Showing 9 changed files with 51 additions and 15 deletions.
diff --git a/core-dev-operators b/core-dev-operators
diff --git a/core-operators b/core-operators
diff --git a/docs/app/Support.mdx b/docs/app/Support.mdx
@@ -11,17 +11,39 @@ import {
 
 Support can be found in Ganymede by clicking on the <div className="button darkblue_button"><QuestionCircleOutlined /></div> icon in the top right corner of the app.
 
-Clicking on the icon opens up a modal that can be used to access this documentation site, or to contact Ganymede directly.
+Clicking on the icon opens up a modal that allows you to:
+- Access this documentation site
+- [View Product Tours](#product-tours)
+- [Contact Ganymede Support](#ganymede-support)
+- [Report a bug](#report-a-bug)
 
-<img width="1302" alt="Support Modal" src="https://storage.googleapis.com/ganymede-bio-website/public/apiServer/SupportModal_20240122.png"/>
+<img alt="Support Modal" src="https://storage.googleapis.com/ganymede-bio-website/public/apiServer/SupportModal_20241206.png"/>
 <br /><br /> 
 
-Contact Ganymede Support allows you to chat directly with Ganymede support. This is the fastest way to get help with any issues you may be experiencing.
+### Product Tours
+
+Product Tours are a series of guided walkthroughs that help you learn how to use Ganymede. 
+
+<div style={{textAlign: 'center'}}>
+  <img alt="Product Tours" width="300" src="https://storage.googleapis.com/ganymede-bio-website/public/apiServer/ProductToursTypes20241206.png"/>
+</div>
+&nbsp;
+
+Selecting one of the tours will open up a series of spotlights describing different elements of the Ganymede platform.
+
+<div style={{textAlign: 'center'}}>
+  <img alt="Product Tours" src="https://storage.googleapis.com/ganymede-bio-website/public/apiServer/ProductTours_20241206.png"/>
+</div>
+
+### Ganymede Support
+
+Contact Ganymede Support allows you to send a message to Ganymede support. This is the fastest way to get help with any issues you may be experiencing.
 
 <div style={{textAlign: 'center'}}>
   <img width="400" alt="Home" src="https://storage.googleapis.com/ganymede-bio-website/public/apiServer/IntercomInApp_20240122.png"/>
 </div>
 
+### Report a Bug
 
 Reporting a bug notifies the Tech team at Ganymede to investigate and address the issue.
 

diff --git a/docs/app/intro/Welcome.mdx b/docs/app/intro/Welcome.mdx
@@ -52,7 +52,7 @@ Flows provide a Python/SQL development environment where [code changes are track
 
 ### [Agents](app/agents/Agent)
 
-Agents are locally installed executables for delivering data to and acquiring data from lab instruments.  They include a configurable Python component that (if enabled) allows users to remotely manage Agent behavior.
+Agents are locally installed executables for delivering data to and acquiring data from lab instruments.  They include a configurable Python component that, if enabled, allows users to remotely manage Agent behavior.
 
 <div style={{textAlign: 'center'}}>
   <a href="app/flows/FlowEditor">
@@ -132,7 +132,14 @@ The environment administration panel in Ganymede provides administrators with to
 
 ## Getting Started
 
-To get started, check out one or more of our Quickstart guides:
+To get started, you can navigate through a [guided tour](../../app/Support#product-tours) of your Ganymede environment by clicking on the question mark icon in the top right corner of the app.
+
+<div style={{textAlign: 'center'}}>
+  <img alt="Product Tours" width="300" src="https://storage.googleapis.com/ganymede-bio-website/public/apiServer/ProductToursTypes20241206.png"/>
+</div>
+&nbsp;
+
+Or check out one or more of our Quickstart guides:
 
 * [Create an Agent](app/agents/QuickstartBuildAgent.mdx) to automatically capture data from lab PCs
 * [Build a Flow](app/flows/QuickstartBuildFlow.mdx) to process structured and unstructured data

diff --git a/docs/nodes/Analysis/Trigger_Python.md b/docs/nodes/Analysis/Trigger_Python.md
@@ -15,14 +15,18 @@ and uses result to execute downstream flow
 
 ## User-Defined Python
 
-Processes data, then triggers downstream flow
+The [FlowInputs object](../NodeOverview#flowinputs-object) holds the inputs for the Flow to trigger.
+
+- files: Files to be passed to the Flow to trigger
+- params: Input parameters to be passed to the Flow to trigger
+- tags: Flow Tags to be passed to the Flow to trigger
 
 ### Parameters
 
 - **df_sql_result** : `pd.DataFrame | list[pd.DataFrame]`
-    - Table(s) or list of tables retrieved from user-defined SQL query
+  - Table(s) or list of tables retrieved from user-defined SQL query
 - **ganymede_context** : `Optional[GanymedeContext]`
-    - Ganymede context variable, which stores flow run metadata
+  - Ganymede context variable, which stores flow run metadata
 
 ### Returns
 
@@ -34,3 +38,6 @@ Processes data, then triggers downstream flow
 
 The ID for the triggered flow can be found by navigating to the flow in the Ganymede UI
 and clicking on Manage.  The ID is an immutable string found on the Configuration panel.
+
+Use ?FlowInputs in the Juppyter notebook to see the class definition for FlowInputs.
+Use ?FlowInputFile in the Jupyter notebook to see the class definition for FlowInputFile.
diff --git a/docs/releases/202412.mdx b/docs/releases/202412.mdx
@@ -6,7 +6,7 @@ displayed_sidebar: releaseSideBar
 ### December 05 2024
 
 **Features**
-- **UI**: Product Tours are now shown to new users
+- **UI**: [Product Tours](../app/Support#product-tours) are now shown to new users
     - These tours will highlight key UI features and their purposes
     - New users will be show a walk through of these features in the web UI
     - Tours can be replayed using the Help menu

diff --git a/docs/sdk/AI.mdx b/docs/sdk/AI.mdx
@@ -20,10 +20,10 @@ By default, access is configured in non-production environments.  Please reach o
 
 ### Search Documentation
 
-When enabled, the documentation site can be queried in notebooks by using the `help` function.  For example:
+When enabled, the documentation site can be queried in notebooks by using the `doc` function.  For example:
 
 ```python
-help("How do I add tags to a file in Ganymede?")
+doc("How do I add tags to a file in Ganymede?")
 ``` 
 
 returns a response similar to what is shown below:
@@ -58,4 +58,3 @@ Executing this code will generate a response similar to the one shown below:
 </div>
 
 Copying and pasting this code into the User-Defined Function section of the notebook will allow you to execute the function and view the results in the notebook.
-
diff --git a/docs/sdk/GanymedeClass.mdx b/docs/sdk/GanymedeClass.mdx
@@ -145,6 +145,7 @@ The _retrieve_files_ method allows you to retrieve files from Ganymede cloud sto
 
 - _param_ **file_names**: str | list[str] - The file(s) to retrieve.
 - _param_ **flow_input_or_output**: str, by default "input" - Either "input" or "output" - to reference whether to retrieve files that are inputs to Flows or outputs from Flow Nodes
+- _param_ **flow_name**: str | None, by default None - Flow name to filter files for, if input
 - _param_ **current_flow_flag**: bool, by default True - Filters for files associated with the current Flow
 - _param_ **run_id**: Optional[int], by default None - If set, filters for results with specified flow_run_id; if not specified, retrieve file(s) associated with most recent run ID
 - _param_ **use_cache_in_notebook**: bool, by default False - If set to True, retrieves files from local cache when in editor or analysis notebooks rather than querying Ganymede to expedite development.  Note that flow runs will not reference cached files.  Cache can be cleared by calling the clear_cache() function.

diff --git a/pylib b/pylib