Merge pull request #5459 from jekyll/docs-folder

Merge pull request 5459

Rakefile

@@ -27,6 +27,10 @@ def docs_name
   "#{name}-docs"
 end
 
+def docs_folder
+  "docs"
+end
+
 def gemspec_file
   "#{name}.gemspec"
 end
@@ -102,7 +106,7 @@ def siteify_file(file, overrides_front_matter = {})
     "note"      => "This file is autogenerated. Edit /#{file} instead."
   }.merge(overrides_front_matter)
   contents = "#{front_matter.to_yaml}---\n\n#{content_for(file)}"
-  File.write("site/_docs/#{slug}.md", contents)
+  File.write("#{docs_folder}/_docs/#{slug}.md", contents)
 end
 
 def content_for(file)

docs/_config.yml

@@ -1,6 +1,5 @@
 markdown: kramdown
 highlighter: rouge
-permalink: /news/:year/:month/:day/:title/
 
 gauges_id: 503c5af6613f5d0f19000027
 google_analytics_id: UA-50755011-1
@@ -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
 description: Transform your plain text into static websites and blogs

docs/_data/docs.yml

@@ -46,5 +46,6 @@
 - title: Meta
   docs:
   - contributing
+  - maintaining
   - conduct
   - history

docs/_docs/maintaining/affinity-team-captain.md

@@ -1,6 +1,10 @@
-# Affinity Team Captains
+---
+title: Affinity Team Captains
+layout: docs
+---
 
 **This guide is for affinity team captains.** These special people are **team maintainers** of one of our [affinity teams][] and help triage and evaluate the issues and contributions of others. You may find what is written here interesting, but it’s definitely not for everyone.
+{: .note .info }
 
 ## Affinity teams & their captains
 

docs/_docs/maintaining/avoiding-burnout.md

@@ -1,6 +1,10 @@
-# Maintainers: Avoiding Burnout
+---
+title: "Avoiding Burnout"
+layout: docs
+---
 
 **This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone.
+{: .note .info }
 
 # 1. Use Jekyll
 

docs/_docs/maintaining/becoming-a-maintainer.md

@@ -1,6 +1,10 @@
-# Contributors: Becoming a Maintainer
+---
+title: "Becoming a Maintainer"
+layout: docs
+---
 
 **This guide is for contributors.** These special people have contributed to one or more of Jekyll's repositories, but do not yet have write access to any. You may find what is written here interesting, but it’s definitely not for everyone.
+{: .note .info }
 
 So you want to become a maintainer of a Jekyll project? We'd love to have you! Here are some things we like to see from community members before we promote them to maintainers.
 

docs/_docs/maintaining/index.md

@@ -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/)

docs/_docs/maintaining/merging-a-pull-request.md

@@ -1,6 +1,10 @@
-# Maintainers: Merging a Pull Request
+---
+title: "Merging a Pull Request"
+layout: docs
+---
 
 **This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone.
+{: .note .info }
 
 ## Code Review
 

docs/_docs/maintaining/reviewing-a-pull-request.md

@@ -1,6 +1,10 @@
-# Maintainers: Reviewing a Pull Request
+---
+title: "Reviewing a Pull Request"
+layout: docs
+---
 
 **This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone.
+{: .note .info }
 
 ## Respond Kindly
 
@@ -41,4 +45,3 @@ A pull request may be merged once two maintainers have reviewed the pull request
 ## Think Security
 
 We owe it to our users to ensure that using a theme from the community or building someone else's site doesn't come with built-in security vulnerabilities. Things like where files may be read from and written to are important to keep secure. Jekyll is also the basis for hosted services such as [GitHub Pages](https://pages.github.com), which cannot upgrade when security issues are introduced.
-

docs/_docs/maintaining/special-labels.md

@@ -1,6 +1,10 @@
-# Maintainers: Special Labels
+---
+title: "Special Labels"
+layout: docs
+---
 
 **This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone.
+{: .note .info }
 
 We use a series of "special labels" on GitHub.com to automate handling of some parts of the pull request and issue process. @jekyllbot may automatically apply or remove certain labels based on actions taken by users or maintainers. Below are the labels and how they work:
 

docs/_docs/maintaining/triaging-an-issue.md

@@ -1,6 +1,10 @@
-# Maintainers: Triaging an Issue
+---
+title: "Triaging an Issue"
+layout: docs
+---
 
 **This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone.
+{: .note .info }
 
 Before evaluating an issue, it is important to identify if it is a feature
 request or a bug. For the Jekyll project the following definitions are used

docs/_docs/windows.md

@@ -16,8 +16,10 @@ A quick way to install Jekyll is to follow the [installation instructions by Dav
  2. Install Ruby via Chocolatey: `choco install ruby -y`
  3. Reopen a command prompt and install Jekyll: `gem install jekyll`
 
-For a more conventional way of installing Jekyll you can follow the [installation instruction by Julian Thilo][windows-installation]. The instructions were written for Ruby 2.0.0, but should work for later
+For a more conventional way of installing Jekyll you can follow the [installation instructions by Sverrir Sigmundarson][windows-installjekyll3]. These instructions are for newer versions of Ruby 2.2.5 and Jekyll 3.
-versions [prior to 2.2][hitimes-issue].
+
+For instructions for older versions of Ruby 2.0.0 ([prior to 2.2][hitimes-issue]) and Jekyll 2 and older you should follow the [installation instruction by Julian Thilo][windows-installation].
+
 
 ## Encoding
 
@@ -34,6 +36,7 @@ $ chcp 65001
 ```
 
 [windows-installation]: http://jekyll-windows.juthilo.com/
+[windows-installjekyll3]: https://labs.sverrirs.com/jekyll/
 [hitimes-issue]: https://github.com/copiousfreetime/hitimes/issues/40
 
 ## Auto-regeneration