Skip to content

tweak wording in actions-is-preferred.md to be more generically applicable #39679

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
Aug 6, 2025
Merged

tweak wording in actions-is-preferred.md to be more generically applicable #39679

merged 1 commit into from
Aug 6, 2025

Conversation

0xdevalias
Copy link
Contributor

@0xdevalias 0xdevalias commented Aug 5, 2025 •
edited
Loading

Why:

I was just clicking through some of the pages this reusable is included on, and I think in most places it's used the wording would probably be better as:

While the github-pages gem remains...

Instead of:

While this github-pages gem remains...

As many places it's used are seemingly talking about Jekyll more generically; so 'this' doesn't make as much sense as 'the' RE: the pages-gem IMO.

Originally posted by @0xdevalias in #39148 (comment)

Nooooo, I changed that thinking it would read better, but I was wrong. 😢 If you feel like opening a PR to fix it that would probably be fastest, because it takes a while for small PRs to get reviewed internally, but I can also open it if you don't feel like doing it.

Originally posted by @Sharra-writes in #39148 (comment)

Followup to: #39148
Closes: #36740

What's being changed (if available, include any code snippets, screenshots, or gifs):

Changes the word 'this' to 'the' in the actions-is-preferred.md reusable that @Sharra-writes created to better / more generically fit the vibe/flow where the reusable it being used.

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

@Copilot Copilot AI review requested due to automatic review settings August 5, 2025 23:16
Copilot
Copilot AI reviewed Aug 5, 2025
View reviewed changes
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR improves the wording of a reusable content snippet to be more generically applicable across different contexts. The change replaces a context-specific pronoun with a more neutral alternative to better fit the various pages where this reusable content is included.

  • Updates pronoun from "this" to "the" in the actions-is-preferred.md reusable
  • Improves generic applicability of the content across multiple usage contexts
  • Maintains the same technical meaning while enhancing readability

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 5, 2025

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
from reusable
pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
from reusable
pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
from reusable
pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
from reusable
pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
from reusable
pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
from reusable
pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
from reusable

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Aug 5, 2025
@0xdevalias 0xdevalias mentioned this pull request Aug 5, 2025
Merged
3 tasks
@Sharra-writes
Copy link
Contributor

@0xdevalias Thanks for doing this! I'll get it added to the merge queue shortly.

@Sharra-writes Sharra-writes added this pull request to the merge queue Aug 6, 2025
Merged via the queue into github:main with commit f584b8f Aug 6, 2025
46 checks passed
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 6, 2025

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

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

Copilot code review Copilot Copilot left review comments

@Sharra-writes Sharra-writes Sharra-writes approved these changes

Assignees
No one assigned
Labels
triage Do not begin working on this issue until triaged by the team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Remove references to long outdated and unmaintained github-pages gem from the docs
2 participants
@0xdevalias @Sharra-writes