Move documentation to docs folder #5459
Conversation
Exactly why this change is awesome. Big 👍. |
| sh "git push origin gh-pages" | ||
| sh "git add docs/" | ||
| sh "git commit --allow-empty -m 'Generating pages for #{sha}.'" | ||
| sh "git push origin master" | ||
| end | ||
| puts 'Done.' | ||
| end |
There was a problem hiding this comment.
This can be removed. I'll just change the settings so it uses master /docs.
|
|
||
| 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 |
| @@ -46,5 +46,6 @@ | |||
| - title: Meta | |||
| docs: | |||
| - contributing | |||
| - development | |||
There was a problem hiding this comment.
I think I'd like this to be called maintaining or something like that. @jekyll/affinity-team-captains, how do you feel about putting your docs on the jekyllrb.com website?
|
I have a personal request: |
|
/cc @jekyll/documentation |
|
@benbalter Any progress on this? The number of conflicted files is increasing, so it'll be easier to finish and merge it sooner than later. |
|
@zdroid Subscribe to the issue if you want to follow progress, but please don't put pressure on maintainers, we're all volunteers, there is no rush for this. |
|
@DirtyF I did subscribe, don't worry. I'm sorry if I rushed anyone, I know it's hard to keep up with working on open source project. 😄 |
|
@zdroid Thanks for the nudge! This is actually waiting on availability of Jekyll 3.3 on GitHub Pages. |
|
GitHub Pages is now running Jekyll 3.3. 🎉 https://github.com/blog/2277-what-s-new-in-github-pages-with-jekyll-3-3 |
Adding a link to updated installation instructions for Jekyll 3 and Ruby 2.2.5. These instructions were adapted and significantly updated from the earlier work of Julian Thilo which is now outdated.
| @@ -14,6 +13,9 @@ timezone: America/Los_Angeles | |||
| collections: | |||
| docs: | |||
| output: true | |||
| posts: | |||
| permalink: /news/:year/:month/:day/:title/ | |||
| output: true | |||
|
|
|||
| name: Jekyll • Simple, blog-aware, static sites | |||
There was a problem hiding this comment.
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.
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.
It should be OK since the HTML files are using utf-8.
There was a problem hiding this comment.
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. ⛱️
|
@jekyllbot: merge +site |
Per #5409, this pull requests moves the user-facing documentation from the
sitefolder to thedocsfolder where we can rely on Pages to automatically generate the docs for us.To do this, I did a few things:
/docsto/docs/_docs/development/, and added YAML front matter.There should be no other change to the user-facing site content.
Also to note,
rake site:publishsimply runsrake site:generated_pagesand commits and pushes the result (since we no longer need to do the multiple branch dance). It may be possible to have Jekyllbot do this after each release (to update the history and contributing files).Once this merges, we can delete the
gh-pagesbranch. We're also working to get this repo early access to new releases of Jekyll, so that it can always be running the latest stable version, regardless of what version other Pages users are using.Fixes #5409.