doc: Fix broken doc links (#476)

bentoml · Jun 12, 2023 · 29e2d70 · 29e2d70
1 parent 37f95d2
commit 29e2d70
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 20 deletions.
diff --git a/dashboard/src/components/BaseSidebar.tsx b/dashboard/src/components/BaseSidebar.tsx
@@ -243,7 +243,7 @@ export default function BaseSidebar({ navItems, style, title, icon, settingsPath
                 </div>
                 <div style={bottomItemStyle}>
                     <CgFileDocument />
-                    <Link href='https://docs.bentoml.org/projects/yatai' target='_blank'>
+                    <Link href='https://docs.yatai.io' target='_blank'>
                         {t('docs')}
                     </Link>
                 </div>

diff --git a/dashboard/src/components/BentoRepositoryListCard.tsx b/dashboard/src/components/BentoRepositoryListCard.tsx
@@ -484,10 +484,7 @@ export default function BentoRepositoryListCard() {
                     <div>
                         <p>
                             1. {t('Follow to [BentoML quickstart guide] to create your first Bento. prefix')}
-                            <Link
-                                href='https://docs.bentoml.org/en/latest/quickstart.html#getting-started-page'
-                                target='_blank'
-                            >
+                            <Link href='https://docs.bentoml.org/en/latest/tutorial.html' target='_blank'>
                                 {t('BentoML quickstart guide')}
                             </Link>
                             {t('Follow to [BentoML quickstart guide] to create your first Bento. suffix')}

diff --git a/dashboard/src/components/ModelFlatListCard.tsx b/dashboard/src/components/ModelFlatListCard.tsx
@@ -216,10 +216,7 @@ export default function ModelFlatListCard() {
                     <div>
                         <p>
                             1. {t('Follow to [BentoML quickstart guide] to create your first Model. prefix')}
-                            <Link
-                                href='https://docs.bentoml.org/en/latest/quickstart.html#getting-started-page'
-                                target='_blank'
-                            >
+                            <Link href='https://docs.bentoml.org/en/latest/tutorial.html' target='_blank'>
                                 {t('BentoML quickstart guide')}
                             </Link>
                             {t('Follow to [BentoML quickstart guide] to create your first Model. suffix')}

diff --git a/docs/README.md b/docs/README.md
@@ -3,7 +3,7 @@
 ## A guide for docs contributors
 
 The `docs` directory contains the sphinx source text for Yatai docs, visit
-http://docs.bentoml.org/ to read the full documentation.
+https://docs.yatai.io/ to read the full documentation.
 
 This guide is made for anyone who's interested in running BentoML documentation locally,
 making changes to it and make contributions. BentoML is made by the thriving community

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -7,7 +7,13 @@
 copyright = f"2022-{datetime.now().year}, bentoml.com"
 author = "bentoml.com"
 
-version = subprocess.check_output(['sh', '-c', "git describe --tags `git rev-list --tags --max-count=1`"]).decode('utf-8').strip()[1:]
+version = (
+    subprocess.check_output(
+        ["sh", "-c", "git describe --tags `git rev-list --tags --max-count=1`"]
+    )
+    .decode("utf-8")
+    .strip()[1:]
+)
 
 # -- General configuration ---------------------------------------------------
 
@@ -48,7 +54,7 @@
 autosectionlabel_maxdepth = 10
 
 ogp_site_url = "http://docs.bentoml.org"
-ogp_image = "https://docs.bentoml.org/en/latest/_images/bentoml-banner.png"
+ogp_image = "https://docs.bentoml.org/en/latest/_static/img/bentoml-banner.png"
 ogp_site_name = "BentoML Documentation"
 ogp_use_first_image = True
 
@@ -110,13 +116,11 @@
 # mock any heavy imports, eg: imports from frameworks library
 autodoc_mock_imports = []
 
-linkcheck_ignore = [
-  "https://github.com/kubernetes-sigs/metrics-server#installation"
-]
+linkcheck_ignore = ["https://github.com/kubernetes-sigs/metrics-server#installation"]
 linkcheck_allowed_redirects = {
-  r"http[s]://docs\.aws\.amazon\.com/.*": r"http[s]://docs\.aws\.amazon\.com/.*",
-  r"http[s]://docs\.bentoml\.org/.*": r"http[s]://docs\.bentoml\.org/en/latest/.*",
-  r"http[s]://docs\.yatai\.io/.*": r"http[s]://docs\.yatai\.io/en/latest/.*",
-  r"http://modelserving\.com(/.*)?": r"https://modelserving\.com/.*",
-  r"https://l\.linklyhq\.com/.*": r"https://bentoml\.slack\.com/.*",
+    r"http[s]://docs\.aws\.amazon\.com/.*": r"http[s]://docs\.aws\.amazon\.com/.*",
+    r"http[s]://docs\.bentoml\.org/.*": r"http[s]://docs\.bentoml\.org/en/latest/.*",
+    r"http[s]://docs\.yatai\.io/.*": r"http[s]://docs\.yatai\.io/en/latest/.*",
+    r"http://modelserving\.com(/.*)?": r"https://modelserving\.com/.*",
+    r"https://l\.linklyhq\.com/.*": r"https://bentoml\.slack\.com/.*",
 }