Remove GitHub Pages content which is in GitHub docs #8533
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Broken links to the GitHub docs have been updated. Much of the contents of the GitHub Pages guide is duplicated on the GitHub docs page. This has been removed and users are now directed to the relevant GitHub docs.
DirtyF
approved these changes
Jan 12, 2021
|
@jekyll: merge +docs |
jekyllbot
added a commit
that referenced
this pull request
Jan 12, 2021
github-actions bot
pushed a commit
that referenced
this pull request
Jan 12, 2021
Ben Whetton: Remove GitHub Pages content which is in GitHub docs (#8533) Merge pull request 8533
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a 馃敠 documentation change.
Summary
Much of the contents of the Jekyll GitHub Pages guide is duplicated on the GitHub docs page. I imagine they have been considerably updated since the Jekyll GitHub Pages guide was last modified. Given that the GitHub docs seem to be pretty high quality to me, I think it's probably best to link to them rather than duplicating their contents.
I'm not entirely sure how much of the Jekyll GitHub Pages guide needs to be kept:
In addition, all the existing links to the GitHub docs were broken so I've fixed them.
The blog post linked in the second paragraph is fairly outdated now. It recommends using custom css and html files rather than a jekyll theme. The suggested css file has some formatting issues as well. I have removed the link to it since I believe the GitHub docs are now a better reference which is more likely to be maintained.
It's possible that I have missed something about the purpose of this page and you have good reasons for keeping the duplicated content. If this is the case, I'll happily update this PR with just the blog post removal and link fixes.
Note: the GitHub guides are not perfect, there are a few missing steps when describing how to use bundler, for example. The Jekyll bundler guide is more complete. I intend to submit a PR to fix this and suggest that they might prefer to link to the Jekyll guide.
Context
Not related to an open issue. I'm happy to make one if that would be useful.