Fix issues with docs website (#876)

* Fix issues with docs website Closes #732 Closes #797 These issues come from the fact that we have custom code for the sidebar This custom code adds a logo (I moved that to the header) + algolia search (not very useful IMO, just search the github repo) * Hide helper .mdx files
grafana · Jun 7, 2023 · a474f0f · a474f0f
1 parent 709b149
commit a474f0f
Show file tree

Hide file tree

Showing 20 changed files with 1,837 additions and 1,739 deletions.
diff --git a/docs/algolia.json b/docs/algolia.json
diff --git a/docs/docs/installation.mdx b/docs/docs/installation.mdx
@@ -5,7 +5,7 @@ route: /install
 
 import { PlatformInstall, Tanka, Jb } from "../src/components/install"
 
-# Installing Tanka
+# Installation
 
 Tanka is distributed as a single binary called `tk`. It already includes the Jsonnet compiler, but requires some tools to be available:
 
@@ -20,6 +20,9 @@ Tanka is distributed as a single binary called `tk`. It already includes the Jso
   support](/helm)
 
 <br />
+
+## Tanka
+
 <PlatformInstall elems={Tanka} def="macOS" />
 
 ## Jsonnet Bundler

diff --git a/docs/gatsby-config.js b/docs/gatsby-config.js
@@ -61,10 +61,5 @@ module.exports = {
         precachePages: [`/`, `/install`, `/tutorial/overview`],
       },
     },
-
-    {
-      resolve: `gatsby-plugin-algolia-docsearch`,
-      options: require("./algolia.json"),
-    },
   ],
 }
diff --git a/docs/package.json b/docs/package.json
@@ -9,7 +9,6 @@
     "docz": "^2.4.0",
     "gatsby": "^2.0.0",
     "gatsby-image": "^3.11.0",
-    "gatsby-plugin-algolia-docsearch": "^1.0.5",
     "gatsby-plugin-catch-links": "^2.1.21",
     "gatsby-plugin-manifest": "^2.2.34",
     "gatsby-plugin-offline": "^3.0.30",

diff --git a/docs/src/components/home/snippet.mdx b/docs/src/components/home/snippet.mdx
@@ -1,3 +1,7 @@
+---
+hidden: true
+---
+
 ```jsonnet
 local k = import "k.libsonnet";
 

diff --git a/docs/src/components/install/jb/arch.mdx b/docs/src/components/install/jb/arch.mdx
@@ -1,3 +1,7 @@
+---
+hidden: true
+---
+
 On ArchLinux, install using the [`jsonnet-bundler-bin`](https://aur.archlinux.org/packages/jsonnet-bundler-bin/) AUR package:
 
 ```

diff --git a/docs/src/components/install/jb/binary.mdx b/docs/src/components/install/jb/binary.mdx
@@ -1,3 +1,7 @@
+---
+hidden: true
+---
+
 The `jb` binary is primarily distributed using [GitHub releases](https://github.com/jsonnet-bundler/jsonnet-bundler/releases).
 
 #### Linux, macOS

diff --git a/docs/src/components/install/jb/go.mdx b/docs/src/components/install/jb/go.mdx
@@ -1,3 +1,7 @@
+---
+hidden: true
+---
+
 If you happen to have a local [Go](https://golang.org) toolchain available, you can build from source using `go install`:
 
 ```bash

diff --git a/docs/src/components/install/jb/osx.mdx b/docs/src/components/install/jb/osx.mdx
@@ -1,3 +1,7 @@
+---
+hidden: true
+---
+
 On macOS, Jsonnet Bundler is best installed using [`brew`](https://brew.sh):
 
 ```bash

diff --git a/docs/src/components/install/tk/arch.mdx b/docs/src/components/install/tk/arch.mdx
@@ -1,3 +1,7 @@
+---
+hidden: true
+---
+
 We maintain two AUR packages, one building [from
 source](https://aur.archlinux.org/packages/tanka/) and another one using a
 [pre-compiled binary](https://aur.archlinux.org/packages/tanka-bin/).

diff --git a/docs/src/components/install/tk/binary.mdx b/docs/src/components/install/tk/binary.mdx
@@ -1,3 +1,7 @@
+---
+hidden: true
+---
+
 For all other operating systems, we provide pre-compiled binaries for Tanka at
 [GitHub Releases](https://github.com/grafana/tanka/releases).
 

diff --git a/docs/src/components/install/tk/go.mdx b/docs/src/components/install/tk/go.mdx
@@ -1,3 +1,7 @@
+---
+hidden: true
+---
+
 If you happen to have a local [Go](https://golang.org) toolchain, you can also build Tanka from source using `go install`:
 
 ```bash

diff --git a/docs/src/components/install/tk/osx.mdx b/docs/src/components/install/tk/osx.mdx
@@ -1,3 +1,7 @@
+---
+hidden: true
+---
+
 On macOS, Tanka is best installed using [`brew`](https://brew.sh):
 
 ```bash

diff --git a/docs/src/gatsby-theme-docz/base/Layout.js b/docs/src/gatsby-theme-docz/base/Layout.js
diff --git a/docs/src/gatsby-theme-docz/components/Header/index.js b/docs/src/gatsby-theme-docz/components/Header/index.js
diff --git a/docs/src/gatsby-theme-docz/components/Logo/index.js b/docs/src/gatsby-theme-docz/components/Logo/index.js
@@ -3,23 +3,27 @@ import * as styles from "gatsby-theme-docz/src/components/Logo/styles"
 /** @jsx jsx */
 import { Flex, jsx } from "theme-ui"
 import { Link, useConfig } from "docz"
+import logo from '../../../../img/logo.svg'
 
 export const Logo = () => {
-  const config = useConfig()
-  return (
-    <Flex alignItems="center" sx={styles.logo} data-testid="logo">
-      <Link
-        to="/"
-        sx={{
-          ...styles.link,
-          display: "flex",
-          flexDirection: "column",
-          lineHeight: "1.2",
-        }}
-      >
-        <span>Grafana Tanka</span>
-        <span sx={{ fontSize: "0.7em" }}>{config.description}</span>
-      </Link>
-    </Flex>
-  )
+    const config = useConfig()
+    return (
+        <Flex alignItems="center" sx={styles.logo} data-testid="logo">
+            <Link
+                to="/"
+                sx={{
+                    ...styles.link,
+                    display: "flex",
+                    flexDirection: "column",
+                    lineHeight: "1.2",
+                }}
+            >
+                <div sx={{ display: 'inline-block' }}>
+                    <img src={logo} alt="That's my logo" sx={{ maxHeight: "1.2em", marginRight: '0.2em', display: 'inline-block', float: 'left' }} />
+                    <span sx={{ display: 'inline-block' }}>Grafana Tanka</span>
+                    <span sx={{ fontSize: "0.7em", display: 'block' }}>{config.description}</span>
+                </div>
+            </Link>
+        </Flex>
+    )
 }
diff --git a/docs/src/gatsby-theme-docz/components/Sidebar/algolia.js b/docs/src/gatsby-theme-docz/components/Sidebar/algolia.js