Fix broken anchors in our website to reduce warning spam (#7951)

When we build the website, we get a lot of warnings about broken anchors. This resolves them. This also turns on `throw` for `onBrokenAnchors`, so we'll get build failures and be alerted of broken anchors in the future. --------- Co-authored-by: Brandon Duffany <[email protected]>
buildbuddy-io · Nov 25, 2024 · c4372e6 · c4372e6
1 parent 90b3230
commit c4372e6
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 12 deletions.
diff --git a/docs/enterprise-helm.md b/docs/enterprise-helm.md
@@ -48,7 +48,7 @@ $ helm install --name my-release buildbuddy/buildbuddy-enterprise
 ```
 
 The command deploys BuildBuddy on the Kubernetes cluster in the default configuration. The [configuration](#configuration)
-section lists the parameters that can be configured during installation.
+section provides examples of parameters that can be configured during installation.
 
 ## Uninstalling the Chart
 
@@ -82,6 +82,8 @@ You can then check this configuration in to your source repository, or manually
 $ kubectl apply -f buildbuddy-deploy.yaml
 ```
 
+## Configuration
+
 ### Example configurations
 
 Below are some examples of `.yaml` files with values that could be passed to the `helm`

diff --git a/docs/workflows-config.md b/docs/workflows-config.md
@@ -372,10 +372,10 @@ Defines whether an action should run when a branch is pushed to the repo.
 
 **Fields:**
 
-- **`push`** ([`PushTrigger`](#push-trigger)): Configuration for push events associated with the repo.
+- **`push`** ([`PushTrigger`](#pushtrigger)): Configuration for push events associated with the repo.
   This is mostly useful for reporting commit statuses that show up on the
   home page of the repo.
-- **`pull_request`** ([`PullRequestTrigger`](#pull-request-trigger)):
+- **`pull_request`** ([`PullRequestTrigger`](#pullrequesttrigger)):
   Configuration for pull request events associated with the repo.
   This is required if you want to use BuildBuddy to report the status of
   this action on pull requests, and optionally prevent pull requests from

diff --git a/website/blog/bazels-remote-caching-and-remote-execution-explained.md b/website/blog/bazels-remote-caching-and-remote-execution-explained.md
@@ -254,7 +254,7 @@ it can result in slower builds.
 
 ### Flags
 
-<a id="remote_executor-flag"></a>
+#### `--remote_executor` {#remote_executor-flag}
 
 Setting the [`--remote_executor`][remote_executor] flag causes Bazel to connect via gRPC(S) or UNIX sockets to a remote executor.
 If `--remote_cache` isn't set,
@@ -267,7 +267,7 @@ Some actions might need to target a specific subset of executors,
 possibly because they need certain hardware or software,
 and they can do that with [platform properties][platform-properties].
 
-<a id="remote_default_exec_properties-flag"></a>
+#### `--remote_default_exec_properties` {#remote_default_exec_properties-flag}
 
 Platform properties can be set globally with the [`--remote_default_exec_properties`][remote_default_exec_properties] flag,
 but only if they aren't set at the [platform][platform-exec_properties] or [target][target-exec_properties] level.
@@ -280,7 +280,7 @@ in order to be able to reuse the cached action results.
 Some remote execution implementations allow setting global platform properties with [`--remote_exec_header`](#remote_exec_header-flag) flags,
 as a way to prevent these cache misses.
 
-<a id="remote_timeout-flag"></a>
+#### `--remote_timeout` {#remote_timeout-flag}
 
 The [`--remote_timeout`][remote_timeout] flag controls how long Bazel will wait for a remote cache operation to complete.
 While the timeout doesn't apply to the `Execution.Execute` call[^7],
@@ -289,7 +289,7 @@ and the default value for this flag
 (60 seconds)
 might not be long enough.
 
-<a id="remote_retires-flag"></a>
+#### `--remote_retries` {#remote_retries-flag}
 
 The [`--remote_retries`][remote_retries] flag controls how many times Bazel will retry a remote operation on a transient error,
 such as a timeout.
@@ -299,7 +299,7 @@ you might want to increase it to a much larger value.
 Bazel uses an exponential backoff for retries,
 but currently caps the delay at 5 seconds between calls.
 
-<a id="remote_exec_header-flag"></a>
+#### `--remote_exec_header` {#remote_exec_header-flag}
 
 The [`--remote_exec_header`][remote_exec_header] flag causes Bazel to send extra headers in requests to the remote executor.
 Multiple headers can be passed by specifying the flag multiple times.
@@ -332,7 +332,7 @@ can result in slower builds due to clumping of downloads,
 doesn't allow specifying that other outputs should be downloaded,
 etc.
 Though,
-similar to [dynamic scheduling](#dynamic-scheduling),
+similar to [dynamic execution](#dynamic-execution),
 if used properly BwtB can result in faster builds.
 Just don't apply it blindly.
 

diff --git a/website/blog/buildbuddy-v1-1-0-release-notes.md b/website/blog/buildbuddy-v1-1-0-release-notes.md
@@ -39,7 +39,7 @@ We'll be adding more documentation on getting started with BuildBuddy RBE in th
 
 ![](../static/img/blog/favicon.png)
 
-- **Improved documentation and new website** - we've completely revamped the BuildBuddy documentation, and it's now sync'd between GitHub and [buildbuddy.io/docs/](https://buildbuddy.io/docs/), so your docs will be fresh regardless of where you're reading them. We'll be adding new sections on configuring RBE in the coming weeks. We've also completely revamped the BuildBuddy website to make it easier to navigate and perform actions like requesting a quote, or subscribing to our [newsletter](#wf-form-Newsletter-Form).
+- **Improved documentation and new website** - we've completely revamped the BuildBuddy documentation, and it's now sync'd between GitHub and [buildbuddy.io/docs/](https://buildbuddy.io/docs/), so your docs will be fresh regardless of where you're reading them. We'll be adding new sections on configuring RBE in the coming weeks. We've also completely revamped the BuildBuddy website to make it easier to navigate and perform actions like requesting a quote.
 
 ![](../static/img/blog/docs.png)
 

diff --git a/website/blog/whats-new-in-bazel-7-0.mdx b/website/blog/whats-new-in-bazel-7-0.mdx
@@ -62,7 +62,6 @@ so I've included a table of contents to allow easy navigation to the changes tha
   - [Other](#other)
 - [Execution](#execution)
   - [Running and testing](#running-and-testing)
-  - [Runfiles](#runfiles)
   - [Coverage](#coverage)
   - [Persistent workers](#persistent-workers)
 - [Querying](#querying)
@@ -83,7 +82,6 @@ so I've included a table of contents to allow easy navigation to the changes tha
   - [Objective-C](#objective-c)
   - [Proto](#proto)
   - [Python](#python)
-- [Configuration](#configuration)
 - [Starlark and Build API](#starlark-and-build-api)
   - [Aspects](#aspects)
 - [Platforms and toolchains API](#platforms-and-toolchains-api)

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -86,6 +86,7 @@ module.exports = {
   favicon: "img/favicon_black.svg",
   organizationName: "buildbuddy-io",
   projectName: "buildbuddy",
+  onBrokenAnchors: "throw",
   themeConfig: {
     metadata: [
       {

diff --git a/website/src/pages/plugins.tsx b/website/src/pages/plugins.tsx
@@ -8,6 +8,7 @@ import styles from "./plugins.module.css";
 import message from "../util/message";
 import { Package, ArrowUpCircle, Palette, Highlighter, Globe, Bell, Network, Brush } from "lucide-react";
 import { copyToClipboard } from "../util/clipboard";
+import useBrokenLinks from "@docusaurus/useBrokenLinks";
 
 let plugins = [
   {
@@ -93,6 +94,7 @@ let form = {
 };
 
 function Component() {
+  useBrokenLinks().collectAnchor("share");
   let [count, setCount] = useState(0);
   return (
     <Layout title="BuildBuddy Plugin Library">