Merge pull request #807 from rtdip/develop

v0.12.0

docs/api/authentication.md

@@ -1,3 +1,5 @@
+<!-- --8<-- [start:authentication] -->
+
 # Authentication 
 
 RTDIP REST APIs require Azure Active Directory Authentication and passing the token received as an `authorization` header in the form of a Bearer token. An example of the REST API header is `Authorization: Bearer <<token>>`
@@ -17,4 +19,6 @@ If a developer or business user would like to leverage the RTDIP REST API suite,
 
 Ensure to install the relevant package and obtain a token.
 
-See the [examples](./examples.md) section to see various authentication methods implemented.
+See the [examples](https://www.rtdip.io/api/examples/) section to see various authentication methods implemented.
+
+<!-- --8<-- [end:authentication] -->

docs/api/overview.md

@@ -1,5 +1,11 @@
 <center> ![rest](images/rest-api-logo.png){width=50%} </center>
 
+<!-- --8<-- [start:restapi] -->
+
 # RTDIP REST APIs
 
-RTDIP provides REST API endpoints for querying data in the platform. The APIs are a wrapper to the python [RTDIP SDK](../sdk/overview.md) and provide similar functionality for users and applications that are unable to leverage the python RTDIP SDK. It is recommended to read the [RTDIP SDK documentation](../sdk/overview.md) and in particular the [Functions](../sdk/code-reference/query/functions/time_series/resample.md) section for more information about the options and logic behind each API.
+RTDIP provides REST API endpoints for querying data in the platform. The APIs are a wrapper to the python [RTDIP SDK](https://www.rtdip.io/sdk/overview/) and provide similar functionality for users and applications that are unable to leverage the python RTDIP SDK. It is recommended to read the [RTDIP SDK documentation](https://www.rtdip.io/sdk/overview/) and in particular the [Functions](https://www.rtdip.io/sdk/queries/functions/) section for more information about the options and logic behind each API. 
+
+RTDIP API's are designed with the intention of running small to medium queries, rather than large queries to reduce network latency, increase performance and maintainability.  
+
+<!-- --8<-- [end:restapi] -->

docs/api/rest_apis.md

@@ -1,15 +1,28 @@
+
 # RTDIP REST API Endpoints
 
 RTDIP REST API documentation is available in a number of formats, as described below. 
 
 <center> ![rest](images/open-api.png){width=50%} </center>
 
+<!-- --8<-- [start:openapi] -->
+
 RTDIP REST APIs are built to OpenAPI standard 3.0.2. You can obtain the OpenAPI JSON schema at the following endpoint of your deployed APIs `https://{domain name}/api/openapi.json`
 
+<!-- --8<-- [end:openapi] -->
+
 <center> ![rest](images/swagger.png){width=50%} </center>
 
+<!-- --8<-- [start:swagger] -->
+
 It is recommended to review the **Swagger** documentation that can be found at the following endpoint of your deployed APIs `https://{domain name}/docs` for more information about the parameters and options for each API. It is also possible to try out each API from this link.
 
+<!-- --8<-- [end:swagger] -->
+
 <center> ![rest](images/redoc-logo.png){width=50%} </center>
 
-Additionally, further information about each API can be found in Redoc format at  the following endpoint of your deployed APIs `https://{domain name}/redoc`
+<!-- --8<-- [start:redoc] -->
+
+Additionally, further information about each API can be found in Redoc format at  the following endpoint of your deployed APIs `https://{domain name}/redoc`
+
+<!-- --8<-- [end:redoc] -->

docs/assets/extra.css

@@ -15,13 +15,13 @@
  */
 
 :root {
-    --md-primary-fg-color: #4e08c7 !important;
-    --md-primary-mg-color: #d445a3 !important;
-    --md-accent-fg-color: #bb1fa4 !important;
-    --md-primary-bg-color: white !important;
-    --md-primary-text-slate: white !important;
-    --md-primary-bg-slate: #2f303e !important;
-  }
+  --md-primary-fg-color: #4e08c7 !important;
+  --md-primary-mg-color: #d445a3 !important;
+  --md-accent-fg-color: #bb1fa4 !important;
+  --md-primary-bg-color: white !important;
+  --md-primary-text-slate: white !important;
+  --md-primary-bg-slate: #2f303e !important;
+}
 
 /* header font colour */
 .md-header {
@@ -41,7 +41,7 @@
 }
 
 .md-nav__item .md-nav__link--active {
-  color:#d445a3;
+  color: #d445a3;
 }
 
 .image-center {
@@ -52,4 +52,17 @@
 
 .mermaid {
   text-align: center;
+}
+
+.curved-button {
+  color: rgb(66, 66, 66) !important;
+  border-radius: 20px;
+  padding: 10px 20px;
+  background-color: #E9ECF1;
+}
+
+
+.curved-button:hover {
+  background-color: #D3D9E2;
+  color: black !important;
 }

docs/getting-started/installation.md

@@ -12,6 +12,8 @@ This article provides a guide on how to install the RTDIP SDK. Get started by en
 
 ## Prerequisites
 
+<!-- --8<-- [start:prerequisites] -->
+
 ### Python
 
 There are a few things to note before using the RTDIP SDK. The following prerequisites will need to be installed on your local machine.
@@ -55,6 +57,8 @@ Installing the RTDIP can be done using a package installer, such as [Pip](https:
        
         micromamba self-update
 
+<!-- --8<-- [end:prerequisites] -->
+
 ### ODBC
 To use pyodbc or turbodbc python libraries, ensure it is installed as per the below and the ODBC driver is installed as per these [instructions](https://docs.microsoft.com/en-us/azure/databricks/integrations/bi/jdbc-odbc-bi#download-the-odbc-driver).
 
@@ -87,7 +91,7 @@ To use RTDIP Pipelines components in your own environment that leverages [pyspar
         - defaults
     dependencies:
         - python==3.11
-        - pip==23.0.1
+        - pip
         - openjdk==11.0.15
         - pip:
             - rtdip-sdk
@@ -108,6 +112,8 @@ To use RTDIP Pipelines components in your own environment that leverages [pyspar
 
 ## Installing the RTDIP SDK
 
+<!-- --8<-- [start:installation] -->
+
 RTDIP SDK is a PyPi package that can be found [here](https://pypi.org/project/rtdip-sdk/). On this page you can find the **project description**,  **release history**, **statistics**, **project links** and **maintainers**.
 
 Features of the SDK can be installed using different extras statements when installing the **rtdip-sdk** package:
@@ -128,7 +134,7 @@ Features of the SDK can be installed using different extras statements when inst
         pip install "rtdip-sdk[pipelines,pyspark]"
 
     !!! note "Java"
-        Ensure that Java is installed prior to installing the rtdip-sdk with the **[pipelines,pyspark]**. See [here](#java) for more information.
+        Ensure that Java is installed prior to installing the rtdip-sdk with the **[pipelines,pyspark]**. See [here](https://www.rtdip.io/getting-started/installation/#java) for more information.
 
 The following provides examples of how to install the RTDIP SDK package with Pip, Conda or Micromamba. Please note the section above to update any extra packages to be installed as part of the RTDIP SDK.
 
@@ -153,7 +159,7 @@ The following provides examples of how to install the RTDIP SDK package with Pip
         - defaults
     dependencies:
         - python==3.11
-        - pip==23.0.1
+        - pip
         - pip:
             - rtdip-sdk
     ```
@@ -177,7 +183,7 @@ The following provides examples of how to install the RTDIP SDK package with Pip
         - defaults
     dependencies:
         - python==3.11
-        - pip==23.0.1
+        - pip
         - pip:
             - rtdip-sdk
     ```
@@ -190,6 +196,9 @@ The following provides examples of how to install the RTDIP SDK package with Pip
 
         micromamba update -f environment.yml
 
+
+<!-- --8<-- [end:installation] -->
+
 ## Next steps
 Once the installation is complete you can learn how to use the SDK [here.](../sdk/overview.md)
 

docs/integration/power-bi.md

@@ -2,6 +2,8 @@
 
 ## Integration with Power BI
 
+<!-- --8<-- [start:powerbi] -->
+
 Microsoft Power BI is a business analytics service that provides interactive visualizations with self-service business intelligence capabilities
 that enable end users to create reports and dashboards by themselves without having to depend on information technology staff or database administrators.
 
@@ -33,4 +35,6 @@ For more information on how to connect Power BI with databricks, see [here](http
 1. Click **Azure Active Directory**, **Sign In** and select **Connect**. In **Power Query Editor**, there are different tables for different data types.
 ![Power BI Azure Databricks](images/bi-azure-signin.png)
 
-1. Once connected to the Databricks SQL Warehouse, navigate to the Business Unit in the navigator bar on the left and select the asset tables for the data you wish to use in your report. There is functionality to select multiple tables if required. Click **Load** to get the queried data.
+1. Once connected to the Databricks SQL Warehouse, navigate to the Business Unit in the navigator bar on the left and select the asset tables for the data you wish to use in your report. There is functionality to select multiple tables if required. Click **Load** to get the queried data.
+
+<!-- --8<-- [end:powerbi] -->