From 13152e12479bb7fba83237f4d6feefb139a4a35b Mon Sep 17 00:00:00 2001 From: Ben Whetton Date: Tue, 12 Jan 2021 23:44:28 +0000 Subject: [PATCH] Remove GitHub Pages content which is in GitHub docs (#8533) Merge pull request 8533 --- docs/_docs/github-pages.md | 38 +++++++++----------------------------- 1 file changed, 9 insertions(+), 29 deletions(-) diff --git a/docs/_docs/github-pages.md b/docs/_docs/github-pages.md index 5f51e9da..4b09b6a2 100644 --- a/docs/_docs/github-pages.md +++ b/docs/_docs/github-pages.md @@ -15,40 +15,20 @@ simply because Jekyll treats files without front matter as static assets. So if you only need to push generated HTML, you're good to go without any further setup. -Never built a website with GitHub Pages before? [See this marvelous guide by -Jonathan McGlone](http://jmcglone.com/guides/github-pages/) to get you up and -running. This guide will teach you what you need to know about Git, GitHub, and -Jekyll to create your very own website on GitHub Pages. +The [GitHub Pages Documentation](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages) +is comprehensive and includes a [a guide to setting up a GitHub Pages site using +Jekyll](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll). +We recommend following this guide. -## The github-pages gem - -Our friends at GitHub have provided the -[github-pages](https://github.com/github/pages-gem) gem which is used to manage -[Jekyll and its dependencies on GitHub Pages](https://pages.github.com/versions/). -Using it in your projects means that when you deploy your site to GitHub Pages, -you will not be caught by unexpected differences between various versions of the -gems. - -Note that GitHub Pages runs in `safe` mode and only allows [a set of whitelisted -plugins](https://help.github.com/articles/configuring-jekyll-plugins/#default-plugins). - -To use the currently-deployed version of the gem in your project, add the -following to your `Gemfile`: - -```ruby -source "https://rubygems.org" - -gem "github-pages", group: :jekyll_plugins -``` - -Be sure to run `bundle update` often. +This page contains some additional information which may be useful when working +on GitHub Pages sites with Jekyll.
GitHub Pages Documentation, Help, and Support

For more information about what you can do with GitHub Pages, as well as for troubleshooting guides, you should check out - GitHub’s Pages Help section. + GitHub’s Pages Help section. If all else fails, you should contact GitHub Support.

@@ -76,7 +56,7 @@ will resolve properly. ## Deploying Jekyll to GitHub Pages GitHub Pages work by looking at certain branches of repositories on GitHub. -There are two basic types available: [user/organization and project pages](https://help.github.com/articles/user-organization-and-project-pages/). +There are two basic types available: [user/organization and project pages](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites). The way to deploy these two types of sites are nearly identical, except for a few minor details. @@ -115,7 +95,7 @@ looking at right now is contained in the [docs folder]({{ site.repository }}/tree/master/docs) of the same repository. Please refer to GitHub official documentation on -[user, organization and project pages](https://help.github.com/articles/user-organization-and-project-pages/) +[user, organization and project pages](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites) to see more detailed examples.