Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace lychee with linkcheck #209

Merged
merged 4 commits into from
Mar 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/workflows/link-checker-full.yaml
Original file line number Diff line number Diff line change
@@ -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/linkcheck@3.0.0"
with:
arguments: "--skip-file /github/workspace/linkcheck-skip.txt -e https://authzed.com/docs"
8 changes: 4 additions & 4 deletions .github/workflows/link-checker.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: "Link Checker (Fail Fast)"
name: "Link Checker"

on:
push:
Expand All @@ -20,6 +20,7 @@ jobs:
token: "${{ secrets.GITHUB_TOKEN }}"
check_interval: 30
max_timeout: 600
allow_inactive: true

link_checker:
name: "Link Checker"
Expand All @@ -29,7 +30,6 @@ jobs:
steps:
- uses: "actions/checkout@v3"
- name: "Link Checker"
uses: "lycheeverse/lychee-action@v1.9.0"
uses: "filiph/linkcheck@3.0.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 }}"
5 changes: 5 additions & 0 deletions linkcheck-skip.txt
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion pages/authzed/guides/picking-a-product.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion pages/authzed/guides/setting-up-private-networking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
4 changes: 2 additions & 2 deletions pages/spicedb/concepts/caveats.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions pages/spicedb/concepts/datastore-migrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions pages/spicedb/concepts/datastores.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion pages/spicedb/concepts/dispatch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions pages/spicedb/getting-started/discovering-spicedb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions pages/spicedb/getting-started/installing-spicedb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Loading
Loading