Reusable clarifying Actions is fully supported while Jekyll is not #39148
Conversation
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 <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
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.
| @@ -16,6 +16,8 @@ topics: | |||
| shortTitle: Test site locally with Jekyll | |||
| --- | |||
|
|
|||
| {% data reusables.pages.actions-is-preferred %} | |||
There was a problem hiding this comment.
I'm not sure this information about using Actions for Pages is relevant for local testing. It might be helpful context specifically for github-pages gem content.
Suggestion: move this reusable to the ## Updating the {% data variables.product.prodname_pages %} gem section of this article instead of at the top.
| @@ -1,3 +1 @@ | |||
| {% data variables.product.prodname_pages %} is available in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}. {% ifversion fpt or ghec %}{% data reusables.gated-features.more-info %}{% endif %} | |||
|
|
|||
| {% ifversion fpt or ghec %}{% data variables.product.prodname_pages %} now uses {% data variables.product.prodname_actions %} to execute the Jekyll build. When using a branch as the source of your build, {% data variables.product.prodname_actions %} must be enabled in your repository if you want to use the built-in Jekyll workflow. Alternatively, if {% data variables.product.prodname_actions %} is unavailable or disabled, adding a `.nojekyll` file to the root of your source branch will bypass the Jekyll build process and deploy the content directly. For more information on enabling {% data variables.product.prodname_actions %}, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository).{% endif %} | |||
There was a problem hiding this comment.
Does this information exist elsewhere? Based on this conversation, it seems like it's still relevant.
There was a problem hiding this comment.
It does! I was searching like someone who didn't already have the information, and it's probably impossible to find that way through our search. But searching through Google works. The information is in our docs. @0xdevalias made me realize that I just needed to know if it was in the docs, not whether I could find it through our search specifically.
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: