From aae8d34dd5049fdbb221ae16f2610e0e0772fe50 Mon Sep 17 00:00:00 2001 From: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Date: Wed, 24 Apr 2024 14:49:47 +0100 Subject: [PATCH 1/2] add snowflake integration video (#6339) --- .../pro/data-connectors/native-integrations.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/website/content/pro/data-connectors/native-integrations.md b/website/content/pro/data-connectors/native-integrations.md index 0c3db786da7a..7f5e9a0c8aaa 100644 --- a/website/content/pro/data-connectors/native-integrations.md +++ b/website/content/pro/data-connectors/native-integrations.md @@ -19,12 +19,19 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + + ## Using OpenBB Native Integrations -The OpenBB native integrations allows you to connect to Snowflake, MySQL, or SQLite databases directly. You can run any query against your database directly from our Pro Terminal. +The OpenBB native integrations allows you to connect to Snowflake, MySQL, or SQLite databases directly. You can run any query against your database directly from the Terminal Pro. 1. **Install our Client**: Download our free client for [Mac](https://openbb-installers.s3.amazonaws.com/data_connector_0.0.2.dmg) or [Windows](https://openbb-installers.s3.amazonaws.com/OpenBB+Data+Connector_0.0.2_x64_en-US.msi) to get started. -2. **Run the Client**: Once installed, Simply open our app and type in the port you would like to use. If you are unsure of a good port, feel free to select `Recommend Port`. +2. **Run the Client**: Once installed, Simply open the app and type in the port you would like to use. If you are unsure of a good port, feel free to select `Recommend Port`. 3. **Connect inside the Terminal Pro**: Once your client is up and running, click [here](https://pro.openbb.co/app/data-connectors) to enable the connectors - it will ask you for the URL the port is running on - you can find that on the Data Connector Application at the top. Now feel free to enter login credentials for any Snowflake, MySQL, or SQLite database and begin to analyze your data inside of our terminal. From 3970eb0e442ff1f67d2b0bcd28113a6457516c05 Mon Sep 17 00:00:00 2001 From: Danglewood <85772166+deeleeramone@users.noreply.github.com> Date: Tue, 7 May 2024 03:57:35 -0700 Subject: [PATCH 2/2] [HotFix] Fix broken URLs in docs page. (#6368) * Fix broken URLs * use full URL to other docs pages. --- .../content/platform/development/standardization.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/website/content/platform/development/standardization.md b/website/content/platform/development/standardization.md index 78618bcd1f76..d25d93f0c88a 100644 --- a/website/content/platform/development/standardization.md +++ b/website/content/platform/development/standardization.md @@ -27,7 +27,7 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; The Standardization Framework is a set of tools and guidelines that enable the user to query and obtain data in a consistent way across multiple providers. -Each provider data model should inherit from an already defined [standard](/platform/data_models) model. All standard models are created and maintained by the OpenBB team. If a standard model needs to be created, please open a pull request and detail its use. +Each provider data model should inherit from an already defined [standard](https://docs.openbb.co/platform/data_models) model. All standard models are created and maintained by the OpenBB team. If a standard model needs to be created, please open a pull request and detail its use. Standardizing provider query parameters and response data enhances the user experience by overcoming things like: @@ -37,14 +37,14 @@ Standardizing provider query parameters and response data enhances the user expe - Transparently defined schemas for the data and query parameters. - Outputs from multiple sources are comparable with each other and easily interchanged. -The standard models are all defined in the `/OpenBBTerminal/openbb_platform/platform/core/provider/standard_models/` [directory](https://github.com/OpenBB-finance/OpenBBTerminal/tree/develop/openbb_platform/core/openbb_core/provider/standard_models). +The standard models are all defined in the `/OpenBBTerminal/openbb_platform/core/openbb_core/provider/standard_models/` [directory](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_platform/core/openbb_core/provider/standard_models). ### What Is A Standard Model? Every standard model consists of two classes, with each being a Pydantic model. -- [`QueryParams`](https://github.com/OpenBB-finance/OpenBBTerminal/tree/develop/openbb_platform/core/openbb_core/provider/abstract/query_params.py) -- [`Data`](https://github.com/OpenBB-finance/OpenBBTerminal/tree/develop/openbb_platform/core/openbb_core/provider/abstract/data.py) +- [`QueryParams`](https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/openbb_platform/core/openbb_core/provider/abstract/query_params.py) +- [`Data`](https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/openbb_platform/core/openbb_core/provider/abstract/data.py) Any parameter or field can be assigned a custom `field_validator`, or the entire model can be passed through a `model_validator` on creation. @@ -61,7 +61,7 @@ The standardization framework is a very powerful tool, but it has some caveats t ### QueryParams -The `QueryParams` is an abstract class that defines what parameters will be needed to make a query to a data source. Below is the [EquityHistorical](data_models/EquityHistorical) standard model. +The `QueryParams` is an abstract class that defines what parameters will be needed to make a query to a data source. Below is the [EquityHistorical](https://docs.openbb.co/platform/data_models/EquityHistorical) standard model. ```python """Equity Historical Price Standard Model."""