From c680a74872b433416d87ddf4689c56af37515fcc Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Mon, 20 Nov 2023 12:53:28 -0800 Subject: [PATCH] Add Pro videos to docs + fix CI (#5765) * add pro vids * Update gh-pages.yml --- .github/workflows/gh-pages.yml | 2 +- website/content/pro/advanced-search.md | 8 +++++++- website/content/pro/copilot.md | 6 ++++++ website/content/pro/getting-started/index.md | 12 +++++++++++- website/content/pro/main-menu/charting.md | 9 ++++++++- .../content/pro/main-menu/data-connectors/index.md | 9 ++++++++- website/content/pro/main-menu/homepage.md | 9 ++++++++- website/content/pro/main-menu/news.md | 9 ++++++++- website/content/pro/widgets/index.md | 1 - 9 files changed, 57 insertions(+), 8 deletions(-) diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index a0c8bb86b99..68fa97d4aad 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -64,7 +64,7 @@ jobs: source $VENV pip uninstall Brotli -y pytest tests/website --autodoc - python website/generate_sdk_markdown.py && python website/generate_terminal_markdown.py + python website/generate_platform_v4_markdown.py && website/generate_sdk_v3_markdown.py && python website/generate_terminal_v3_markdown.py - name: Setup Node uses: actions/setup-node@v3 diff --git a/website/content/pro/advanced-search.md b/website/content/pro/advanced-search.md index f300a3ceaa1..ad2ddeeebc9 100644 --- a/website/content/pro/advanced-search.md +++ b/website/content/pro/advanced-search.md @@ -20,11 +20,17 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; -275681118-b5ed496a-5822-49c9-bc56-958dab886f59 + OpenBB Terminal Pro's advanced search is a powerful tool that enables you to perform a wide range of tasks swiftly and efficiently. +275681118-b5ed496a-5822-49c9-bc56-958dab886f59 + The search is divided into six main categories: * **Securities**: This category displays securities that match your search criteria. It's not limited to symbol matches; it also includes company names. For instance, a search for 'Sales' will return 'Salesforce', which has the ticker symbol 'CRM'. diff --git a/website/content/pro/copilot.md b/website/content/pro/copilot.md index 5f1015330bd..b8f7c5e238e 100644 --- a/website/content/pro/copilot.md +++ b/website/content/pro/copilot.md @@ -18,6 +18,12 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + OpenBB copilot is your companion to interact with the OpenBB Terminal Pro. diff --git a/website/content/pro/getting-started/index.md b/website/content/pro/getting-started/index.md index 4f3399faa98..ff12a48fdf2 100644 --- a/website/content/pro/getting-started/index.md +++ b/website/content/pro/getting-started/index.md @@ -21,7 +21,17 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; -Welcome to the OpenBB Terminal Pro, your comprehensive tool for investment research. Let's get you started by understanding the layout of the Terminal Pro. +Welcome to the OpenBB Terminal Pro, your comprehensive tool for investment research. + +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + + + +Let's get you started by understanding the layout of the Terminal Pro. 275680756-5738aae0-23cd-4cfa-8150-77150a1d5086 diff --git a/website/content/pro/main-menu/charting.md b/website/content/pro/main-menu/charting.md index 62219cd8e67..8659814ef3e 100644 --- a/website/content/pro/main-menu/charting.md +++ b/website/content/pro/main-menu/charting.md @@ -26,10 +26,17 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; -273497041-34665daf-a145-44c5-ab1e-285c34d29bda +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + Our charting feature is powered by the renowned TradingView charting library, offering you a comprehensive and intuitive platform for financial analysis. With this feature, you can access all the functionalities typically available on TradingView. To get the most out of this feature, we recommend familiarizing yourself with TradingView's capabilities here: https://www.tradingview.com/charting-library-docs/latest/getting_started/ +273497041-34665daf-a145-44c5-ab1e-285c34d29bda + Here's a quick rundown of what you can do with our charting feature: * Adjust the time interval and timeline based on your preferred data vendor diff --git a/website/content/pro/main-menu/data-connectors/index.md b/website/content/pro/main-menu/data-connectors/index.md index 985a7a2e786..9e01ac956e7 100644 --- a/website/content/pro/main-menu/data-connectors/index.md +++ b/website/content/pro/main-menu/data-connectors/index.md @@ -21,10 +21,17 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; -273497891-d9436d87-422c-4d73-a81c-bdc746695a28 +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + OpenBB Terminal Pro's Data Connectors are designed to empower teams by allowing them to integrate their own private datasets. This feature enhances the platform's capabilities by providing a seamless experience alongside the data that matters most to you. +273497891-d9436d87-422c-4d73-a81c-bdc746695a28 + We offer three distinct methods for importing your data into the platform. ## No code diff --git a/website/content/pro/main-menu/homepage.md b/website/content/pro/main-menu/homepage.md index f3db2d11afd..0795eadab1b 100644 --- a/website/content/pro/main-menu/homepage.md +++ b/website/content/pro/main-menu/homepage.md @@ -18,10 +18,17 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; -273495206-3e6e9b81-41fd-499a-b026-defe7baab5d7 +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + Welcome to the homepage of OpenBB Terminal Pro, your one-stop hub for all things related to the terminal. +273495206-3e6e9b81-41fd-499a-b026-defe7baab5d7 + Here's what you can find: * **Tutorials**: Step-by-step guides on how to leverage the powerful features of our platform, tailored to specific workflows crafted by our team. diff --git a/website/content/pro/main-menu/news.md b/website/content/pro/main-menu/news.md index 4903ace540d..f69e808ead9 100644 --- a/website/content/pro/main-menu/news.md +++ b/website/content/pro/main-menu/news.md @@ -17,10 +17,17 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; -273495463-5d5ed1cf-f108-469d-9c36-94aa982e6944 +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + Welcome to the News section of OpenBB Terminal Pro. This is your hub for staying updated with the latest financial news and market trends. +273495463-5d5ed1cf-f108-469d-9c36-94aa982e6944 + Our News section is divided into various topics such as Overview, Markets, Economics, Industries, Events, Tech, Politics, Ratings, and Opinion. Each topic further branches into subcategories, allowing you to navigate and explore news articles based on your interests. 273495761-0b5d2ec5-f7e8-43b8-b2bf-36b677a14f7b diff --git a/website/content/pro/widgets/index.md b/website/content/pro/widgets/index.md index 12fc8e16b22..51b3bbf4d7f 100644 --- a/website/content/pro/widgets/index.md +++ b/website/content/pro/widgets/index.md @@ -29,7 +29,6 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - 275681758-87fda536-c62c-4b3b-a6c0-42b4b2a3a3cc ## Upper Tab