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

Minor fixes and cleanup for security advisories page #5485

Merged
merged 3 commits into from
Jan 24, 2024

Conversation

parlough
Copy link
Member

@parlough parlough commented Jan 24, 2024

Follow-up to #5480

Fixes #5458

A few things:

  • Adjusts the placeholder redirect to point to the new page
  • Add a cross-link from the pubspec reference page
  • Fixes a few typos
  • Use descriptive link text instead of "Here"
  • Remove /en from the GitHub link, so it's more likely redirect to the desired language of the user
  • In the "Ignoring security advisories" section, if putting the pubspec field ignored_advisories in code font, it's not really "a list of ignored_advisories, but rather a list itself.
  • Uses proper capitalization for "GitHub"
  • Use "the Dart team" instead of "we" for the recommendation
  • Some other minor wording adjustments (please take a look :])

@parlough
Copy link
Member Author

parlough commented Jan 24, 2024

@MaryaBelanger Thanks for reviewing and landing the original PR!!

I didn't take a look until after it landed, but found a few minor issues and areas of improvements.

I tried to outline the changes I made in the PR description to outline some of things I'm looking for when reviewing changes like this. Maybe it'll be helpful? Either way, let me know if you have any questions. Thanks again :)

@dart-github-bot
Copy link
Collaborator

dart-github-bot commented Jan 24, 2024

Visit the preview URL for this PR (updated for commit 88c0ea3):

https://dart-dev--pr5485-fix-cleanup-security-advisories-page-m0c8oobj.web.app

Copy link
Contributor

@MaryaBelanger MaryaBelanger left a comment

Choose a reason for hiding this comment

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

Thanks for catching all that!

@parlough parlough merged commit e72b9e2 into main Jan 24, 2024
8 checks passed
@parlough parlough deleted the fix/cleanup-security-advisories-page branch January 24, 2024 18:11
atsansone pushed a commit to atsansone/site-www that referenced this pull request Jan 26, 2024
Follow-up to dart-lang#5480

Fixes dart-lang#5458

A few things:

- Adjusts the placeholder redirect to point to the new page
- Add a cross-link from the pubspec reference page
- Fixes a few typos
- Use descriptive link text instead of "Here"
- Remove `/en` from the GitHub link, so it's more likely redirect to the
desired language of the user
- In the "Ignoring security advisories" section, if putting the pubspec
field `ignored_advisories` in code font, it's not really "a list of
`ignored_advisories`, but rather a list itself.
- Uses proper capitalization for "GitHub"
- Use "the Dart team" instead of "we" for the recommendation
- Some other minor wording adjustments _(please take a look :])_
atsansone pushed a commit to atsansone/site-www that referenced this pull request Feb 20, 2024
Follow-up to dart-lang#5480

Fixes dart-lang#5458

A few things:

- Adjusts the placeholder redirect to point to the new page
- Add a cross-link from the pubspec reference page
- Fixes a few typos
- Use descriptive link text instead of "Here"
- Remove `/en` from the GitHub link, so it's more likely redirect to the
desired language of the user
- In the "Ignoring security advisories" section, if putting the pubspec
field `ignored_advisories` in code font, it's not really "a list of
`ignored_advisories`, but rather a list itself.
- Uses proper capitalization for "GitHub"
- Use "the Dart team" instead of "we" for the recommendation
- Some other minor wording adjustments _(please take a look :])_
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Security advisory documentation
3 participants