Merge pull request #209 from authzed/fix-link-checker

Replace lychee with linkcheck
authzed · Mar 6, 2024 · f532778 · f532778
2 parents bde0c19 + f307b8d
commit f532778
Show file tree

Hide file tree

Showing 18 changed files with 143 additions and 121 deletions.
diff --git a/.github/workflows/link-checker-full.yaml b/.github/workflows/link-checker-full.yaml
@@ -0,0 +1,19 @@
+---
+name: "Link Checker with External Links"
+
+on:
+  schedule:
+    - cron: '0 10 * * *' # Daily at 10
+  workflow_dispatch:
+
+jobs:
+  link_checker:
+    name: "Link Checker"
+    runs-on: "ubuntu-latest"
+    timeout-minutes: 15
+    steps:
+      - uses: "actions/checkout@v3"
+      - name: "Link Checker"
+        uses: "filiph/[email protected]"
+        with:
+          arguments: "--skip-file /github/workspace/linkcheck-skip.txt -e https://authzed.com/docs"
diff --git a/.github/workflows/link-checker.yaml b/.github/workflows/link-checker.yaml
@@ -1,5 +1,5 @@
 ---
-name: "Link Checker (Fail Fast)"
+name: "Link Checker"
 
 on:
   push:
@@ -20,6 +20,7 @@ jobs:
           token: "${{ secrets.GITHUB_TOKEN }}"
           check_interval: 30
           max_timeout: 600
+          allow_inactive: true
 
   link_checker:
     name: "Link Checker"
@@ -29,7 +30,6 @@ jobs:
     steps:
       - uses: "actions/checkout@v3"
       - name: "Link Checker"
-        uses: "lycheeverse/[email protected].0"
+        uses: "filiph/[email protected].0"
         with:
-          fail: true
-          args: "--verbose --no-progress --exclude '^https://github.com/.*.mdx' ${{ needs.preview.outputs.preview_url }}"
+          arguments: "--skip-file /github/workspace/linkcheck-skip.txt ${{ needs.preview.outputs.preview_url }}"
diff --git a/linkcheck-skip.txt b/linkcheck-skip.txt
@@ -0,0 +1,5 @@
+.*/_next/.*
+https://authzed.com/zanizbar/.*
+https://pkg.go.dev/.*
+https://pprof.me
+https://www.researchgate.net/profile/Carrie-Gates-2/publication/240787391_Access_Control_Requirements_for_Web_20_Security_and_Privacy/links/540e6f670cf2d8daaacd4adf/Access-Control-Requirements-for-Web-20-Security-and-Privacy.pdf
diff --git a/pages/authzed/guides/picking-a-product.mdx b/pages/authzed/guides/picking-a-product.mdx
@@ -131,7 +131,7 @@ The first 1 million of each are free.
 To understand and calculate your workloads' dispatches, you can refer to the documentation on [debugging requests][debug].
 
 [Serverless]: https://app.authzed.com/?utm_source=docs&utm_content=spicedb+serverless
-[debug]: ../../spicedb/ops/debugging-requests
+[debug]: /spicedb/modeling/validation-testing-debugging
 
 ### Open Source
 

