site: update docusaurus and unbreak the documentation site

estuary · Feb 20, 2024 · 2dd3bdc · 2dd3bdc
1 parent 7a29fb3
commit 2dd3bdc
Show file tree

Hide file tree

Showing 8 changed files with 5,376 additions and 6,568 deletions.
diff --git a/site/docs/concepts/advanced/evolutions.md b/site/docs/concepts/advanced/evolutions.md
@@ -19,6 +19,7 @@ To keep things simple in this article, we'll be referring only to captures and m
 :::
 
 import Mermaid from '@theme/Mermaid';
+
 <Mermaid chart={`
   graph LR;
     Source[Source System]-->Capture;

diff --git a/site/docs/reference/Connectors/capture-connectors/zendesk-support.md b/site/docs/reference/Connectors/capture-connectors/zendesk-support.md
@@ -54,7 +54,7 @@ See [connectors](../../../concepts/connectors.md#using-connectors) to learn more
 | `/credentials/credentials` | Credentials method | Type of credentials used. Set to `api-token` | string |  |
 | `/credentials/email` | Email | The user email for your Zendesk account. | string |  |
 | **`/start_date`** | Start Date | The date from which you&#x27;d like to replicate data for Zendesk Support API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. | string | Required |
-| **`/subdomain`** | Subdomain | This is your Zendesk subdomain that can be found in your account URL. For example, in https:&#x2F;&#x2F;{MY&#x5F;SUBDOMAIN}.zendesk.com&#x2F;, where MY&#x5F;SUBDOMAIN is the value of your subdomain. | string | Required |
+| **`/subdomain`** | Subdomain | This is your Zendesk subdomain that can be found in your account URL. For example, in `https://MY_SUBDOMAIN.zendesk.com/`, where `MY_SUBDOMAIN` is the value of your subdomain. | string | Required |
 
 #### Bindings
 

diff --git a/site/docs/reference/Connectors/materialization-connectors/amazon-redshift.md b/site/docs/reference/Connectors/materialization-connectors/amazon-redshift.md
@@ -102,7 +102,7 @@ For allowing secure connections via SSH tunneling:
 2. Configure your connector as described in the [configuration](#configuration) section above, with
 the additional of the `networkTunnel` stanza to enable the SSH tunnel, if using. See [Connecting to
 endpoints on secure
-networks](../../../concepts/connectors.md#connecting-to-endpoints-on-secure-networks) for additional
+networks](../../../../concepts/connectors/#connecting-to-endpoints-on-secure-networks) for additional
 details and a sample.
 
 ## Naming Conventions
@@ -137,7 +137,7 @@ The maximum size of a single input document is 4 MB. Attempting to materialize c
 documents larger than 4 MB will result in an error. To materialize this data you can use a
 [derivation](../../../concepts/derivations.md) to create a derived collection with smaller
 documents, or exclude fields containing excessive amounts of data by [customizing the materialized
-fields](../../../guides/customize-materialization-fields.md#include-desired-fields-in-your-materialization).
+fields](../../../../guides/customize-materialization-fields/#include-desired-fields-in-your-materialization).
 
 ## Delta updates
 

diff --git a/site/docs/reference/Connectors/materialization-connectors/motherduck.md b/site/docs/reference/Connectors/materialization-connectors/motherduck.md
@@ -75,6 +75,5 @@ materializations:
 
 ## Delta updates
 
-This connector currently supports only [delta
-updates](../../../concepts/materialization.md#delta-updates). Future support for standard updates is
-planned.
+This connector currently supports only [delta updates](../../../../concepts/materialization/#delta-updates).
+Future support for standard updates is planned.
diff --git a/site/docs/reference/Connectors/materialization-connectors/pinecone.md b/site/docs/reference/Connectors/materialization-connectors/pinecone.md
@@ -30,7 +30,7 @@ on the collection fields.
 
 By default, fields of a single scalar type are including in the embedding: strings, integers,
 numbers, and booleans. You can include additional array or object type fields using [projected
-fields](../../../concepts/materialization.md#projected-fields).
+fields](../../../../concepts/materialization/#projected-fields).
 
 The text generated for the embedding has this structure, with field names and their values separated
 by newlines:

diff --git a/site/docusaurus.config.js b/site/docusaurus.config.js
@@ -1,9 +1,11 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
 
-const lightCodeTheme = require('prism-react-renderer/themes/github');
-const darkCodeTheme = require('prism-react-renderer/themes/dracula');
-const codeImport = require('remark-code-import');
+import { themes } from 'prism-react-renderer';
+import { codeImport } from 'remark-code-import'
+
+const lightCodeTheme = themes.github;
+const darkCodeTheme = themes.dracula;
 
 const BASE_URL = process.env.BASE_URL || "/"
 const URL = process.env.URL || "https://docs.estuary.dev"
@@ -16,8 +18,9 @@ const config = {
   tagline: 'Dinosaurs are cool',
   url: URL,
   baseUrl: BASE_URL,
+  onBrokenAnchors: 'warn', // TODO(johnny): Fix broken links and make this 'throw'.
   onBrokenLinks: 'throw',
-  onBrokenMarkdownLinks: 'warn',
+  onBrokenMarkdownLinks: 'throw',
   favicon: 'img/favicon-2.ico',
   organizationName: 'estuary',
   projectName: 'flow',