From e9e743842a05ca76fdc7f33d9606ff52ed9a7c6b Mon Sep 17 00:00:00 2001 From: Taras <9948629+taraspos@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:12:31 +0000 Subject: [PATCH] Documentation website build fixes (#3) --- docusaurus.config.ts | 9 ++++++--- package.json | 4 ++-- server/redirects.ts | 4 ++-- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 8d90174..acb891a 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -101,8 +101,8 @@ const config: Config = { title: "Teleport", favicon: "/favicon.ico", - url: "https://goteleport.com", - baseUrl: "/", + url: process.env.DOCUSAURUS_CONFIG_URL || "https://goteleport.com", + baseUrl: process.env.DOCUSAURUS_CONFIG_BASE_URL || "/", markdown: { parseFrontMatter: async (params) => { @@ -126,7 +126,6 @@ const config: Config = { defaultLocale: "en", locales: ["en"], }, - plugins: [ [ "@docusaurus/plugin-client-redirects", @@ -146,6 +145,10 @@ const config: Config = { [ "@docusaurus/plugin-content-docs", { + // Host docs on the root page, later it will be exposed on goteleport.com/docs + // next to the website and blog + // https://docusaurus.io/docs/docs-introduction#docs-only-mode + routeBasePath: "/", sidebarPath: "./sidebars.json", lastVersion: latestVersion, versions: getDocusaurusConfigVersionOptions(), diff --git a/package.json b/package.json index 0981f67..4963729 100644 --- a/package.json +++ b/package.json @@ -4,12 +4,12 @@ "private": true, "scripts": { "spellcheck": "bash scripts/check-spelling.sh", - "git-update": "git submodule update --init --remote --progress", + "git-update": "git submodule update --init --remote --progress --depth 1 --single-branch", "prepare-files": "npx vite-node ./scripts/prepare-files.mts", "prepare-sanity-data": "npx vite-node ./scripts/prepare-sanity-data.mts", "docusaurus": "docusaurus", "start": "yarn prepare-files && yarn prepare-sanity-data && docusaurus start", - "build": "yarn git-update && yarn prepare-files && yarn prepare-sanity-data && docusaurus build", + "build": "yarn git-update && yarn prepare-files && yarn prepare-sanity-data && docusaurus build \"$@\"", "swizzle": "docusaurus swizzle", "deploy": "docusaurus deploy", "clear": "docusaurus clear", diff --git a/server/redirects.ts b/server/redirects.ts index 5d2f96e..6535995 100644 --- a/server/redirects.ts +++ b/server/redirects.ts @@ -29,8 +29,8 @@ export const getRedirects = () => { } return { - from: `/docs${redirect.source}`, - to: `/docs${redirect.destination}`, + from: redirect.source, + to: redirect.destination, }; }); };