Reusable clarifying Actions is fully supported while Jekyll is not #39148
Conversation
github-actions
bot
added
the
triage
There was a problem hiding this comment.
Pull Request Overview
This PR adds a reusable callout clarifying that GitHub Actions is the recommended, fully supported alternative to Jekyll on legacy pages.
- Introduces a new note reusable for pages that still reference Jekyll
- Links to the Actions quickstart guide
Co-authored-by: Copilot <[email protected]>
Sharra-writes
added
content
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
1 similar comment
This comment was marked as spam.
This comment was marked as spam.
...ing-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md
Outdated
Show resolved
Hide resolved
|
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 ⚡ |
| @@ -0,0 +1 @@ | |||
| > [!NOTE] While this `github-pages` gem remains supported for some workflows, {% data variables.product.prodname_actions %} is now the recommended approach for deploying and automating {% data variables.product.prodname_pages %} sites. | |||
There was a problem hiding this comment.
@Sharra-writes 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-pagesgem remains...
Instead of:
While this
github-pagesgem 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.
There was a problem hiding this comment.
@0xdevalias 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.
There was a problem hiding this comment.
@Sharra-writes I think in places where it's already talking about the gem specificallty 'this' would make more sense; but because the reusable ends up being in a lot of places that are only tangentially related to it, 'the' feels like it fits a bit better. Though we're really splitting hairs at this stage, and the bulk of the work you put in was still 👌🏻++ over what was there prior.
Opened a tiny tweak PR for it to make your life easier:
Why:
Legacy Pages content is written as though Jekyll is the preferred method for accomplishing tasks, when it's no longer fully supported and Actions has largely taken its place. I've added a reusable to a bunch of old Jekyll articles advising people of the change. I've also removed the same information from the "who can use this feature" box, because it has nothing to do with who can use the feature and it wasn't visible there.
Closes: #36740
What's being changed (if available, include any code snippets, screenshots, or gifs):
Adding a note at the top of legacy Jekyll articles that will hopefully direct new users to Actions. 🤞
Check off the following: