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

Add linter check that fails for nondescript link labels #2128

Merged
merged 4 commits into from
Dec 2, 2022

Conversation

delucis
Copy link
Member

@delucis delucis commented Nov 30, 2022

What kind of changes does this PR include?

  • Changes to the docs site code

Description

  • Closes Descriptive text link checker #2123
  • Adds a check to our link linter that fails if a link’s text is read more, here or more
  • Fixes two links in the Buddy deploy guide that were just labelled “here”
  • Up for including other tests here if we can think of any, but this has already caught a couple of issues!

@delucis delucis added the ci Automated PRs created by CI, or PRs about automation - ask @delucis for help! label Nov 30, 2022
@netlify
Copy link

netlify bot commented Nov 30, 2022

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit e104538
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/638a870a58da5600080912d3
😎 Deploy Preview https://deploy-preview-2128--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@sarah11918
Copy link
Member

I am so excited by this!! And it's already working, so.. LGTM!

@delucis delucis self-assigned this Dec 1, 2022
import { IssueType } from '../base/issue';

/** List of labels that are insufficiently descriptive for a link. */
const blocklist = new Set(['read more', 'here', 'more']);
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion: Add click here as an option? That's a pretty trope-y generic link text.

Copy link
Member Author

Choose a reason for hiding this comment

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

Great suggestion! Thanks for taking the time to review @BenDMyers 💜

@delucis delucis merged commit b2eef6b into main Dec 2, 2022
@delucis delucis deleted the chris/linkcheck branch December 2, 2022 23:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Automated PRs created by CI, or PRs about automation - ask @delucis for help!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Descriptive text link checker
3 participants