diff --git a/pages/authzed/guides/setting-up-private-networking.mdx b/pages/authzed/guides/setting-up-private-networking.mdx
@@ -87,7 +87,7 @@ desc = No schema has been defined; please call WriteSchema to start
 ```
 
 [zed]: https://github.com/authzed/zed
-[install-zed]: ../../spicedb/guides/installing-zed
+[install-zed]: /spicedb/getting-started/installing-zed
 
 </Steps>
 

diff --git a/pages/spicedb/concepts/caveats.mdx b/pages/spicedb/concepts/caveats.mdx
@@ -216,8 +216,8 @@ CheckPermissionRequest {
 
 The [Assertions] and [Expected Relations] definitions for validation of schema support caveats as well.
 
-[assertions]: /guides/schema#writing-assertions
-[expected relations]: /guides/schema#writing-expected-relations
+[assertions]: /spicedb/modeling/developing-a-schema#assertions
+[expected relations]: /spicedb/modeling/developing-a-schema#expected-relations
 
 ### Assertions
 

diff --git a/pages/spicedb/concepts/datastore-migrations.mdx b/pages/spicedb/concepts/datastore-migrations.mdx
@@ -15,7 +15,7 @@ For example, releases that include changes to datastore can require that users u
 
   To automate upgrades without downtime, consider deploying the [SpiceDB Operator].
 
-  [SpiceDB Operator]: /guides/deploying-spicedb-operator
+  [SpiceDB Operator]: /spicedb/concepts/operator
 </Callout>
 
 [SpiceDB GitHub releases page]: https://github.com/authzed/spicedb/releases
@@ -66,7 +66,7 @@ No matter which service you select, zero-downtime migrations are always performe
 If you are operating SpiceDB yourself, the recommended update workflow is to use the [SpiceDB Operator].
 Please see the [operator-specific update docs] for various update options.
 
-[operator-specific update docs]: /spicedb/operator#updating-managed-spicedbclusters
+[operator-specific update docs]: /spicedb/concepts/operator#updating-managed-spicedbclusters
 
 ### Sequential Updates
 

diff --git a/pages/spicedb/concepts/datastores.mdx b/pages/spicedb/concepts/datastores.mdx
@@ -91,7 +91,7 @@ In distributed systems, you can trade-off consistency for performance.
 
 CockroachDB datastore users that are willing to rely on more subtle guarantees to mitigate the [New Enemy Problem] can configure `--datastore-tx-overlap-strategy`.
 
-[New Enemy Problem]: /spicedb/concepts/new-enemy-problem
+[New Enemy Problem]: /spicedb/concepts/zanzibar#new-enemy-problem
 
 The available strategies are:
 
@@ -139,7 +139,7 @@ ALTER ZONE default CONFIGURE ZONE USING gc.ttlseconds = 90000;
 
 [spanner-code]: https://github.com/authzed/spicedb/tree/main/internal/datastore/spanner
 [spanner-godoc]: https://pkg.go.dev/github.com/authzed/spicedb/internal/datastore/spanner
-[gc-process]: https://github.com/authzed/spicedb/blob/main/internal/datastore/spanner/gc.go
+[gc-process]: https://github.com/authzed/spicedb/blob/main/internal/datastore/common/gc.go
 
 ### Configuration
 
@@ -281,7 +281,7 @@ ALTER ZONE default CONFIGURE ZONE USING gc.ttlseconds = 90000;
   If you need an ephemeral datastore designed for validation or testing, see the test server system in [Validating and Testing]
 </Callout>
 
-[validating and testing]: /guides/validation-and-testing
+[validating and testing]: /spicedb/modeling/validation-testing-debugging
 
 ### Developer Notes
 

diff --git a/pages/spicedb/concepts/dispatch.mdx b/pages/spicedb/concepts/dispatch.mdx
@@ -28,7 +28,7 @@ If not using the [SpiceDB Operator], the `dispatch-upstream-addr` should be of t
 <Callout type="info">
   If you are deploying SpiceDB under Kubernetes, it is recommended to use the [SpiceDB Operator], which configures dispatching automatically.
 
-  [spicedb operator]: /spicedb/guides/deploying-spicedb-operator
+  [spicedb operator]: /spicedb/concepts/operator
 </Callout>
 
 ## Configuring Dispatch in non-Kubernetes Environments

diff --git a/pages/spicedb/getting-started/discovering-spicedb.mdx b/pages/spicedb/getting-started/discovering-spicedb.mdx
@@ -18,7 +18,7 @@ Welcome to the official documentation for the SpiceDB ecosystem.
 
 ## What is SpiceDB?
 
-SpiceDB is an open source, [Google Zanzibar]-inspired database system for real-time, security-critical [application permissions].
+SpiceDB is an open source, [Google Zanzibar]-inspired database system for real-time, security-critical application permissions.
 
 Developers create and apply a [schema] that models their application's resources and permissions.
 From their applications, [client libraries] are used to insert [relationships] or check permissions in their applications.
@@ -31,7 +31,6 @@ In some scenarios, SpiceDB can be challenging to operate because it is a critica
 For folks interested in a managed SpiceDB services and enterprise functionality, there are [AuthZed's products][authzed-products].
 
 [Google Zanzibar]: https://authzed.com/blog/what-is-zanzibar/
-[application permissions]: ./faq#what-are-application-permissions
 [schema]: https://authzed.com/docs/guides/schema
 [client libraries]: https://github.com/authzed/awesome-spicedb#clients
 [relationships]: ../concepts/relationships

diff --git a/pages/spicedb/getting-started/installing-spicedb.mdx b/pages/spicedb/getting-started/installing-spicedb.mdx
@@ -9,13 +9,13 @@ However, one should prefer one of the recommended installation methods detailed
 <Callout type="info">
   Looking to deploy SpiceDB to a staging or production environment?
 
-  [Authzed Cloud] is the fastest and most production-ready way to deploy SpiceDB.
+  [Authzed Serverless] is the fastest and most production-ready way to deploy SpiceDB.
 
   Self-hosted installations should deploy the [SpiceDB Operator].
 
   There are also [community-maintained examples] for demo environments.
 
-  [Authzed Cloud]: https://authzed.cloud
+  [Authzed Serverless]: https://app.authzed.com
   [SpiceDB Operator]: /spicedb/ops/deploying-spicedb-operator
   [community-maintained examples]: https://github.com/authzed/examples
 </Callout>