-
-
Notifications
You must be signed in to change notification settings - Fork 10.1k
Move documentation to docs folder #5459
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
3eedfd8
abstract site directory to variable
benbalter 8b9391d
abstract one last site reference
benbalter a087d34
update rake task to use docs folder
benbalter 6be62de
move site to docs folder
benbalter db4c571
Updating install instruction link
sverrirs b108f4c
Move docs/development to docs/maintaining
parkr 8b2a35d
Instead of a sleep hack, just use a Jekyll hook! :smile:
parkr 1669f94
Move posts-specific permalink into collections metadata. Way better. …
parkr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -46,5 +46,6 @@ | |
- title: Meta | ||
docs: | ||
- contributing | ||
- maintaining | ||
- conduct | ||
- history |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
6 changes: 5 additions & 1 deletion
6
docs/affinity-team-captain.md → ...docs/maintaining/affinity-team-captain.md
This file contains hidden or 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
6 changes: 5 additions & 1 deletion
6
docs/avoiding-burnout.md → docs/_docs/maintaining/avoiding-burnout.md
This file contains hidden or 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
6 changes: 5 additions & 1 deletion
6
docs/becoming-a-maintainer.md → ...docs/maintaining/becoming-a-maintainer.md
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
layout: docs | ||
title: Maintaining Jekyll | ||
permalink: /docs/maintaining/ | ||
--- | ||
|
||
**This guide is for Jekyll contributors and maintainers.** These special people contribute to one or more of Jekyll's repositories or help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone. | ||
{: .note .info } | ||
|
||
Hello! This is where we document various processes for maintaining Jekyll. Being a maintainer for any Jekyll project is a big responsibility, so we put together some helpful documentation for various tasks you might do as a maintainer. | ||
|
||
1. [Affinity teams & their captains](affinity-team-captain/) | ||
2. [Triaging and issue](triaging-an-issue/) | ||
3. [Reviewing a pull request](reviewing-a-pull-request/) | ||
4. [Merging a pull request](merging-a-pull-request/) | ||
5. [Avoiding burnout](avoiding-burnout/) | ||
6. [Special Labels](special-labels/) | ||
|
||
Interested in becoming a maintainer? Here is some documentation for **contributors**: | ||
|
||
1. [Becoming a maintainer](becoming-a-maintainer/) |
6 changes: 5 additions & 1 deletion
6
docs/merging-a-pull-request.md → ...ocs/maintaining/merging-a-pull-request.md
This file contains hidden or 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
This file contains hidden or 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
6 changes: 5 additions & 1 deletion
6
docs/special-labels.md → docs/_docs/maintaining/special-labels.md
This file contains hidden or 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
6 changes: 5 additions & 1 deletion
6
docs/triaging-an-issue.md → docs/_docs/maintaining/triaging-an-issue.md
This file contains hidden or 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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or 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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,16 @@ | ||
# Maintaining Jekyll | ||
# Jekyll docs site | ||
|
||
Hello! This is where we document various processes for maintaining Jekyll. Being a maintainer for any Jekyll project is a big responsibility, so we put together some helpful documentation for various tasks you might do as a maintainer. | ||
This directory contains the code for the Jekyll docs site, [jekyllrb.com](http://jekyllrb.com/). | ||
|
||
1. [Triaging and issue](triaging-an-issue.md) | ||
2. [Reviewing a pull request](reviewing-a-pull-request.md) | ||
3. [Merging a pull request](merging-a-pull-request.md) | ||
4. [Avoiding burnout](avoiding-burnout.md) | ||
5. [Special Labels](special-labels.md) | ||
## Contributing | ||
|
||
Interested in becoming a maintainer? Here is some documentation for **contributors**: | ||
For information about contributing, see the [Contributing page](http://jekyllrb.com/docs/contributing/). | ||
|
||
1. [Becoming a maintainer](becoming-a-maintainer.md) | ||
## Running locally | ||
|
||
You can preview your contributions before opening a pull request by running from within the directory: | ||
|
||
1. `bundle install --without test test_legacy benchmark` | ||
2. `bundle exec rake site:preview` | ||
|
||
It's just a jekyll site, afterall! :wink: |
File renamed without changes.
File renamed without changes.
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,19 +12,19 @@ namespace :site do | |
require "launchy" | ||
require "jekyll" | ||
|
||
# Yep, it's a hack! Wait a few seconds for the Jekyll site to generate and | ||
# then open it in a browser. Someday we can do better than this, I hope. | ||
Thread.new do | ||
sleep 4 | ||
puts "Opening in browser..." | ||
browser_launched = false | ||
Jekyll::Hooks.register :site, :post_write do |site| | ||
next if browser_launched | ||
browser_launched = true | ||
Jekyll.logger.info "Opening in browser..." | ||
Launchy.open("http://localhost:4000") | ||
end | ||
|
||
# Generate the site in server mode. | ||
puts "Running Jekyll..." | ||
options = { | ||
"source" => File.expand_path("site"), | ||
"destination" => File.expand_path("site/_site"), | ||
"source" => File.expand_path(docs_folder), | ||
"destination" => File.expand_path("#{docs_folder}/_site"), | ||
"watch" => true, | ||
"serving" => true | ||
} | ||
|
@@ -36,70 +36,26 @@ namespace :site do | |
task :generate => :generated_pages do | ||
require "jekyll" | ||
Jekyll::Commands::Build.process({ | ||
"profile" => true, | ||
"source" => File.expand_path("site"), | ||
"destination" => File.expand_path("site/_site") | ||
"profile" => true, | ||
"source" => File.expand_path(docs_folder), | ||
"destination" => File.expand_path("#{docs_folder}/_site") | ||
}) | ||
end | ||
task :build => :generate | ||
|
||
desc "Update normalize.css library to the latest version and minify" | ||
task :update_normalize_css do | ||
Dir.chdir("site/_sass") do | ||
Dir.chdir("#{docs_folder}/_sass") do | ||
sh 'curl "http://necolas.github.io/normalize.css/latest/normalize.css" -o "normalize.scss"' | ||
sh 'sass "normalize.scss":"_normalize.scss" --style compressed' | ||
rm ['normalize.scss', Dir.glob('*.map')].flatten | ||
end | ||
end | ||
|
||
desc "Commit the local site to the gh-pages branch and publish to GitHub Pages" | ||
desc "Generate generated pages and publish to GitHub Pages" | ||
task :publish => :generated_pages do | ||
# Ensure the gh-pages dir exists so we can generate into it. | ||
puts "Checking for gh-pages dir..." | ||
unless File.exist?("./gh-pages") | ||
puts "Creating gh-pages dir..." | ||
sh "git clone git@github.com:jekyll/jekyll gh-pages" | ||
end | ||
|
||
# Ensure latest gh-pages branch history. | ||
Dir.chdir('gh-pages') do | ||
sh "git checkout gh-pages" | ||
sh "git pull origin gh-pages" | ||
end | ||
|
||
# Proceed to purge all files in case we removed a file in this release. | ||
puts "Cleaning gh-pages directory..." | ||
purge_exclude = %w[ | ||
gh-pages/. | ||
gh-pages/.. | ||
gh-pages/.git | ||
gh-pages/.gitignore | ||
] | ||
FileList["gh-pages/{*,.*}"].exclude(*purge_exclude).each do |path| | ||
sh "rm -rf #{path}" | ||
end | ||
|
||
# Copy site to gh-pages dir. | ||
puts "Building site into gh-pages branch..." | ||
ENV['JEKYLL_ENV'] = 'production' | ||
require "jekyll" | ||
Jekyll::Commands::Build.process({ | ||
"source" => File.expand_path("site"), | ||
"destination" => File.expand_path("gh-pages"), | ||
"sass" => { "style" => "compressed" } | ||
}) | ||
|
||
File.open('gh-pages/.nojekyll', 'wb') { |f| f.puts(":dog: food.") } | ||
|
||
# Commit and push. | ||
puts "Committing and pushing to GitHub Pages..." | ||
sha = `git rev-parse HEAD`.strip | ||
Dir.chdir('gh-pages') do | ||
sh "git add ." | ||
sh "git commit --allow-empty -m 'Updating to #{sha}.'" | ||
sh "git push origin gh-pages" | ||
end | ||
puts 'Done.' | ||
puts "GitHub Pages now compiles our docs site on every push to the `master` branch. Cool, huh?" | ||
exit 1 | ||
end | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This can be removed. I'll just change the settings so it uses |
||
|
||
desc "Create a nicely formatted history page for the jekyll site based on the repo history." | ||
|
@@ -123,7 +79,7 @@ namespace :site do | |
|
||
desc "Write the site latest_version.txt file" | ||
task :version_file do | ||
File.open('site/latest_version.txt', 'wb') { |f| f.puts(version) } unless version =~ /(beta|rc|alpha)/i | ||
File.open("#{docs_folder}/latest_version.txt", 'wb') { |f| f.puts(version) } unless version =~ /(beta|rc|alpha)/i | ||
end | ||
|
||
namespace :releases do | ||
|
@@ -132,7 +88,7 @@ namespace :site do | |
raise "Specify a version: rake site:releases:new['1.2.3']" unless args.version | ||
today = Time.new.strftime('%Y-%m-%d') | ||
release = args.version.to_s | ||
filename = "site/_posts/#{today}-jekyll-#{release.split('.').join('-')}-released.markdown" | ||
filename = "#{docs_folder}/_posts/#{today}-jekyll-#{release.split('.').join('-')}-released.markdown" | ||
|
||
File.open(filename, "wb") do |post| | ||
post.puts("---") | ||
|
This file was deleted.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't
•
be escaped as·
? I've just noticed this, I know it's not related to the actual commit.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you know if it's causing an issue at all? I kind of like the UTF-8 dot. 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should be OK since the HTML files are using utf-8.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, it's fine. The old browsers such as IE6/7 (I am unsure for others) had character-encoding problems, but nobody uses them anymore. Keep the cool character as is. ⛱️