University Course Content Updates (#805)

* add next and previous button on course material Signed-off-by: Chloe Ching <[email protected]> * updates on excel connector content Signed-off-by: Chloe Ching <[email protected]> * updates to university course content Signed-off-by: Chloe Ching <[email protected]> * fix error Signed-off-by: Chloe Ching <[email protected]> * merge updates Signed-off-by: Chloe Ching <[email protected]> * updates Signed-off-by: Chloe Ching <[email protected]> * add underline to powerbi section Signed-off-by: Chloe Ching <[email protected]> --------- Signed-off-by: Chloe Ching <[email protected]>
rtdip · Aug 15, 2024 · 9471539 · 9471539
1 parent 8989f28
commit 9471539
Show file tree

Hide file tree

Showing 35 changed files with 259 additions and 104 deletions.
diff --git a/docs/overrides/essentials.html b/docs/overrides/essentials.html
@@ -87,9 +87,6 @@ <h3 class="clickable-subtitle">Architecture</h3>
                             <a href="../../essentials/rtdip/architecture/databricks">Databricks</a>
                         </li>
                         <h3 class="clickable-subtitle">Getting Started</h3>
-                        <li>
-                            <a href="../../essentials/sdk/getting-started/introduction">Overview</a>
-                        </li>
                         <li>
                             <a href="../../essentials/sdk/getting-started/prerequisites">SDK & API Prerequisites</a>
                         </li>
@@ -151,7 +148,26 @@ <h3 class="clickable-subtitle">Queries</h3>
                 <div class="clickable-list-item" onclick="toggleDetails(this)">
                     <div class="clickable-list-item-title">
                         <span class="clickable-title">
-                            Lesson 3: API
+                            Lesson 3: Power BI
+                        </span>
+                        <span class="clickable-list-toggle-indicator">
+                            +
+                        </span>
+                    </div>
+                    <ul class="clickable-list-details">
+                        <li>
+                            <a href="../../essentials/powerbi/overview">Overview</a>
+                        </li>
+                        <li>
+                            <a href="../../essentials/powerbi/exercise">Exercise</a>
+                        </li>
+                    </ul>
+                    <hr>
+                </div>
+                <div class="clickable-list-item" onclick="toggleDetails(this)">
+                    <div class="clickable-list-item-title">
+                        <span class="clickable-title">
+                            Lesson 4: API
                         </span>
                         <span class="clickable-list-toggle-indicator">
                             +
@@ -179,7 +195,7 @@ <h3 class="clickable-subtitle">Queries</h3>
                 <div class="clickable-list-item" onclick="toggleDetails(this)">
                     <div class="clickable-list-item-title">
                         <span class="clickable-title">
-                            Lesson 4: Excel connector
+                            Lesson 5: Excel connector
                         </span>
                         <span class="clickable-list-toggle-indicator">
                             +
@@ -217,6 +233,9 @@ <h3>Skills you'll gain in this course</h3>
                             <li>
                                 <a>How to use RTDIP SDK</a>
                             </li>
+                            <li>
+                                <a>How to connect to Power BI</a>
+                            </li>
                             <li>
                                 <a>How to call RTDIP API's</a>
                             </li>

diff --git a/docs/sdk/queries/functions.md b/docs/sdk/queries/functions.md
@@ -1,6 +1,7 @@
 # Functions
-
+<!-- --8<-- [start:intro] -->
 The RTDIP SDK enables users to perform complex queries, including aggregation on datasets within the Platform. Please find below the various types of queries available for specific dataset types. These SDK Functions are also supported by the [RTDIP API Docker Image.](https://hub.docker.com/r/rtdip/api)
+<!-- --8<-- [end:intro] -->
 
 ## Time Series Events
 

diff --git a/docs/university/essentials/api/authentication.md b/docs/university/essentials/api/authentication.md
@@ -1,5 +1,9 @@
 --8<-- "api/authentication.md:authentication"
 
+<br></br>
+[← Previous](./overview.md){ .curved-button }
+[Next →](./swagger.md){ .curved-button }
+
 ## Course Progress
 -   [X] Overview
 -   [X] SDK
@@ -9,4 +13,5 @@
     *   [X] Authentication
     *   [ ] Swagger
     *   [ ] Postman
-    *   [ ] Exercise
+    *   [ ] Exercise
+-   [ ] Excel Connector
diff --git a/docs/university/essentials/api/exercise.md b/docs/university/essentials/api/exercise.md
@@ -18,10 +18,18 @@ In this exercise, you will learn how to run APIs on Swagger and Postman.
 
 8. Repeat exercise 2-5 using Postman.
 
+<br></br>
+[← Previous](./postman.md){ .curved-button }
+[Next →](../excel-connector/overview.md){ .curved-button }
 
 ## Course Progress
--   [X] Overview
+-   [X] Introduction
 -   [X] SDK
 -   [X] Power BI
 -   [X] APIs
+    *   [X] Overview
+    *   [X] Authentication
+    *   [X] Swagger
+    *   [X] Postman
+    *   [X] Exercise
 -   [ ] Excel Connector
diff --git a/docs/university/essentials/api/overview.md b/docs/university/essentials/api/overview.md
@@ -1,11 +1,16 @@
 --8<-- "api/overview.md:restapi"
 
+<br></br>
+[← Previous](../powerbi/exercise.md){ .curved-button }
+[Next →](./authentication.md){ .curved-button }
+
 ## Course Progress
--   [X] Overview
+-   [X] Introduction
 -   [X] SDK
 -   [X] Power BI
 -   [ ] APIs
     *   [X] Overview
+    *   [ ] Authentication
     *   [ ] Swagger
     *   [ ] Postman
     *   [ ] Exercise

diff --git a/docs/university/essentials/api/postman.md b/docs/university/essentials/api/postman.md
@@ -12,8 +12,12 @@ Developers widely use Postman to simplify the process of testing APIs by providi
 
 To learn more about Postman, see [Postman Documentation](https://learning.postman.com/docs/introduction/overview/#home).
 
+<br></br>
+[← Previous](./swagger.md){ .curved-button }
+[Next →](./exercise.md){ .curved-button }
+
 ## Course Progress
--   [X] Overview
+-   [X] Introduction
 -   [X] SDK
 -   [X] Power BI
 -   [ ] APIs

diff --git a/docs/university/essentials/api/swagger.md b/docs/university/essentials/api/swagger.md
@@ -33,8 +33,12 @@ RTDIP REST API documentation is available in a number of formats, as described b
 
 --8<-- "api/rest_apis.md:redoc"
 
+<br></br>
+[← Previous](./authentication.md){ .curved-button }
+[Next →](./postman.md){ .curved-button }
+
 ## Course Progress
--   [X] Overview
+-   [X] Introduction
 -   [X] SDK
 -   [X] Power BI
 -   [ ] APIs

diff --git a/docs/university/essentials/excel-connector/dashboard.md b/docs/university/essentials/excel-connector/dashboard.md
@@ -1,5 +1,5 @@
 
-# Creating a Simple Dashboard with Live Data
+# Exercise: Creating a Simple Dashboard with Live Data
 
 >
 All the functions (except Metadata) are capable of refreshing at a set interval with the `refreshIntervalSeconds` parameter.
@@ -20,12 +20,13 @@ For our final exercise, we will put everything together and create a simple dash
 Note: Currently, if you require excel to recognise dates on plots you will need to do `=VALUE(your_date_cell)`.
 >
 
-**Optional:**
-Look at the dashboard and you will see which functions are streaming and which are not - it is always a good idea to check this in case you have any stray functions running.
+## Additional Task
 
+Look at the dashboard and you will see which functions are streaming and which are not - it is always a good idea to check this in case you have any stray functions running.
 
 That's the end of this lesson - if you have any feedback about the Excel Add-in we'd love to hear it!
 
+<br></br>
 [← Previous](./functions.md){ .curved-button }
 
 >

diff --git a/docs/university/essentials/excel-connector/functions.md b/docs/university/essentials/excel-connector/functions.md
@@ -10,12 +10,13 @@ As you will have seen in the previous execise, the Excel Add-in gets data from t
 A function may look like: 
 `=RTDIP.RAW("apiUrl", "region", etc...)`
 
-**Optional:**
+## Additional Task
 
 1. Try removing optional parameters. These are shown with square brackets around them, for example `[includeBadData]`. If not input, the defaults will be input behind the scenes.
 
 Let's continue to the final section:
 
+<br></br>
 [← Previous](./taskpane.md){ .curved-button }
 [Next →](./dashboard.md){ .curved-button }
 

diff --git a/docs/university/essentials/excel-connector/getting-started.md b/docs/university/essentials/excel-connector/getting-started.md
@@ -17,6 +17,7 @@ After this, you should see our friendly taskpane (you are now completely set-up
 
 Let's move onto the next section:
 
+<br></br>
 [← Previous](./overview.md){ .curved-button }
 [Next →](./taskpane.md){ .curved-button }
 

diff --git a/docs/university/essentials/excel-connector/overview.md b/docs/university/essentials/excel-connector/overview.md
@@ -19,6 +19,8 @@ For now, here's a sneak peak of the task pane:
 > If your course is facillitated, your facilitator will have a completed Excel workbook specific to your organisation
 >
 
+<br></br>
+[← Previous](../api/exercise.md){ .curved-button }
 [Next →](./getting-started.md){ .curved-button }
 
 ## Course Progress

diff --git a/docs/university/essentials/excel-connector/taskpane.md b/docs/university/essentials/excel-connector/taskpane.md
@@ -14,17 +14,17 @@ When you click run on the task pane, it inserts a formula with the specified par
 4. Search for a different tag with the tag explorer ![tagsearch](assets/tagsearch-icon.png){width=30px} and add one to your query.
 5. Explore the dashboard ![tagsearch](assets/dashboard-icon.png){width=30px} and `edit`, `delete` or `refresh` one of your queries.
 
-**Optional:**
+
+## Additional Task
 
 1. Swtich to the `SQL` form and write a SQL query (note: these do not have to be timeseries tables)
 2. Open up the settings and change the look of the headers (or even turn them off).
 3. Look at the `Advanced Parameters` and try changing them (**do not change the refresh interval, we will do this in the final exercise**).
 
 
-
 Onto the next section: exploring the functions directly!
 
-
+<br></br>
 [← Previous](./getting-started.md){ .curved-button }
 [Next →](./functions.md){ .curved-button }
 

diff --git a/docs/university/essentials/powerbi/exercise.md b/docs/university/essentials/powerbi/exercise.md
@@ -14,6 +14,10 @@ In this exercise, you will connect to Power BI and build a simple dashboard usin
 
 5. Build a slider filter for selecting a time range
 
+<br></br>
+[← Previous](./overview.md){ .curved-button }
+[Next →](../api/overview.md){ .curved-button }
+
 ## Course Progress
 -   [X] Overview
 -   [X] SDK

diff --git a/docs/university/essentials/powerbi/overview.md b/docs/university/essentials/powerbi/overview.md
@@ -1,5 +1,11 @@
+# Power BI Overview
+
 --8<-- "integration/power-bi.md:powerbi"
 
+<br></br>
+[← Previous](../sdk/queries/exercise.md){ .curved-button }
+[Next →](./exercise.md){ .curved-button }
+
 ## Course Progress
 -   [X] Overview
 -   [X] SDK

diff --git a/docs/university/essentials/rtdip/architecture/databricks.md b/docs/university/essentials/rtdip/architecture/databricks.md
@@ -1,3 +1,7 @@
+# Architecture
+
+## Databricks
+
 ![RTDIP Databricks](../assets/rtdip_databricks.png)
 
 RTDIP integrates with Databricks and supports executing time series queries or ingesting data. Queries are executed using either Databricks SQL Warehouses or Spark Connect. Data Ingestion can be run and orchestrated using Databricks Workflows or Delta Live Tables.
@@ -8,13 +12,20 @@ For further information about Databricks, please refer to:
 - [Databricks Workflows](https://docs.databricks.com/en/workflows/index.html)
 - [Delta Live Tables](https://www.databricks.com/product/delta-live-tables)
 
+<br></br>
+[← Previous](./pipelines.md){ .curved-button }
+[Next →](../../sdk/getting-started/prerequisites.md){ .curved-button }
+
 ## Course Progress
 
--   [X] Overview
--   [X] Architecture
-    -  [X] Queries
-    -  [X] Pipelines
-    -  [X] Databricks
+-   [ ] Introduction
+    +  [X] Overview
+    +  [X] Prerequisites
+    *  [ ] Architecture
+        +   [X] Queries
+        +   [X] Pipelines
+        +   [X] Databricks
+    *  [ ] Getting Started
 -   [ ] SDK
 -   [ ] Power BI
 -   [ ] APIs

diff --git a/docs/university/essentials/rtdip/architecture/pipelines.md b/docs/university/essentials/rtdip/architecture/pipelines.md
@@ -1,14 +1,25 @@
+# Architecture
+
+## Pipelines
+
 ![RTDIP Pipelines](../assets/rtdip_sdk_pipelines.png)
 
 Not in scope for this particular course but it is worth mentioning that RTDIP also provides the ability to create and manage time series ingestion pipelines. Pipelines are a series of steps that are executed in sequence to process time series data. Pipeline components consist of data sources, data sinks, and processing steps.
 
+<br></br>
+[← Previous](./queries.md){ .curved-button }
+[Next →](./databricks.md){ .curved-button }
+
 ## Course Progress
 
--   [X] Overview
--   [ ] Architecture
-    -  [X] Queries
-    -  [X] Pipelines
-    -  [ ] Databricks
+-   [ ] Introduction
+    +   [X] Overview
+    +   [X] Prerequisites
+    *   [ ] Architecture
+        +   [X] Queries
+        +   [X] Pipelines
+        +   [ ] Databricks
+    *  [ ] Getting Started
 -   [ ] SDK
 -   [ ] Power BI
 -   [ ] APIs

diff --git a/docs/university/essentials/rtdip/architecture/queries.md b/docs/university/essentials/rtdip/architecture/queries.md
@@ -1,16 +1,27 @@
+# Architecture
+
+## Queries
+
 ![RTDIP Queries](../assets/rtdip_sdk_queries.png)
 
 RTDIP provides the ability to execute time series queries on the data stored in the RTDIP platform. The queries can be executed using the RTDIP SDK or APIs, queries such as raw, resample, interpolation, interpolate at time, time-weighted average, circular averages, circular standard deviation, latest, plot, summary, and metadata.
 
 The RTDIP Essentials course will focus on RTDIP queries in the sections that follow.
 
+<br></br>
+[← Previous](../introduction/prerequisites.md){ .curved-button }
+[Next →](./pipelines.md){ .curved-button }
+
 ## Course Progress
 
--   [X] Overview
--   [ ] Architecture
-    -  [X] Queries
-    -  [ ] Pipelines
-    -  [ ] Databricks
+-   [ ] Introduction
+    +  [X] Overview
+    +  [X] Prerequisites
+    *  [ ] Architecture
+        +   [X] Queries
+        +   [ ] Pipelines
+        +   [ ] Databricks
+    *  [ ] Getting Started
 -   [ ] SDK
 -   [ ] Power BI
 -   [ ] APIs

diff --git a/docs/university/essentials/rtdip/introduction/overview.md b/docs/university/essentials/rtdip/introduction/overview.md
@@ -1,4 +1,4 @@
-# RTDIP Essentials
+# Course Overview
 
 <p align="center"><img src=https://raw.githubusercontent.com/rtdip/core/develop/docs/getting-started/images/rtdip-horizontal-color.png alt="rtdip" width=50% height=50%/></p>
 <p style="text-align: center; font-size: 2em; font-weight: bold;">Essentials</p>
@@ -13,12 +13,15 @@ By the end of this course, you will have a good understanding of:
 - How to use the APIs to execute time series queries
 - Build visualizations and dashboards in Power BI
 
-## Course Progress
+<br></br>
+[Next →](./prerequisites.md){ .curved-button }
 
--   [ ] Overview
-    -  [X] Introduction
-    -  [ ] Prerequisites
--   [ ] Architecture
+## Course Progress
+-   [ ] Introduction
+    +   [X] Overview
+    +   [ ] Prerequisites
+    *   [ ] Architecture
+    *   [ ] Getting Started
 -   [ ] SDK
 -   [ ] Power BI
 -   [ ] APIs

diff --git a/docs/university/essentials/rtdip/introduction/prerequisites.md b/docs/university/essentials/rtdip/introduction/prerequisites.md
@@ -18,13 +18,17 @@ Before you begin the course, ensure you obtain the following prerequisites(from
     - An identifier column
     - A timestamp column
     - A value column
+
+<br></br>
+[← Previous](./overview.md){ .curved-button }
+[Next →](../architecture/queries.md){ .curved-button }
 
 ## Course Progress
-
--   [X] Overview
-    -  [X] Introduction
-    -  [X] Prerequisites
--   [ ] Architecture
+-   [ ] Introduction
+    +   [X] Overview
+    +   [X] Prerequisites
+    *   [ ] Architecture
+    *   [ ] Getting Started
 -   [ ] SDK
 -   [ ] Power BI
 -   [ ] APIs