summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjose-donato <43375532+jose-donato@users.noreply.github.com>2023-04-03 19:55:04 +0100
committerGitHub <noreply@github.com>2023-04-03 14:55:04 -0400
commitd47890cfad64543ed6ae1b3e031e41d9f01653cd (patch)
tree71a31047a542117ccdd574a9080f4dbf067a8d23
parent6fda5b17c239db288ae131d720908fd584a9e3c0 (diff)
Hotfix/docs urls (#4669)
* fix: some url fixes * fix: some url fixes
-rw-r--r--openbb_terminal/terminal_helper.py46
-rw-r--r--website/content/bot/Installation/installation.md17
-rw-r--r--website/content/bot/guides/_category_.json4
-rw-r--r--website/content/bot/index.md2
-rw-r--r--website/content/bot/usage/_category_.json4
-rw-r--r--website/content/bot/usage/customizing/index.md (renamed from website/content/bot/guides/customizing/index.md)0
-rw-r--r--website/content/bot/usage/customizing/individual.md (renamed from website/content/bot/guides/customizing/individual.md)0
-rw-r--r--website/content/bot/usage/customizing/server.md (renamed from website/content/bot/guides/customizing/server.md)0
-rw-r--r--website/content/bot/usage/discord.md (renamed from website/content/bot/guides/discord.md)0
-rw-r--r--website/content/bot/usage/telegram.md (renamed from website/content/bot/guides/telegram.md)0
-rw-r--r--website/content/sdk/usage/_category_.json4
-rw-r--r--website/content/sdk/usage/guides/_category_.json4
-rw-r--r--website/content/terminal/usage/_category_.json4
-rw-r--r--website/docusaurus.config.js28
-rw-r--r--website/yarn.lock68
15 files changed, 100 insertions, 81 deletions
diff --git a/openbb_terminal/terminal_helper.py b/openbb_terminal/terminal_helper.py
index e03845ca9ad..e0f3116d893 100644
--- a/openbb_terminal/terminal_helper.py
+++ b/openbb_terminal/terminal_helper.py
@@ -134,55 +134,62 @@ def open_openbb_documentation(
"""Opens the documentation page based on your current location within the terminal. Make exceptions for menus
that are considered 'common' by adjusting the path accordingly."""
if path == "/" and command is None:
- path = "/guides"
+ path = "/usage?path=/usage/basics"
command = ""
elif "keys" in path:
- path = "/usage?full=1&path=/guides/api-keys"
+ path = "/usage?path=/usage/guides/api-keys"
command = ""
elif "settings" in path:
- path = "/usage?path=/guides/customizing-the-terminal"
+ path = "/usage?path=/usage/guides/customizing-the-terminal"
command = ""
elif "featflags" in path:
- path = "/usage?path=/guides/customizing-the-terminal"
+ path = "/usage?path=/usage/guides/customizing-the-terminal#using-the-feature-flags-menu"
command = ""
elif "sources" in path:
- path = "/usage?path=/guides/changing-sources"
+ path = "/usage?path=/usage/guides/changing-sources"
command = ""
- elif "params" in path:
- path = "/usage?path=/intros/portfolio/po"
+ elif "account" in path:
+ path = "/usage?path=/usage/guides/basics"
command = ""
else:
if arg_type == "command": # user passed a command name
- path = f"/reference?path={path}"
+ if command in ["settings", "featflags"]:
+ path = "/usage?path=/usage/guides/customizing-the-terminal"
+ command = ""
+ else:
+ path = f"/reference?path={path}"
elif arg_type == "menu": # user passed a menu name
if command in ["ta", "ba", "qa"]:
menu = path.split("/")[-2]
- path = f"/usage?path=/intros/common/{menu}"
+ path = f"/usage?path=/usage/intros/common/{menu}"
elif command == "forecast":
command = ""
- path = "/usage?path=/intros/forecast"
+ path = "/usage?path=/usage/intros/forecast"
else:
- path = f"/usage?path=/intros/{path}"
+ path = f"/usage?path=/usage/intros/{path}"
else: # user didn't pass argument and is in a menu
menu = path.split("/")[-2]
path = (
- f"/usage?path=/intros/common/{menu}"
+ f"/usage?path=/usage/intros/common/{menu}"
if menu in ["ta", "ba", "qa"]
- else f"/usage?path=/intros/{path}"
+ else f"/usage?path=/usage/intros/{path}"
)
if command:
if command == "keys":
- path = "/usage?full=1&path=/guides/api-keys"
+ path = "/usage?path=/usage/guides/api-keys"
command = ""
elif "settings" in path or "featflags" in path:
- path = "/usage?path=/guides/customizing-the-terminal"
+ path = "/usage?path=/usage/guides/customizing-the-terminal"
command = ""
elif "sources" in path:
- path = "/usage?path=/guides/changing-sources"
+ path = "/usage?path=/usage/guides/changing-sources"
command = ""
elif command in ["record", "stop", "exe"]:
- path = "/usage?path=/guides/scripts-and-routines"
+ path = "/usage?path=/usage/guides/scripts-and-routines"
+ command = ""
+ elif command == "sources":
+ path = "/usage?path=/usage/guides/changing-sources"
command = ""
elif command in [
"intro",
@@ -192,11 +199,12 @@ def open_openbb_documentation(
"update",
"wiki",
"news",
+ "account",
]:
- path = "/guides"
+ path = "/usage"
command = ""
elif command in ["ta", "ba", "qa"]:
- path = f"/guides?path=/intros/common/{command}"
+ path = f"/usage?path=/usage/intros/common/{command}"
command = ""
path += command
diff --git a/website/content/bot/Installation/installation.md b/website/content/bot/Installation/installation.md
deleted file mode 100644
index 036199b1493..00000000000
--- a/website/content/bot/Installation/installation.md
+++ /dev/null
@@ -1,17 +0,0 @@
----
-title: Installation
-sidebar_position: 1
-description: How to get started with OpenBB Discord Bot
-keywords: [installation, install, install openbb bot, guide, how to, explanation, openbb bot, openbb, discord]
----
-
-import AddBotDialog from "@site/src/components/General/AddBot";
-
-## Adding Bot to your Server
-
-To add the bot to your server click on one of the links for your respective platform and then follow the instructions for the respective platform.
-
-<AddBotDialog
-/>
-
----
diff --git a/website/content/bot/guides/_category_.json b/website/content/bot/guides/_category_.json
deleted file mode 100644
index 4ffdf06c7ce..00000000000
--- a/website/content/bot/guides/_category_.json
+++ /dev/null
@@ -1,4 +0,0 @@
-{
- "label": "Guides",
- "position": 3
-}
diff --git a/website/content/bot/index.md b/website/content/bot/index.md
index 726a8954598..1e816e59349 100644
--- a/website/content/bot/index.md
+++ b/website/content/bot/index.md
@@ -49,7 +49,7 @@ To know more about OpenBB Bot, you can start by reading the [Installation Guide]
### Using OpenBB Bot
-To learn how to use OpenBB Bot, you can start by reading the [Basics Guide](/bot/guides/discord).
+To learn how to use OpenBB Bot, you can start by reading the [Basics Guide](/bot/usage/discord).
### Bot Reference
diff --git a/website/content/bot/usage/_category_.json b/website/content/bot/usage/_category_.json
new file mode 100644
index 00000000000..0365f6c34e4
--- /dev/null
+++ b/website/content/bot/usage/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Usage",
+ "position": 3
+}
diff --git a/website/content/bot/guides/customizing/index.md b/website/content/bot/usage/customizing/index.md
index fd8d3f6b437..fd8d3f6b437 100644
--- a/website/content/bot/guides/customizing/index.md
+++ b/website/content/bot/usage/customizing/index.md
diff --git a/website/content/bot/guides/customizing/individual.md b/website/content/bot/usage/customizing/individual.md
index 92c63a23d42..92c63a23d42 100644
--- a/website/content/bot/guides/customizing/individual.md
+++ b/website/content/bot/usage/customizing/individual.md
diff --git a/website/content/bot/guides/customizing/server.md b/website/content/bot/usage/customizing/server.md
index 9f9ea5cf1e1..9f9ea5cf1e1 100644
--- a/website/content/bot/guides/customizing/server.md
+++ b/website/content/bot/usage/customizing/server.md
diff --git a/website/content/bot/guides/discord.md b/website/content/bot/usage/discord.md
index dd56f571ba8..dd56f571ba8 100644
--- a/website/content/bot/guides/discord.md
+++ b/website/content/bot/usage/discord.md
diff --git a/website/content/bot/guides/telegram.md b/website/content/bot/usage/telegram.md
index d38de69cdd8..d38de69cdd8 100644
--- a/website/content/bot/guides/telegram.md
+++ b/website/content/bot/usage/telegram.md
diff --git a/website/content/sdk/usage/_category_.json b/website/content/sdk/usage/_category_.json
index 82e09efaafd..e640b5c8a9c 100644
--- a/website/content/sdk/usage/_category_.json
+++ b/website/content/sdk/usage/_category_.json
@@ -1,4 +1,4 @@
{
- "label": "Guides",
- "position": 2
+ "label": "Usage",
+ "position": 2
}
diff --git a/website/content/sdk/usage/guides/_category_.json b/website/content/sdk/usage/guides/_category_.json
index 82e09efaafd..e79050872b4 100644
--- a/website/content/sdk/usage/guides/_category_.json
+++ b/website/content/sdk/usage/guides/_category_.json
@@ -1,4 +1,4 @@
{
- "label": "Guides",
- "position": 2
+ "label": "Guides",
+ "position": 2
}
diff --git a/website/content/terminal/usage/_category_.json b/website/content/terminal/usage/_category_.json
index 82e09efaafd..e640b5c8a9c 100644
--- a/website/content/terminal/usage/_category_.json
+++ b/website/content/terminal/usage/_category_.json
@@ -1,4 +1,4 @@
{
- "label": "Guides",
- "position": 2
+ "label": "Usage",
+ "position": 2
}
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
index 1be81d021ce..3434830c719 100644
--- a/website/docusaurus.config.js
+++ b/website/docusaurus.config.js
@@ -37,6 +37,34 @@ const config = {
from: "/terminal/usage/intros/forecasting",
to: "/terminal/usage/intros/forecast",
},
+ {
+ from: "/terminal/quickstart/api-keys",
+ to: "/terminal/usage/guides/api-keys",
+ },
+ {
+ from: "/terminal/guides/advanced/data",
+ to: "/terminal/usage/guides/data",
+ },
+ {
+ from: "/terminal/guides/advanced/scripts-and-routines",
+ to: "/terminal/usage/guides/scripts-and-routines",
+ },
+ {
+ from: "/terminal/guides/basics",
+ to: "/terminal/usage/basics",
+ },
+ {
+ from: "/terminal/guides/intros/portfolio",
+ to: "/terminal/usage/intros/portfolio",
+ },
+ {
+ from: "/terminal/quickstart/installation",
+ to: "/terminal/installation",
+ },
+ {
+ from: "/sdk/quickstart/installation",
+ to: "/sdk/installation",
+ },
],
},
],
diff --git a/website/yarn.lock b/website/yarn.lock
index cdcec7283b0..a68366ed406 100644
--- a/website/yarn.lock
+++ b/website/yarn.lock
@@ -334,11 +334,6 @@
"resolved" "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.10.4.tgz"
"version" "7.10.4"
-"@babel/helper-plugin-utils@7.10.4":
- version "7.10.4"
- resolved "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.10.4.tgz"
- integrity sha512-O4KCvQA6lLiMU9l2eawBPMf1xPP8xPfB3iEQw150hOVTqj/rfXz0ThTb4HEzqQfs2Bmo5Ay8BzxfzVtBrr9dVg==
-
"@babel/helper-remap-async-to-generator@^7.18.9":
"integrity" "sha512-dI7q50YKd8BAv3VEfgg7PS7yD3Rtbi2J1XMXaalXO0W0164hYLnh8zpjRS0mte9MfVp/tltvr/cfdXPvJr1opA=="
"resolved" "https://registry.npmjs.org/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.18.9.tgz"
@@ -1824,9 +1819,9 @@
"@radix-ui/react-primitive" "1.0.1"
"@radix-ui/react-arrow@1.0.2":
- version "1.0.2"
- resolved "https://registry.npmjs.org/@radix-ui/react-arrow/-/react-arrow-1.0.2.tgz"
- integrity sha512-fqYwhhI9IarZ0ll2cUSfKuXHlJK0qE4AfnRrPBbRwEH/4mGQn04/QFGomLi8TXWIdv9WJk//KgGm+aDxVIr1wA==
+ "integrity" "sha512-fqYwhhI9IarZ0ll2cUSfKuXHlJK0qE4AfnRrPBbRwEH/4mGQn04/QFGomLi8TXWIdv9WJk//KgGm+aDxVIr1wA=="
+ "resolved" "https://registry.npmjs.org/@radix-ui/react-arrow/-/react-arrow-1.0.2.tgz"
+ "version" "1.0.2"
dependencies:
"@babel/runtime" "^7.13.10"
"@radix-ui/react-primitive" "1.0.2"
@@ -1846,9 +1841,9 @@
"@babel/runtime" "^7.13.10"
"@radix-ui/react-dialog@^1.0.2":
- version "1.0.2"
- resolved "https://registry.npmjs.org/@radix-ui/react-dialog/-/react-dialog-1.0.2.tgz"
- integrity sha512-EKxxp2WNSmUPkx4trtWNmZ4/vAYEg7JkAfa1HKBUnaubw9eHzf1Orr9B472lJYaYz327RHDrd4R95fsw7VR8DA==
+ "integrity" "sha512-EKxxp2WNSmUPkx4trtWNmZ4/vAYEg7JkAfa1HKBUnaubw9eHzf1Orr9B472lJYaYz327RHDrd4R95fsw7VR8DA=="
+ "resolved" "https://registry.npmjs.org/@radix-ui/react-dialog/-/react-dialog-1.0.2.tgz"
+ "version" "1.0.2"
dependencies:
"@babel/runtime" "^7.13.10"
"@radix-ui/primitive" "1.0.0"
@@ -1863,8 +1858,8 @@
"@radix-ui/react-primitive" "1.0.1"
"@radix-ui/react-slot" "1.0.1"
"@radix-ui/react-use-controllable-state" "1.0.0"
- aria-hidden "^1.1.1"
- react-remove-scroll "2.5.5"
+ "aria-hidden" "^1.1.1"
+ "react-remove-scroll" "2.5.5"
"@radix-ui/react-dismissable-layer@1.0.2":
"integrity" "sha512-WjJzMrTWROozDqLB0uRWYvj4UuXsM/2L19EmQ3Au+IJWqwvwq9Bwd+P8ivo0Deg9JDPArR1I6MbWNi1CmXsskg=="
@@ -1879,9 +1874,9 @@
"@radix-ui/react-use-escape-keydown" "1.0.2"
"@radix-ui/react-dismissable-layer@1.0.3":
- version "1.0.3"
- resolved "https://registry.npmjs.org/@radix-ui/react-dismissable-layer/-/react-dismissable-layer-1.0.3.tgz"
- integrity sha512-nXZOvFjOuHS1ovumntGV7NNoLaEp9JEvTht3MBjP44NSW5hUKj/8OnfN3+8WmB+CEhN44XaGhpHoSsUIEl5P7Q==
+ "integrity" "sha512-nXZOvFjOuHS1ovumntGV7NNoLaEp9JEvTht3MBjP44NSW5hUKj/8OnfN3+8WmB+CEhN44XaGhpHoSsUIEl5P7Q=="
+ "resolved" "https://registry.npmjs.org/@radix-ui/react-dismissable-layer/-/react-dismissable-layer-1.0.3.tgz"
+ "version" "1.0.3"
dependencies:
"@babel/runtime" "^7.13.10"
"@radix-ui/primitive" "1.0.0"
@@ -1955,9 +1950,9 @@
"@radix-ui/rect" "1.0.0"
"@radix-ui/react-popper@1.1.1":
- version "1.1.1"
- resolved "https://registry.npmjs.org/@radix-ui/react-popper/-/react-popper-1.1.1.tgz"
- integrity sha512-keYDcdMPNMjSC8zTsZ8wezUMiWM9Yj14wtF3s0PTIs9srnEPC9Kt2Gny1T3T81mmSeyDjZxsD9N5WCwNNb712w==
+ "integrity" "sha512-keYDcdMPNMjSC8zTsZ8wezUMiWM9Yj14wtF3s0PTIs9srnEPC9Kt2Gny1T3T81mmSeyDjZxsD9N5WCwNNb712w=="
+ "resolved" "https://registry.npmjs.org/@radix-ui/react-popper/-/react-popper-1.1.1.tgz"
+ "version" "1.1.1"
dependencies:
"@babel/runtime" "^7.13.10"
"@floating-ui/react-dom" "0.7.2"
@@ -1980,9 +1975,9 @@
"@radix-ui/react-primitive" "1.0.1"
"@radix-ui/react-portal@1.0.2":
- version "1.0.2"
- resolved "https://registry.npmjs.org/@radix-ui/react-portal/-/react-portal-1.0.2.tgz"
- integrity sha512-swu32idoCW7KA2VEiUZGBSu9nB6qwGdV6k6HYhUoOo3M1FFpD+VgLzUqtt3mwL1ssz7r2x8MggpLSQach2Xy/Q==
+ "integrity" "sha512-swu32idoCW7KA2VEiUZGBSu9nB6qwGdV6k6HYhUoOo3M1FFpD+VgLzUqtt3mwL1ssz7r2x8MggpLSQach2Xy/Q=="
+ "resolved" "https://registry.npmjs.org/@radix-ui/react-portal/-/react-portal-1.0.2.tgz"
+ "version" "1.0.2"
dependencies:
"@babel/runtime" "^7.13.10"
"@radix-ui/react-primitive" "1.0.2"
@@ -2005,9 +2000,9 @@
"@radix-ui/react-slot" "1.0.1"
"@radix-ui/react-primitive@1.0.2":
- version "1.0.2"
- resolved "https://registry.npmjs.org/@radix-ui/react-primitive/-/react-primitive-1.0.2.tgz"
- integrity sha512-zY6G5Qq4R8diFPNwtyoLRZBxzu1Z+SXMlfYpChN7Dv8gvmx9X3qhDqiLWvKseKVJMuedFeU/Sa0Sy/Ia+t06Dw==
+ "integrity" "sha512-zY6G5Qq4R8diFPNwtyoLRZBxzu1Z+SXMlfYpChN7Dv8gvmx9X3qhDqiLWvKseKVJMuedFeU/Sa0Sy/Ia+t06Dw=="
+ "resolved" "https://registry.npmjs.org/@radix-ui/react-primitive/-/react-primitive-1.0.2.tgz"
+ "version" "1.0.2"
dependencies:
"@babel/runtime" "^7.13.10"
"@radix-ui/react-slot" "1.0.1"
@@ -2021,9 +2016,9 @@
"@radix-ui/react-compose-refs" "1.0.0"
"@radix-ui/react-tooltip@^1.0.5":
- version "1.0.5"
- resolved "https://registry.npmjs.org/@radix-ui/react-tooltip/-/react-tooltip-1.0.5.tgz"
- integrity sha512-cDKVcfzyO6PpckZekODJZDe5ZxZ2fCZlzKzTmPhe4mX9qTHRfLcKgqb0OKf22xLwDequ2tVleim+ZYx3rabD5w==
+ "integrity" "sha512-cDKVcfzyO6PpckZekODJZDe5ZxZ2fCZlzKzTmPhe4mX9qTHRfLcKgqb0OKf22xLwDequ2tVleim+ZYx3rabD5w=="
+ "resolved" "https://registry.npmjs.org/@radix-ui/react-tooltip/-/react-tooltip-1.0.5.tgz"
+ "version" "1.0.5"
dependencies:
"@babel/runtime" "^7.13.10"
"@radix-ui/primitive" "1.0.0"
@@ -2086,9 +2081,9 @@
"@radix-ui/react-use-layout-effect" "1.0.0"
"@radix-ui/react-visually-hidden@1.0.2":
- version "1.0.2"
- resolved "https://registry.npmjs.org/@radix-ui/react-visually-hidden/-/react-visually-hidden-1.0.2.tgz"
- integrity sha512-qirnJxtYn73HEk1rXL12/mXnu2rwsNHDID10th2JGtdK25T9wX+mxRmGt7iPSahw512GbZOc0syZX1nLQGoEOg==
+ "integrity" "sha512-qirnJxtYn73HEk1rXL12/mXnu2rwsNHDID10th2JGtdK25T9wX+mxRmGt7iPSahw512GbZOc0syZX1nLQGoEOg=="
+ "resolved" "https://registry.npmjs.org/@radix-ui/react-visually-hidden/-/react-visually-hidden-1.0.2.tgz"
+ "version" "1.0.2"
dependencies:
"@babel/runtime" "^7.13.10"
"@radix-ui/react-primitive" "1.0.2"
@@ -4399,6 +4394,11 @@
"resolved" "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz"
"version" "1.1.1"
+"fuse.js@^6.6.2":
+ "integrity" "sha512-cJaJkxCCxC8qIIcPBF9yGxY0W/tVZS3uEISDxhYIdtk8OL93pe+6Zj7LjCqVV4dzbqcriOZ+kQ/NE4RXZHsIGA=="
+ "resolved" "https://registry.npmjs.org/fuse.js/-/fuse.js-6.6.2.tgz"
+ "version" "6.6.2"
+
"gensync@^1.0.0-beta.1", "gensync@^1.0.0-beta.2":
"integrity" "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg=="
"resolved" "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz"
@@ -8091,9 +8091,9 @@
"version" "3.2.3"
"webpack@^4.0.0 || ^5.0.0", "webpack@^4.37.0 || ^5.0.0", "webpack@^5.0.0", "webpack@^5.1.0", "webpack@^5.20.0", "webpack@^5.73.0", "webpack@>= 4", "webpack@>=2", "webpack@>=4.41.1 || 5.x", "webpack@3 || 4 || 5":
- "integrity" "sha512-piaIaoVJlqMsPtX/+3KTTO6jfvrSYgauFVdt8cr9LTHKmcq/AMd4mhzsiP7ZF/PGRNPGA8336jldh9l2Kt2ogQ=="
- "resolved" "https://registry.npmjs.org/webpack/-/webpack-5.75.0.tgz"
- "version" "5.75.0"
+ "integrity" "sha512-Th05ggRm23rVzEOlX8y67NkYCHa9nTNcwHPBhdg+lKG+mtiW7XgggjAeeLnADAe7mLjJ6LUNfgHAuRRh+Z6J7w=="
+ "resolved" "https://registry.npmjs.org/webpack/-/webpack-5.76.2.tgz"
+ "version" "5.76.2"
dependencies:
"@types/eslint-scope" "^3.7.3"
"@types/estree" "^0.0.51"