Skip to content

Audit/update links in /app/util/links.ts #3362

Description

@charliepark

I asked the robot to go through all of the links in /app/util/links.ts. I'm working on the alerting/webhooks branch at the moment, so don't want to take time out to follow up on these suggestions at the moment, but wanted to note this as something to come back to.

Checked all 49 unique URLs in app/util/links.ts (the license URL and the OxQL template excluded). Each page was fetched following redirects, and every fragment was checked against the id attributes on the final page.

42 resolve cleanly, including all five new alerts links: the overview, #_globbing, the webhooks guide, #_secrets, #_zero_downtime_webhook_secret_rotation, and the webhook_receiver_create API page. The timeseries-schemas base page for the OxQL template also exists.

7 need attention:

┌───────────────────────────┬─────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────┐
│            Key            │                             Problem                             │                        Suggested target                        │
├───────────────────────────┼─────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────┤
│ docLinks.sleds            │ Page 404s: architecture/service-processors is gone              │ architecture/rack-components#_server_sled (anchor confirmed)   │
├───────────────────────────┼─────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────┤
│ docLinks.deviceTokens     │ Redirects to cli/guides/introduction, which has no              │ guides/user-settings#_access_tokens (anchor exists on the      │
│                           │ _device_token_setup                                             │ user-settings page)                                            │
├───────────────────────────┼─────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────┤
│ docLinks.oxql             │ Redirects to metrics/oxql-tutorial; anchor is                   │ guides/metrics/oxql-tutorial#_oxql_quick_start                 │
│                           │ _oxql_quick_start, not _oxql_quickstart                         │                                                                │
├───────────────────────────┼─────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────┤
│ docLinks.scim             │ Page loads but _saml_authentication_scim_user_provisioning is   │ identity-providers#scim (an id scim exists)                    │
│                           │ missing                                                         │                                                                │
├───────────────────────────┼─────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────┤
│ docLinks.systemSiloCreate │ Anchor _create_silo missing                                     │ completing-rack-config#_create_a_silo or                       │
│                           │                                                                 │ #_create_a_silo_using_the_oxide_console                        │
├───────────────────────────┼─────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────┤
│ docLinks.sshKeys          │ Anchor _ssh_keys missing                                        │ user-settings#manage-ssh-keys (or #create-ssh-key)             │
├───────────────────────────┼─────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────┤
│ docLinks.systemMetrics    │ Redirects to metrics/oxql-tutorial (works, but the URL is       │ guides/metrics/oxql-tutorial                                   │
│                           │ stale)                                                          │                                                                │
└───────────────────────────┴─────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────┘
Two other redirects work but point at moved pages, so worth updating while you're there: the two cloud-init links now land on docs.cloud-init.io.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions