Merge branch 'travis.rodgers/docs-homepage-header' into aatuvai/docs-top-nav

Author: aatuvai

.github/workflows/codeql.yml

@@ -31,11 +31,11 @@ jobs:
       uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@d6bbdef45e766d081b84a2def353b0055f728d3e # v3.29.3
+      uses: github/codeql-action/init@51f77329afa6477de8c49fc9c7046c15b9a4e79d # v3.29.5
       with:
         languages: ${{ matrix.language }}
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@d6bbdef45e766d081b84a2def353b0055f728d3e # v3.29.3
+      uses: github/codeql-action/analyze@51f77329afa6477de8c49fc9c7046c15b9a4e79d # v3.29.5
       with:
         category: "/language:${{matrix.language}}"

.github/workflows/test.yaml

@@ -26,3 +26,5 @@ jobs:
         # make sure this hasn't happened.
       - name: Run the docs formatting linter
         run: scripts/lint-test.sh
+      - name: Check source formatting
+        run: npx prettier --check

.gitmodules

@@ -4,8 +4,8 @@
 	branch = branch/v16
 [submodule "content/17.x"]
 	path = content/17.x
-	url = https://github.com/aatuvai/teleport/
-	branch = aatuvai/docs-header
+	url = https://github.com/gravitational/teleport/
+	branch = branch/v17
 [submodule "content/18.x"]
 	path = content/18.x
 	url = https://github.com/gravitational/teleport

.prettierignore

@@ -0,0 +1,18 @@
+server/fixtures/*
+storybook-static
+versioned_sidebars
+.remark-build
+node_modules
+.docusaurus
+content
+.storybook
+docs
+.devcontainer
+static
+scripts
+.github
+build
+versioned_docs
+.git
+data
+**.md

.remarkrc.mjs

@@ -7,9 +7,7 @@ import {
   getVersionRootPath,
 } from "./.remark-build/server/docs-helpers.mjs";
 import { loadConfig } from "./.remark-build/server/config-docs.mjs";
-import {
-  updatePathsInIncludes,
-} from "./.remark-build//server/asset-path-helpers.mjs";
+import { updatePathsInIncludes } from "./.remark-build/server/asset-path-helpers.mjs";
 
 const configFix = {
   settings: {

docusaurus.config.ts

@@ -178,12 +178,10 @@ const config: Config = {
       {
         svgrConfig: {
           svgoConfig: {
-            plugins: [
-              "prefixIds"
-            ],
+            plugins: ["prefixIds"],
           },
         },
-      }
+      },
     ],
     [
       "@docusaurus/plugin-content-docs",
@@ -218,7 +216,7 @@ const config: Config = {
 
           return orderSidebarItems(
             removeRedundantItems(items, item.dirName),
-            getDocPageByID
+            getDocPageByID,
           );
         },
         // Host docs on the root page, later it will be exposed on goteleport.com/docs

package.json

@@ -52,7 +52,7 @@
     "@docusaurus/plugin-svgr": "^3.8.1",
     "@docusaurus/theme-classic": "^3.8.1",
     "@docusaurus/tsconfig": "^3.8.1",
-    "@inkeep/cxkit-react": "^0.5.95",
+    "@inkeep/cxkit-react": "^0.5.96",
     "@mdx-js/react": "^3.0.0",
     "classnames": "^2.3.1",
     "clsx": "^2.1.1",
@@ -101,6 +101,7 @@
     "micromark-extension-mdxjs": "^3.0.0",
     "postcss": "^8.5.6",
     "postcss-loader": "^8.1.1",
+    "prettier": "^3.6.2",
     "rehype-stringify": "^10.0.1",
     "remark-cli": "10.0.1",
     "remark-copy-linked-files": "^1.5.0",
@@ -111,17 +112,17 @@
     "remark-validate-links": "^11.0.2",
     "storybook": "^8.6.14",
     "to-vfile": "^8.0.0",
-    "ts-jest": "^29.4.0",
+    "ts-jest": "^29.4.1",
     "ts-loader": "^9.5.2",
     "tsc-esm-fix": "^3.1.0",
-    "typescript": "~5.8.3",
+    "typescript": "~5.9.2",
     "unified": "^11.0.5",
     "unified-lint-rule": "^3.0.0",
     "unist": "^0.0.1",
     "unist-util-find": "^3.0.0",
     "unist-util-visit-parents": "^6.0.1",
     "vfile": "^6.0.1",
-    "wait-on": "^8.0.2"
+    "wait-on": "^8.0.4"
   },
   "browserslist": {
     "production": [

server/config-common.ts

@@ -6,7 +6,7 @@ import { ValidateFunction } from "ajv";
 
 export const validateConfig = <T = Record<string, unknown>>(
   validator: ValidateFunction,
-  config: T
+  config: T,
 ) => {
   if (!validator(config)) {
     console.error(validator.errors);

server/config-docs.ts

@@ -144,7 +144,7 @@ export const normalizeDocsUrl = (version: string, url: string) => {
 
 const normalizeRedirects = (
   version: string,
-  redirects: Redirect[]
+  redirects: Redirect[],
 ): Redirect[] => {
   return redirects.map((redirect) => {
     return {

server/config-site.ts

@@ -92,9 +92,7 @@ export const getLatestVersion = () => {
 export const getCurrentVersion = () => {
   const versions = getSupportedVersions();
 
-  return (
-    versions[versions.length - 1]
-  ).name;
+  return versions[versions.length - 1].name;
 };
 
 /* Returns version options for docusaurus.config.js */