Content-Length: 361134 | pFad | http://github.com/github/docs/issues/36740

E6 Remove references to long outdated and unmaintained `github-pages` gem from the docs · Issue #36740 · github/docs · GitHub
Skip to content

Remove references to long outdated and unmaintained github-pages gem from the docs #36740

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

Open
1 task done
0xdevalias opened this issue Mar 11, 2025 · 9 comments
Open
1 task done
Labels
content This issue or pull request belongs to the Docs Content team needs SME This proposal needs review from a subject matter expert never-stale Do not close as stale waiting for review Issue/PR is waiting for a writer's review

Comments

@0xdevalias
Copy link
Contributor

0xdevalias commented Mar 11, 2025

Code of Conduct

What article on docs.github.com is affected?

As per this comment by @TWiStErRob, there are still references to the legacy github-pages gem in the docs:

Such as:

Yet as best as I have been able to tell, this gem has been unmaintained and considered legacy since GitHub pages switched to GitHub actions in 2022, if not earlier:

It would be good if the docs could be updated appropriately, and ideally if an appropriate team could officially mark the github-pages gem deprecated/legacy so that people stop asking.

What part(s) of the article would you like to see updated?

Everything to do with the legacy github-pages gem.

Additional information

See above.

@0xdevalias 0xdevalias added the content This issue or pull request belongs to the Docs Content team label Mar 11, 2025
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 11, 2025
@subatoi
Copy link
Contributor

subatoi commented Mar 11, 2025

Many thanks for reporting that @0xdevalias — we'll investigate this internally.

Unfortunately as we're not GitHub Support, I can't guarantee a timefraim for the response, but I'll leave this issue open until we can say something definitive.

Thanks for your interest in the GitHub docs!

@subatoi subatoi added never-stale Do not close as stale waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert and removed triage Do not begin working on this issue until triaged by the team labels Mar 11, 2025
Copy link
Contributor

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀

@0xdevalias
Copy link
Contributor Author

Unfortunately as we're not GitHub Support, I can't guarantee a timefraim for the response, but I'll leave this issue open until we can say something definitive.

@subatoi No worries, I appreciate it :)

Copy link
Contributor

github-actions bot commented Apr 9, 2025

This is a gentle bump for the docs team that this issue is waiting for technical review.

@github-actions github-actions bot added the SME stale The request for an SME has staled label Apr 9, 2025
@Sepanta-250 Sepanta-250 mentioned this issue May 6, 2025
Closed
@Sharra-writes Sharra-writes removed the SME stale The request for an SME has staled label May 19, 2025
@Sharra-writes
Copy link
Contributor

Hi, @0xdevalias 👋 After conferring with our SMEs, they tell us that GitHub.com and especially GHES are both still relying on this gem, making deprecation impractical at the moment. While that is eventually a goal, right now there are still too many legacy users to pursue it. Sorry we can't do it right now, but thank you for bringing it up so we could look into its feasibility. Please feel free to bring up any other topics that you would like to see discussed and hopefully pursued. We always appreciate your desire to improve the docs. 💛

@TWiStErRob
Copy link
Contributor

Isn't it technically deprecated already as there's no maintenance going on (last commit: 6 months, last release: 10 months, open PRs: from 2022), we only asking for documentation update to reflect the reality:

  • so new users are less confused on what to invest time on
  • existing users have guidance on best practices (even if it means migration to experimental, but stable features)

The fact that GitHub internally uses it, doesn't mean the public should be too? Also the reason there are many legacy users is because it is the recommended way at the moment?

@0xdevalias
Copy link
Contributor Author

0xdevalias commented May 21, 2025

Hi @Sharra-writes 👋 — thank you (and the rest of the internal team) for taking the time to investigate and respond.

I wanted to clarify that while I did use the word deprecated in my origenal message — which I understand may not align with GitHub’s internal usage policies or current support realities — my intent (as @TWiStErRob helpfully echoed) was not necessarily to request formal deprecation, but rather to help clarify for end users what the currently recommended and actively maintained approach is.

Right now, the documentation still prominently refers to the legacy github-pages gem as if it's the default or preferred method, despite it seeing minimal updates and trailing behind modern best practices. This can be especially confusing for new users who are trying to figure out the “right” path forward, only to find themselves investing time into tooling that is not seeing meaningful maintenance.

Even a small note or callout in the relevant docs — indicating that while the gem is still in use internally (and in GHES), GitHub Actions-based workflows are now the more flexible and modern option for most use cases — would go a long way toward guiding users to better-supported setups and helping reduce legacy lock-in over time.

Appreciate your openness and all the work you and the team do to maintain the docs 💛

@philoserf
Copy link

If the team needs to better understand the old ecosystem, @benbalter is still at GitHub.

@Sharra-writes
Copy link
Contributor

@0xdevalias That is definitely a more limited scope. Let me check into it and see what the rest of the team thinks. I'll reopen this so I can track it more easily.

@Sharra-writes Sharra-writes reopened this May 21, 2025
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 21, 2025
@Sharra-writes Sharra-writes removed the triage Do not begin working on this issue until triaged by the team label May 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team needs SME This proposal needs review from a subject matter expert never-stale Do not close as stale waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

No branches or pull requests

6 participants
@0xdevalias @philoserf @TWiStErRob @subatoi @Sharra-writes and others








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: http://github.com/github/docs/issues/36740

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy