Skip to content

fix(docs): alert on 301, 303 links #3535

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

Jump to bottom
Merged
merged 1 commit into from
Mar 10, 2023
Merged

fix(docs): alert on 301, 303 links #3535

merged 1 commit into from
Mar 10, 2023

Conversation

@0618
Copy link
Contributor

@0618 0618 commented Mar 9, 2023 •
edited
Loading

Description of changes

301, 303 status code should not be acceptable.

Note: We still double check 301 from docs.amplify.aws (code) because its broken link returns 301 (aws-amplify/docs#5221). e.g. 'https://www.w3.org/WAI/ARIA/apg/patterns/radtton' returns 404, but 'https://docs.amplify.aws/lib/auth/getarted/q/platform/js' returns 301

Issue #, if available

Description of how you validated changes

Checklist

  • PR description included
  • yarn test passes
  • Tests are updated
  • No side effects or sideEffects field updated
  • Relevant documentation is changed or added (and PR referenced)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@changeset-bot
Copy link

changeset-bot bot commented Mar 9, 2023

⚠️ No Changeset found

Latest commit: 599486c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@0618 0618 marked this pull request as ready for review March 9, 2023 18:26
@0618 0618 requested a review from a team as a code owner March 9, 2023 18:26
@0618 0618 mentioned this pull request Mar 9, 2023
Merged
5 tasks
@0618 0618 temporarily deployed to ci March 9, 2023 18:45 — with GitHub Actions Inactive
@0618 0618 temporarily deployed to ci March 9, 2023 18:45 — with GitHub Actions Inactive
@0618 0618 temporarily deployed to ci March 9, 2023 18:45 — with GitHub Actions Inactive
@0618 0618 temporarily deployed to ci March 9, 2023 18:45 — with GitHub Actions Inactive
zchenwei
zchenwei reviewed Mar 10, 2023
View reviewed changes
docs/src/pages/[platform]/components/link/index.page.mdx
title: Link
description: Link renders an anchor element <a> by default and is primarily used for navigation.
ariaPattern: https://www.w3.org/WAI/ARIA/apg/patterns/link
ariaPattern: https://www.w3.org/WAI/ARIA/apg/patterns/link/
Copy link
Contributor

@zchenwei zchenwei Mar 10, 2023

Choose a reason for hiding this comment

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

What's the difference between adding a / and not adding one?

Copy link
Contributor Author

@0618 0618 Mar 10, 2023

Choose a reason for hiding this comment

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

without /, it returns 301 and redirects to the one with /

zchenwei
zchenwei approved these changes Mar 10, 2023
View reviewed changes
Copy link
Contributor

@zchenwei zchenwei left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM but it seems the docs.amplify.aws link example you are referencing is return 404 now 🥴

@0618
Copy link
Contributor Author

0618 commented Mar 10, 2023

https://docs.amplify.aws/lib/auth/getarted/q/platform/js

Still 301 🥴

image

@0618 0618 merged commit dade314 into main Mar 10, 2023
@0618 0618 deleted the docs-link-checker-good-status-code branch March 10, 2023 17:54
@zchenwei
Copy link
Contributor

zchenwei commented Mar 10, 2023

https://docs.amplify.aws/lib/auth/getarted/q/platform/js

Still 301 🥴

image

Now I see since you asked my last question.

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

Reviewers

2 more reviewers

@reesscot reesscot reesscot approved these changes

@zchenwei zchenwei zchenwei approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@katieklein katieklein

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@0618 @zchenwei @reesscot @nearestnabors @katieklein