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

Move documentation to docs folder #5459

Merged
merged 8 commits into from Nov 2, 2016

Conversation

Projects
None yet
8 participants
@benbalter
Contributor

benbalter commented Oct 6, 2016

Per #5409, this pull requests moves the user-facing documentation from the site folder to the docs folder where we can rely on Pages to automatically generate the docs for us.

To do this, I did a few things:

  1. Abstract the docs folder to a variable in the rake task
  2. Move the rake task to use the docs folder rather than the site folder
  3. Moved the actual folder content
  4. Migrated the maintainer docs, which was at /docs to /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:publish simply runs rake site:generated_pages and 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-pages branch. 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.

@zdroid

This comment has been minimized.

Show comment
Hide comment
@zdroid

zdroid Oct 6, 2016

Member

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.

Exactly why this change is awesome. Big 👍.

Member

zdroid commented Oct 6, 2016

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.

Exactly why this change is awesome. Big 👍.

@parkr

Nice! You can also remove docs/.gitignore. 😄

Show outdated Hide outdated rake/site.rake
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

This comment has been minimized.

@parkr

parkr Oct 6, 2016

Member

This can be removed. I'll just change the settings so it uses master /docs.

@parkr

parkr Oct 6, 2016

Member

This can be removed. I'll just change the settings so it uses master /docs.

Show outdated Hide outdated rake/site.rake
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

This comment has been minimized.

@parkr

parkr Oct 6, 2016

Member

Or get rid of this.

@parkr

parkr Oct 6, 2016

Member

Or get rid of this.

Show outdated Hide outdated docs/_data/docs.yml
@@ -46,5 +46,6 @@
- title: Meta
docs:
- contributing
- development

This comment has been minimized.

@parkr

parkr Oct 6, 2016

Member

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?

@parkr

parkr Oct 6, 2016

Member

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?

@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Oct 7, 2016

Member

I have a personal request:
Can we consider renaming all existing .markdown posts to .md before implementing this PR?
I've a PR at #5176 dealing with this..
Thanks

Member

ashmaroli commented Oct 7, 2016

I have a personal request:
Can we consider renaming all existing .markdown posts to .md before implementing this PR?
I've a PR at #5176 dealing with this..
Thanks

@parkr parkr added the documentation label Oct 11, 2016

@parkr

This comment has been minimized.

Show comment
Hide comment
@zdroid

This comment has been minimized.

Show comment
Hide comment
@zdroid

zdroid Oct 19, 2016

Member

@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.

Member

zdroid commented Oct 19, 2016

@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.

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Oct 19, 2016

Member

@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.

Member

DirtyF commented Oct 19, 2016

@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.

@zdroid

This comment has been minimized.

Show comment
Hide comment
@zdroid

zdroid Oct 19, 2016

Member

@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. 😄

Member

zdroid commented Oct 19, 2016

@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. 😄

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Oct 19, 2016

Member

@zdroid Thanks for the nudge! This is actually waiting on availability of Jekyll 3.3 on GitHub Pages.

Member

parkr commented Oct 19, 2016

@zdroid Thanks for the nudge! This is actually waiting on availability of Jekyll 3.3 on GitHub Pages.

@parkr

This comment has been minimized.

Show comment
Hide comment
Member

parkr commented Nov 2, 2016

GitHub Pages is now running Jekyll 3.3. 🎉 https://github.com/blog/2277-what-s-new-in-github-pages-with-jekyll-3-3

@parkr

parkr approved these changes Nov 2, 2016

benbalter and others added some commits Oct 6, 2016

Updating install instruction link
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

This comment has been minimized.

@zdroid

zdroid Nov 2, 2016

Member

Shouldn't be escaped as ·? I've just noticed this, I know it's not related to the actual commit.

@zdroid

zdroid Nov 2, 2016

Member

Shouldn't be escaped as ·? I've just noticed this, I know it's not related to the actual commit.

This comment has been minimized.

@parkr

parkr Nov 2, 2016

Member

Do you know if it's causing an issue at all? I kind of like the UTF-8 dot. 😄

@parkr

parkr Nov 2, 2016

Member

Do you know if it's causing an issue at all? I kind of like the UTF-8 dot. 😄

This comment has been minimized.

@XhmikosR

XhmikosR Nov 2, 2016

Contributor

It should be OK since the HTML files are using utf-8.

@XhmikosR

XhmikosR Nov 2, 2016

Contributor

It should be OK since the HTML files are using utf-8.

This comment has been minimized.

@zdroid

zdroid Nov 2, 2016

Member

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.

@zdroid

zdroid Nov 2, 2016

Member

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.

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Nov 2, 2016

Member

@jekyllbot: merge +site

Member

parkr commented Nov 2, 2016

@jekyllbot: merge +site

@jekyllbot jekyllbot merged commit 2115b73 into master Nov 2, 2016

1 of 2 checks passed

continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@jekyllbot jekyllbot deleted the docs-folder branch Nov 2, 2016

jekyllbot added a commit that referenced this pull request Nov 2, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment