Skip to content

docs: fix relative links in about/contributing #18818

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jul 9, 2025
Merged

docs: fix relative links in about/contributing #18818

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02dfa05
adjust relative links
EdwardAngert Jul 9, 2025
00a8ed9
undo screenshot change
EdwardAngert Jul 9, 2025
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
10 changes: 5 additions & 5 deletions docs/about/contributing/backend.md
View file
Open in desktop
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [linkspector] reported by reviewdog 🐶
Cannot reach https://github.com/coder/coder/tree/docs-backend-contrib-guide/cli/cliui Status: 404

coder/docs/about/contributing/backend.md

Line 53 in 02dfa05

* [cli](https://github.com/coder/coder/tree/main/cli): CLI interface for `coder` command built on [coder/serpent](https://github.com/coder/serpent). Input controls are defined in [cliui](https://github.com/coder/coder/tree/docs-backend-contrib-guide/cli/cliui), and [testdata](https://github.com/coder/coder/tree/docs-backend-contrib-guide/cli/testdata) contains golden files for common CLI calls

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [linkspector] reported by reviewdog 🐶
Cannot reach https://github.com/coder/coder/tree/docs-backend-contrib-guide/cli/testdata Status: 404

coder/docs/about/contributing/backend.md

Line 53 in 02dfa05

* [cli](https://github.com/coder/coder/tree/main/cli): CLI interface for `coder` command built on [coder/serpent](https://github.com/coder/serpent). Input controls are defined in [cliui](https://github.com/coder/coder/tree/docs-backend-contrib-guide/cli/cliui), and [testdata](https://github.com/coder/coder/tree/docs-backend-contrib-guide/cli/testdata) contains golden files for common CLI calls

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [linkspector] reported by reviewdog 🐶
Cannot reach https://github.com/coder/coder/blob/docs-backend-contrib-guide/coderd/database/queries.sql.go Status: 404

coder/docs/about/contributing/backend.md

Line 75 in 02dfa05

* [queries](https://github.com/coder/coder/tree/main/coderd/database/queries): contains SQL files with queries, `sqlc` compiles them to [Go functions](https://github.com/coder/coder/blob/docs-backend-contrib-guide/coderd/database/queries.sql.go)

Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Need help or have questions? Join the conversation on our [Discord server](https

To understand how the backend fits into the broader system, we recommend reviewing the following resources:

* [General Concepts](../admin/infrastructure/validated-architectures/index.md#general-concepts): Essential concepts and language used to describe how Coder is structured and operated.
* [General Concepts](../../admin/infrastructure/validated-architectures/index.md#general-concepts): Essential concepts and language used to describe how Coder is structured and operated.

* [Architecture](../admin/infrastructure/architecture.md): A high-level overview of the infrastructure layout, key services, and how components interact.
* [Architecture](../../admin/infrastructure/architecture.md): A high-level overview of the infrastructure layout, key services, and how components interact.

These sections provide the necessary context for navigating and contributing to the backend effectively.

Expand Down Expand Up @@ -168,9 +168,9 @@ There are two types of fixtures that are used to test that migrations don't
break existing Coder deployments:

* Partial fixtures
[`migrations/testdata/fixtures`](../../coderd/database/migrations/testdata/fixtures)
[`migrations/testdata/fixtures`](../../../coderd/database/migrations/testdata/fixtures)
* Full database dumps
[`migrations/testdata/full_dumps`](../../coderd/database/migrations/testdata/full_dumps)
[`migrations/testdata/full_dumps`](../../../coderd/database/migrations/testdata/full_dumps)

Both types behave like database migrations (they also
[`migrate`](https://github.com/golang-migrate/migrate)). Their behavior mirrors
Expand All @@ -193,7 +193,7 @@ To add a new partial fixture, run the following command:
```

Then add some queries to insert data and commit the file to the repo. See
[`000024_example.up.sql`](../../coderd/database/migrations/testdata/fixtures/000024_example.up.sql)
[`000024_example.up.sql`](../../../coderd/database/migrations/testdata/fixtures/000024_example.up.sql)
for an example.

To create a full dump, run a fully fledged Coder deployment and use it to
Expand Down
Loading