From 64ad293b899a66d6357cb320846b0804ae0d4518 Mon Sep 17 00:00:00 2001 From: Tim Wisniewski Date: Sat, 20 Feb 2016 19:46:48 -0500 Subject: [PATCH 01/35] add array support to where filter --- lib/jekyll/filters.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/jekyll/filters.rb b/lib/jekyll/filters.rb index 986bfdee..55e91ee8 100644 --- a/lib/jekyll/filters.rb +++ b/lib/jekyll/filters.rb @@ -222,7 +222,7 @@ module Jekyll def where(input, property, value) return input unless input.is_a?(Enumerable) input = input.values if input.is_a?(Hash) - input.select { |object| item_property(object, property).to_s == value.to_s } + input.select { |object| item_property(object, property).to_s == value.to_s or item_property(object, property).include? value.to_s } end # Sort an array of objects From 6245ddb14d0291ff7b581a937e804f871f792c30 Mon Sep 17 00:00:00 2001 From: timwis Date: Thu, 25 Feb 2016 10:18:03 -0500 Subject: [PATCH 02/35] where filter uses array for everything --- lib/jekyll/filters.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/jekyll/filters.rb b/lib/jekyll/filters.rb index 55e91ee8..b7c8e6bb 100644 --- a/lib/jekyll/filters.rb +++ b/lib/jekyll/filters.rb @@ -222,7 +222,7 @@ module Jekyll def where(input, property, value) return input unless input.is_a?(Enumerable) input = input.values if input.is_a?(Hash) - input.select { |object| item_property(object, property).to_s == value.to_s or item_property(object, property).include? value.to_s } + input.select { |object| Array(item_property(object, property)).map(&:to_s).include?(value.to_s) } end # Sort an array of objects From f5f8548eb8f36b279838c77cc890b1ccf2eb3692 Mon Sep 17 00:00:00 2001 From: timwis Date: Thu, 25 Feb 2016 10:24:47 -0500 Subject: [PATCH 03/35] add tests for where arrays --- test/test_filters.rb | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/test/test_filters.rb b/test/test_filters.rb index e9035b96..6eaff8f4 100644 --- a/test/test_filters.rb +++ b/test/test_filters.rb @@ -306,6 +306,16 @@ class TestFilters < JekyllUnitTest assert_equal 2, @filter.where(@array_of_objects, "color", "red").length end + should "filter array properties appropriately" do + hash = {"a"=>{"tags"=>["x","y"]}, "b"=>{"tags"=>["x"]}, "c"=>{"tags"=>["y","z"]}} + assert_equal 2, @filter.where(hash, "tags", "x").length + end + + should "filter array properties alongside string properties" do + hash = {"a"=>{"tags"=>["x","y"]}, "b"=>{"tags"=>"x"}, "c"=>{"tags"=>["y","z"]}} + assert_equal 2, @filter.where(hash, "tags", "x").length + end + should "stringify during comparison for compatibility with liquid parsing" do hash = { "The Words" => {"rating" => 1.2, "featured" => false}, From e130a0841f2c0d074a0e43359a3a114f454e8b5c Mon Sep 17 00:00:00 2001 From: timwis Date: Thu, 3 Mar 2016 15:56:54 -0500 Subject: [PATCH 04/35] add test to ensure where doesn't match substrings --- test/test_filters.rb | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/test/test_filters.rb b/test/test_filters.rb index 6eaff8f4..cb22ed87 100644 --- a/test/test_filters.rb +++ b/test/test_filters.rb @@ -316,6 +316,11 @@ class TestFilters < JekyllUnitTest assert_equal 2, @filter.where(hash, "tags", "x").length end + should "not match substrings" do + hash = {"a"=>{"category"=>"bear"}, "b"=>{"category"=>"wolf"}, "c"=>{"category"=>["bear","lion"]}} + assert_equal 0, @filter.where(hash, "category", "ear").length + end + should "stringify during comparison for compatibility with liquid parsing" do hash = { "The Words" => {"rating" => 1.2, "featured" => false}, From 90e83e063673cc932b3813fa2e80ba1b3cc545c2 Mon Sep 17 00:00:00 2001 From: Hugo Giraudel Date: Fri, 4 Mar 2016 17:33:44 +0100 Subject: [PATCH 05/35] Changed main
to
and added aria-label="Content" --- lib/site_template/_layouts/default.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/site_template/_layouts/default.html b/lib/site_template/_layouts/default.html index f364a368..81aa4ec6 100644 --- a/lib/site_template/_layouts/default.html +++ b/lib/site_template/_layouts/default.html @@ -7,11 +7,11 @@ {% include header.html %} -
+
{{ content }}
-
+
{% include footer.html %} From b3c6714b124576857984e580f30e915103d84e7d Mon Sep 17 00:00:00 2001 From: Anthony Smith Date: Sat, 5 Mar 2016 10:59:54 +0000 Subject: [PATCH 06/35] Subdirectories of _posts are no longer categories See #4084 --- site/_docs/upgrading/2-to-3.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/site/_docs/upgrading/2-to-3.md b/site/_docs/upgrading/2-to-3.md index 330228de..e6fb2366 100644 --- a/site/_docs/upgrading/2-to-3.md +++ b/site/_docs/upgrading/2-to-3.md @@ -123,4 +123,8 @@ date: 2016-02-06 19:32:10 -0800 --- {% endhighlight %} +### My categories have stopped working! + +If you organized your categories as `/_posts/code/2008-12-24-closures.md`, you will need to restructure your directories to put the categories _above_ the `_posts` directories, as follows: `/code/_posts/2008-12-24-closures.md`. + _Did we miss something? Please click "Improve this page" above and add a section. Thanks!_ From 71d510a79c4c1ed6bf4b2e41433bf261129b003d Mon Sep 17 00:00:00 2001 From: Alex Plescan Date: Sun, 6 Mar 2016 13:30:37 +1000 Subject: [PATCH 07/35] Update HTMLProofer CLI command Version 3.0 of HTMLProofer has renamed the CLI command `htmlproof` to `htmlproofer` (https://github.com/gjtorikian/html-proofer/issues/246). This commit updates documentation to reflect this change. --- site/_docs/continuous-integration.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/site/_docs/continuous-integration.md b/site/_docs/continuous-integration.md index bfee8bda..b56aa580 100644 --- a/site/_docs/continuous-integration.md +++ b/site/_docs/continuous-integration.md @@ -31,7 +31,7 @@ does ensure things are built properly. When testing Jekyll output, there is no better tool than [html-proofer][2]. This tool checks your resulting site to ensure all links and images exist. -Utilize it either with the convenient `htmlproof` command-line executable, +Utilize it either with the convenient `htmlproofer` command-line executable, or write a Ruby script which utilizes the gem. Save the commands you want to run and succeed in a file: `./script/cibuild` @@ -43,17 +43,17 @@ Save the commands you want to run and succeed in a file: `./script/cibuild` set -e # halt script on error bundle exec jekyll build -bundle exec htmlproof ./_site +bundle exec htmlproofer ./_site {% endhighlight %} Some options can be specified via command-line switches. Check out the `html-proofer` README for more information about these switches, or run -`htmlproof --help` locally. +`htmlproofer --help` locally. For example to avoid testing external sites, use this command: {% highlight bash %} -$ bundle exec htmlproof ./_site --disable-external +$ bundle exec htmlproofer ./_site --disable-external {% endhighlight %} ### The HTML Proofer Library @@ -154,7 +154,7 @@ incantation here directly: {% highlight yaml %} install: gem install jekyll html-proofer -script: jekyll build && htmlproof ./_site +script: jekyll build && htmlproofer ./_site {% endhighlight %} The `script` directive can be absolutely any valid shell command. From 3213ea70e5f855bb3e15bf34d036dd40c78f6cb2 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Mon, 7 Mar 2016 13:56:51 -0800 Subject: [PATCH 08/35] Update history to reflect merge of #4641 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 4c329b25..f3ce99ec 100644 --- a/History.markdown +++ b/History.markdown @@ -30,6 +30,7 @@ * Add 'view source' entry (#4602) * Add jekyll-video-embed to list of third-party plugins. (#4621) * Adding Aerobatic to list of deployment options (#4630) + * Update documentation: HTMLProofer CLI command (#4641) ## 3.1.2 / 2016-02-19 From 13912482ad884297a125eeaa18d8a052d691f6e7 Mon Sep 17 00:00:00 2001 From: Zack Spencer Date: Sun, 21 Feb 2016 15:20:29 +0000 Subject: [PATCH 09/35] Adding a debug log statment for skipped future posts. For https://github.com/jekyll/jekyll/issues/4507 --- lib/jekyll/publisher.rb | 8 ++++---- lib/jekyll/readers/post_reader.rb | 6 +++++- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/lib/jekyll/publisher.rb b/lib/jekyll/publisher.rb index 6bb8a882..cc739627 100644 --- a/lib/jekyll/publisher.rb +++ b/lib/jekyll/publisher.rb @@ -8,14 +8,14 @@ module Jekyll can_be_published?(thing) && !hidden_in_the_future?(thing) end + def hidden_in_the_future?(thing) + thing.respond_to?(:date) && !@site.future && thing.date.to_i > @site.time.to_i + end + private def can_be_published?(thing) thing.data.fetch('published', true) || @site.unpublished end - - def hidden_in_the_future?(thing) - thing.respond_to?(:date) && !@site.future && thing.date.to_i > @site.time.to_i - end end end diff --git a/lib/jekyll/readers/post_reader.rb b/lib/jekyll/readers/post_reader.rb index 1bf8ca29..f7a44ca7 100644 --- a/lib/jekyll/readers/post_reader.rb +++ b/lib/jekyll/readers/post_reader.rb @@ -35,7 +35,11 @@ module Jekyll read_content(dir, magic_dir, matcher).tap do |docs| docs.each(&:read) end.select do |doc| - site.publisher.publish?(doc) + site.publisher.publish?(doc).tap do |will_publish| + if !will_publish && site.publisher.hidden_in_the_future?(doc) + Jekyll.logger.debug "Skipping:", "#{doc.relative_path} has a future date" + end + end end end From ce3ea138ce25827accb97cac7584aedf1a8ee838 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Tue, 8 Mar 2016 06:22:13 -0800 Subject: [PATCH 10/35] Update history to reflect merge of #4558 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index f3ce99ec..bf699940 100644 --- a/History.markdown +++ b/History.markdown @@ -6,6 +6,7 @@ * Allow collections to have documents that have no file extension (#4545) * Add size property to group_by result (#4557) * Site Template: Removed unnecessary nesting from `_base.scss` (#4637) + * Adding a debug log statment for skipped future documents. (#4558) ### Bug Fixes From d912f3a456ae39f7524deab2920dc6f6108da866 Mon Sep 17 00:00:00 2001 From: Matt Rogers Date: Tue, 8 Mar 2016 16:04:28 -0600 Subject: [PATCH 11/35] Update history to reflect merge of #4636 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index bf699940..74743012 100644 --- a/History.markdown +++ b/History.markdown @@ -7,6 +7,7 @@ * Add size property to group_by result (#4557) * Site Template: Removed unnecessary nesting from `_base.scss` (#4637) * Adding a debug log statment for skipped future documents. (#4558) + * Site Template: Changed main `
` to `
` and added accessibility info (#4636) ### Bug Fixes From 3129372d120e76efb719dd054facb587e6205f3f Mon Sep 17 00:00:00 2001 From: Matt Rogers Date: Tue, 8 Mar 2016 16:13:42 -0600 Subject: [PATCH 12/35] Update history to reflect merge of #4639 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 74743012..d15b66c8 100644 --- a/History.markdown +++ b/History.markdown @@ -33,6 +33,7 @@ * Add jekyll-video-embed to list of third-party plugins. (#4621) * Adding Aerobatic to list of deployment options (#4630) * Update documentation: HTMLProofer CLI command (#4641) + * Document that subdirectories of `_posts` are no longer categories (#4639) ## 3.1.2 / 2016-02-19 From c49d1fc1bd32250944a04cee361a4eb7cd0ddde9 Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Tue, 8 Mar 2016 16:42:01 -0600 Subject: [PATCH 13/35] Collections is settled as of Jekyll v3 --- site/_docs/collections.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/site/_docs/collections.md b/site/_docs/collections.md index ed0a87ef..ede3ffef 100644 --- a/site/_docs/collections.md +++ b/site/_docs/collections.md @@ -4,13 +4,6 @@ title: Collections permalink: /docs/collections/ --- -
-
Collections support is unstable and may change
-

- This is an experimental feature and the API may change until the feature stabilizes. -

-
- Not everything is a post or a page. Maybe you want to document the various methods in your open source project, members of a team, or talks at a conference. Collections allow you to define a new type of document that behave From a1835c0a310830a16ea4c61cad9f0f193347e4e6 Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Tue, 8 Mar 2016 16:46:17 -0600 Subject: [PATCH 14/35] Fix rakefile when you don't have a title in markdown --- Rakefile | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/Rakefile b/Rakefile index d4365723..8bbb7728 100644 --- a/Rakefile +++ b/Rakefile @@ -89,7 +89,11 @@ end def siteify_file(file, front_matter = {}) abort "You seem to have misplaced your #{file} file. I can haz?" unless File.exists?(file) - title = File.read(file).match(/\A# (.*)$/)[1] + title = begin + File.read(file).match(/\A# (.*)$/)[1] + rescue + File.basename(file, ".*") + end slug = File.basename(file, ".markdown").downcase front_matter = front_matter.merge({ "title" => title, @@ -107,7 +111,7 @@ def content_for(file) when "History.markdown" converted_history(contents) else - contents.gsub!(/\A# .*\n\n?/, "") + contents.gsub(/\A# .*\n\n?/, "") end end From a93c3eadd135ea7c1ebd066bf0e3f976fb8ea5b6 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Tue, 8 Mar 2016 16:25:16 -0800 Subject: [PATCH 15/35] Update history to reflect merge of #4555 [ci skip] --- History.markdown | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/History.markdown b/History.markdown index d15b66c8..65f9e42d 100644 --- a/History.markdown +++ b/History.markdown @@ -8,6 +8,7 @@ * Site Template: Removed unnecessary nesting from `_base.scss` (#4637) * Adding a debug log statment for skipped future documents. (#4558) * Site Template: Changed main `
` to `
` and added accessibility info (#4636) + * Add array support to `where` filter (#4555) ### Bug Fixes @@ -996,7 +997,7 @@ * Patch a couple show-stopping security vulnerabilities (#1946) * Sanitize paths uniformly, in a Windows-friendly way (#2065, #2109) * Update gem build steps to work correctly on Windows (#2118) - * Remove obsolete `normalize_options` method call from `bin/jekyll` (#2121). + * Remove obsolete `normalize_options` method call from `bin/jekyll` (#2121) * Remove `+` characters from Pygments lexer names when adding as a CSS class (#994) * Remove some code that caused Ruby interpreter warnings (#2178) * Only strip the drive name if it begins the string (#2175) @@ -1862,7 +1863,7 @@ * Bug Fixes * Fix pagination % 0 bug (#78) - * Ensure all posts are processed first (#71) ## NOTE + * Ensure all posts are processed first (#71) * After this point I will no longer be giving credit in the history; that is what the commit log is for. ## 0.5.4 / 2009-08-23 From 0f50dd1bb7be3a11818c229747949c36a41194c4 Mon Sep 17 00:00:00 2001 From: Jack Reed Date: Thu, 3 Mar 2016 15:49:20 -0500 Subject: [PATCH 16/35] Update continuous-integration docs with sudo: false information Updates the continuous-integration docs to provide information about the `sudo: false` behavior which can route builds to the faster container-based infrastructure. https://docs.travis-ci.com/user/workers/container-based-infrastructure/#Routing-your-build-to-container-based-infrastructure --- site/_docs/continuous-integration.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/site/_docs/continuous-integration.md b/site/_docs/continuous-integration.md index bfee8bda..23d19d89 100644 --- a/site/_docs/continuous-integration.md +++ b/site/_docs/continuous-integration.md @@ -112,6 +112,8 @@ branches: env: global: - NOKOGIRI_USE_SYSTEM_LIBRARIES=true # speeds up installation of html-proofer + +sudo: false # route your build to the container-based infrastructure for a faster build {% endhighlight %} Ok, now for an explanation of each line: @@ -202,6 +204,16 @@ environment variable `NOKOGIRI_USE_SYSTEM_LIBRARIES` to `true`. exclude: [vendor] {% endhighlight %} +By default you should supply the `sudo: false` command to Travis. This command +explicitly tells Travis to run your build on Travis's [container-based + infrastructure](https://docs.travis-ci.com/user/workers/container-based-infrastructure/#Routing-your-build-to-container-based-infrastructure). Running on the container-based infrastructure can often times +speed up your build. If you have any trouble with your build, or if your build +does need `sudo` access, modify the line to `sudo: required`. + +{% highlight yaml %} +sudo: false +{% endhighlight %} + ### Troubleshooting **Travis error:** *"You are trying to install in deployment mode after changing From 40a5e5c60c95ba037e9364c417104e754e81511b Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Wed, 9 Mar 2016 11:19:59 -0800 Subject: [PATCH 17/35] Update history to reflect merge of #4628 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 65f9e42d..e00cc6fd 100644 --- a/History.markdown +++ b/History.markdown @@ -35,6 +35,7 @@ * Adding Aerobatic to list of deployment options (#4630) * Update documentation: HTMLProofer CLI command (#4641) * Document that subdirectories of `_posts` are no longer categories (#4639) + * Update continuous-integration docs with sudo: false information (#4628) ## 3.1.2 / 2016-02-19 From a3577d953dbf2a1d8ab2c4b62d9c1527704255b9 Mon Sep 17 00:00:00 2001 From: Ben Balter Date: Fri, 26 Feb 2016 15:29:43 -0500 Subject: [PATCH 18/35] refresh contributing doc --- .github/CONTRIBUTING.markdown | 182 +++++++++++++++++--------------- History.markdown | 2 + site/_docs/contributing.md | 189 +++++++++++++++++++--------------- site/_docs/history.md | 4 +- 4 files changed, 209 insertions(+), 168 deletions(-) diff --git a/.github/CONTRIBUTING.markdown b/.github/CONTRIBUTING.markdown index c563e2d6..9ac5a8e2 100644 --- a/.github/CONTRIBUTING.markdown +++ b/.github/CONTRIBUTING.markdown @@ -1,41 +1,107 @@ -# Contributing +# Contributing to Jekyll -So you've got an awesome idea to throw into Jekyll. Great! Please keep the -following in mind: +Hi there! Interested in contributing to Jekyll? We'd love your help. Jekyll is an open source project, built one contribution at a time by users like you. -* **Use https://talk.jekyllrb.com for non-technical or indirect Jekyll questions that are not bugs.** -* **Contributions will not be accepted without tests or necessary documentation updates.** -* If you're creating a small fix or patch to an existing feature, just a simple - test will do. Please stay in the confines of the current test suite and use - [Shoulda](https://github.com/thoughtbot/shoulda/tree/master) and - [RSpec-Mocks](https://github.com/rspec/rspec-mocks). -* If it's a brand new feature, make sure to create a new - [Cucumber](https://github.com/cucumber/cucumber/) feature and reuse steps - where appropriate. Also, whipping up some documentation in your fork's `site` - would be appreciated, and once merged it will be transferred over to the main - `site`, jekyllrb.com. -* If your contribution changes any Jekyll behavior, make sure to update the - documentation. It lives in `site/_docs`. If the docs are missing information, - please feel free to add it in. Great docs make a great project! -* Please follow the [GitHub Ruby Styleguide](https://github.com/styleguide/ruby) - when modifying Ruby code. -* Please do your best to submit **small pull requests**. The easier the proposed - change is to review, the more likely it will be merged. -* When submitting a pull request, please make judicious use of the pull request - body. A description of what changes were made, the motivations behind the - changes and [any tasks completed or left to complete](http://git.io/gfm-tasks) - will also speed up review time. +## Where to get help or report a problem -Test Dependencies ------------------ +* If you have a question about using Jekyll, start a discussion on https://talk.jekyllrb.com. +* If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository. +* If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new) -To run the test suite and build the gem you'll need to install Jekyll's -dependencies. Simply run this command to get all setup: +## Ways to contribute + +Whether you're a developer, a designer, or just a Jekyll devotee, there are lots of ways to contribute. Here's a few ideas: + +* [Install Jekyll on your computer](https://jekyllrb.com/docs/installation/) and kick the tires. Does it work? Does it do what you'd expect? If not, [open an issue](https://github.com/jekyll/jekyll/issues/new) and let us know. +* Comment on some of the project's [open issues](https://github.com/jekyll/jekyll/issues). Have you experienced the same problem? Know a work around? Do you have a suggestion for how the feature could be better? +* Read through [the documentation](http://jekyllrb.com/docs/home/), and click the "improve this page" button, any time you see something confusing, or have a suggestion for something that could be improved. +* Browse through [the Jekyll discussion forum](https://talk.jekyllrb.com/), and lend a hand answering questions. There's a good chance you've already experienced what another user is experiencing. +* Find [an open issue](https://github.com/jekyll/jekyll/issues) (especially [those labeled `help-wanted`](https://github.com/jekyll/jekyll/issues?q=is%3Aopen+is%3Aissue+label%3Ahelp-wanted)), and submit a proposed fix. If it's your first pull request, we promise we won't bite, and are glad to answer any questions. +* Help evaluate [open pull requests](https://github.com/jekyll/jekyll/pulls), by testing the changes locally and reviewing what's proposed. + +## Submitting a pull request + +### Pull requests generally + +* The smaller the proposed change, the better. If you'd like to propose two unrelated changes, submit two pull requests. + +* The more information, the better. Make judicious use of the pull request body. Describe what changes were made, why you made them, and what impact they will have for users. + +* Pull request are easy and fun. If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/) + +* If you're submitting a code contribution, be sure to read the [code contributions](#code-contributions) section below. + +### Submitting a pull request via github.com + +Many small changes can be made entirely through the github.com web interface. + +1. Navigate to the file within [`jekyll/jekyll`](https://github.com/jekyll/jekyll) that you'd like to edit +2. Click the pencil icon in the top right corner to edit the file +3. Make your proposed changes +4. Click "Propose file change" +5. Click "Create pull request" +6. Add a descriptive title and detailed description for your proposed change. The more information the better. +7. Click "Create pull request" + +That's it! You'll be automatically subscribed to receive updates as others review your proposed change and provide feedback. + +### Submitting a pull request via Git command line + +1. Fork the project by clicking "Fork" in the top right corner of [`jekyll/jekyll`](https://github.com/jekyll/jekyll) +2. Clone the repository lcoally `git clone https://github.com//jekyll` +3. Create a new, descriptively named branch to contain your change ( `git checkout -b my-awesome-feature` ). +4. Hack away, add tests. Not necessarily in that order. +5. Make sure everything still passes by running `script/cibuild` (see [the tests section](#running-tests-locally) below) +6. Push the branch up ( `git push origin my-awesome-feature` ). +7. Create a pull request by visiting https://github.com//jekyll/ and following the instructions at the top of the screen. + +## Proposing updates to the documentation + +We want the Jekyll documentation to be the best it can be. We've open-sourced our docs and we welcome any pull requests if you find it lacking. + +### How to submit changes + +You can find the documentation for jekyllrb.com in the [site](https://github.com/jekyll/jekyll/tree/master/site) directory. See the section above, [submitting a pull request](#submitting-a-pull-request) for information on how to propose a change. + +One gotcha, all pull requests should be directed at the `master` branch (the default branch). + +### Adding plugins + +If you want to add your plugin to the [list of plugins](http://jekyllrb.com/docs/plugins/#available-plugins), please submit a pull request modifying the [plugins page source file](site/_docs/plugins.md) by adding a link to your plugin under the proper subheading depending upon its type. + +## Code Contributions + +Interesting in submitting a pull request? Awesome. Read on. There's a few common gotchas that we'd love to help you avoid. + +### Tests and documentation + +Any time you propose a code change, you should also include updates to the documentation and tests within the same pull request. + +#### Documentation + +If your contribution changes any Jekyll behavior, make sure to update the documentation. Documentation lives in the `site/_docs` folder (spoiler alert: it's a Jekyll site!). If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, `jekyllrb.com` will be updated. + +#### Tests + +* If you're creating a small fix or patch to an existing feature, a simple test if more than enough. You can usually copy/paste from an existing example in the `tests` folder, but if you need to can find out about our tests suites [Shoulda](https://github.com/thoughtbot/shoulda/tree/master) and [RSpec-Mocks](https://github.com/rspec/rspec-mocks). + +* If it's a brand new feature, create a new [Cucumber](https://github.com/cucumber/cucumber/) feature, reusing existing steps where appropriate. + +### Code contributions generally + +* Jekyll follows the [GitHub Ruby Styleguide](https://github.com/styleguide/ruby). + +* Don't bump the Gem version in your pull request (if you don't know what that means, you probably didn't). + +## Running tests locally + +### Test Dependencies + +To run the test suite and build the gem you'll need to install Jekyll's dependencies by running the following command: $ script/bootstrap -Before you start, run the tests and make sure that they pass (to confirm your -environment is configured properly): +Before you make any changes, run the tests and make sure that they pass (to confirm your environment is configured properly): $ script/cibuild @@ -50,56 +116,6 @@ If you are only updating a `.feature` file, you can use the command: Both `script/test` and `script/cucumber` can be run without arguments to run its entire respective suite. -Workflow --------- +## A thank you -Here's the most direct way to get your work merged into the project: - -* [Fork](https://github.com/jekyll/jekyll/fork) the project. -* Clone down your fork ( `git clone git@github.com:[username]/jekyll.git` ). -* Create a topic branch to contain your change ( `git checkout -b my_awesome_feature` ). -* Hack away, add tests. Not necessarily in that order. -* Make sure everything still passes by running `script/cibuild`. -* If necessary, rebase your commits into logical chunks, without errors. -* Push the branch up ( `git push origin my_awesome_feature` ). -* Create a pull request against jekyll/jekyll and describe what your change - does and the why you think it should be merged. - -Updating Documentation ----------------------- - -We want the Jekyll documentation to be the best it can be. We've -open-sourced our docs and we welcome any pull requests if you find it -lacking. - -You can find the documentation for jekyllrb.com in the -[site](https://github.com/jekyll/jekyll/tree/master/site) directory of -Jekyll's repo on GitHub.com. - -All documentation pull requests should be directed at `master`. Pull -requests directed at another branch will not be accepted. - -The [Jekyll wiki](https://github.com/jekyll/jekyll/wiki) on GitHub -can be freely updated without a pull request as all GitHub users have access. - -If you want to add your plugin to the -[list of plugins](http://jekyllrb.com/docs/plugins/#available-plugins), -please submit a pull request modifying the -[plugins page source file](site/_docs/plugins.md) by adding a -link to your plugin under the proper subheading depending upon its type. - -Gotchas -------- - -* Please do not bump the gem version in your pull requests. -* Try to keep your patch(es) based from the latest commit on jekyll/jekyll. - The easier it is to apply your work, the less work the maintainers have to do, - which is always a good thing. -* Please don't tag your GitHub issue with [fix], [feature], etc. The maintainers - actively read the issues and will label it once they come across it. - -Finally... ----------- - -Thanks! Hacking on Jekyll should be fun. If you find any of this hard to figure -out, let us know so we can improve our process or documentation! +Thanks! Hacking on Jekyll should be fun. If you find any of this hard to figure out, let us know so we can improve our process or documentation! diff --git a/History.markdown b/History.markdown index e00cc6fd..bbc79733 100644 --- a/History.markdown +++ b/History.markdown @@ -1,3 +1,5 @@ +# History + ## HEAD ### Minor Enhancements diff --git a/site/_docs/contributing.md b/site/_docs/contributing.md index 51942fab..9f45f6f3 100644 --- a/site/_docs/contributing.md +++ b/site/_docs/contributing.md @@ -1,46 +1,119 @@ --- -title: Contributing +title: CONTRIBUTING layout: docs permalink: "/docs/contributing/" note: This file is autogenerated. Edit /.github/CONTRIBUTING.markdown instead. --- -So you've got an awesome idea to throw into Jekyll. Great! Please keep the -following in mind: +--- +layout: docs +title: Contributing +permalink: /docs/contributing/ +--- -* **Use https://talk.jekyllrb.com for non-technical or indirect Jekyll questions that are not bugs.** -* **Contributions will not be accepted without tests or necessary documentation updates.** -* If you're creating a small fix or patch to an existing feature, just a simple - test will do. Please stay in the confines of the current test suite and use - [Shoulda](https://github.com/thoughtbot/shoulda/tree/master) and - [RSpec-Mocks](https://github.com/rspec/rspec-mocks). -* If it's a brand new feature, make sure to create a new - [Cucumber](https://github.com/cucumber/cucumber/) feature and reuse steps - where appropriate. Also, whipping up some documentation in your fork's `site` - would be appreciated, and once merged it will be transferred over to the main - `site`, jekyllrb.com. -* If your contribution changes any Jekyll behavior, make sure to update the - documentation. It lives in `site/_docs`. If the docs are missing information, - please feel free to add it in. Great docs make a great project! -* Please follow the [GitHub Ruby Styleguide](https://github.com/styleguide/ruby) - when modifying Ruby code. -* Please do your best to submit **small pull requests**. The easier the proposed - change is to review, the more likely it will be merged. -* When submitting a pull request, please make judicious use of the pull request - body. A description of what changes were made, the motivations behind the - changes and [any tasks completed or left to complete](http://git.io/gfm-tasks) - will also speed up review time. +# Contribute to Jekyll -Test Dependencies ------------------ +Hi there! Interested in contributing to Jekyll? We'd love your help. Jekyll is an open source project, built one contribution at a time by users like you. -To run the test suite and build the gem you'll need to install Jekyll's -dependencies. Simply run this command to get all setup: +## Where to get help or report a problem + +* If you have a question about using Jekyll, start a discussion on https://talk.jekyllrb.com. +* If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new) + +## Ways to contribute + +Whether you're a developer, a designer, or just a Jekyll devotee, there are lots of ways to contribute. Here's a few ideas: + +* [Install Jekyll on your computer](https://jekyllrb.com/docs/installation/) and kick the tires. Does it work? Does it do what you'd expect? If not, [open an issue](https://github.com/jekyll/jekyll/issues/new) and let us know. +* Comment on some of the project's [open issue](https://github.com/jekyll/jekyll/issues). Have you experienced the same problem? Know a work around? Do you have a suggestion for how the feature could be better? +* Read through [the documentation](http://jekyllrb.com/docs/home/), and click the "improve this page" button, any time you see something confusing, or have a suggestion for something that could be improved. +* Browse through [the Jekyll discussion forum](https://talk.jekyllrb.com/), and lend a hand answering questions. There's a good chance you've already experienced what another user is experiencing. +* Find [an open issue](https://github.com/jekyll/jekyll/issues) (especially [those labeled `help-wanted`](https://github.com/jekyll/jekyll/issues?q=is%3Aopen+is%3Aissue+label%3Ahelp-wanted)), and submit a proposed fix. If it's your first pull request, we promise we won't bite, and are glad to answer any questions. +* Help evaluate [open pull requests](https://github.com/jekyll/jekyll/pulls), by testing the changes locally and reviewing what's proposed. + +## Submitting a pull request + +### Pull requests generally + +* The smaller the proposed change, the better. If you'd like to propose two unrelated changes, submit two pull requests. + +* The more information, the better. Make judicious use of the pull request body. Describe what changes were made, why you made them, and what impact they will have for users. + +* Pull request are easy and fun. If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/) + +* If you're submitting a code contribution, be sure to read the [code contributions](#code-contributions) section below. + +### Submitting a pull request via github.com + +Many small changes can be made entirely through the github.com web interface. + +1. Navigate to the file within [`jekyll/jekyll`](https://github.com/jekyll/jekyll) that you'd like to edit +2. Click the pencil icon in the top right corner to edit the file +3. Make your proposed changes +4. Click "Propose file change" +5. Click "Create pull request" +6. Add a descriptive title and detailed description for your proposed change. The more information the better. +7. Click "Create pull request" + +That's it! You'll be automatically subscribed to receive updates as others review your proposed change and provide feedback. + +### Submitting a pull request via Git command line + +1. Fork the project by clicking "Fork" in the top right corner of [`jekyll/jekyll`](https://github.com/jekyll/jekyll) +2. Clone the repository lcoally `git clone https://github.com//jekyll` +3. Create a new, descriptively named branch to contain your change ( `git checkout -b my-awesome-feature` ). +4. Hack away, add tests. Not necessarily in that order. +5. Make sure everything still passes by running `script/cibuild` (see [the tests section](#running-tests-locally) below) +6. Push the branch up ( `git push origin my-awesome-feature` ). +7. Create a pull request by visiting https://github.com//jekyll/ and following the instructions at the top of the screen. + +## Proposing updates to the documentation + +We want the Jekyll documentation to be the best it can be. We've open-sourced our docs and we welcome any pull requests if you find it lacking. + +### How to submit changes + +You can find the documentation for jekyllrb.com in the [site](https://github.com/jekyll/jekyll/tree/master/site) directory. See the section above, [submitting a pull request](#submitting-a-pull-request) for information on how to propose a change. + +One gotcha, all pull requests should be directed at the `master` branch (the default branch). + +### Adding plugins + +If you want to add your plugin to the [list of plugins](http://jekyllrb.com/docs/plugins/#available-plugins), please submit a pull request modifying the [plugins page source file](site/_docs/plugins.md) by adding a link to your plugin under the proper subheading depending upon its type. + +## Code Contributions + +Interesting in submitting a pull request? Awesome. Read on. There's a few common gotchas, we'd love to help you avoid. + +### Tests and documentation + +Any time you propose a code change, you should also include updates to the documentation and tests within the same pull request. + +#### Documentation + +If your contribution changes any Jekyll behavior, make sure to update the documentation. Documentation lives in the `site/_docs` folder (spoiler alert: it's a Jekyll site!). If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, `jekyllrb.com` will be updated. + +#### Tests + +* If you're creating a small fix or patch to an existing feature, a simple test if more than enough. You can usually copy/paste from an existing example in the `tests` folder, but if you need to can find out about our tests suites [Shoulda](https://github.com/thoughtbot/shoulda/tree/master) and [RSpec-Mocks](https://github.com/rspec/rspec-mocks). + +* If it's a brand new feature, create a new [Cucumber](https://github.com/cucumber/cucumber/) feature, reusing existing steps where appropriate. + +### Code contributions generally + +* Jekyll follows the [GitHub Ruby Styleguide](https://github.com/styleguide/ruby). + +* Don't bump the Gem version in your pull request (if you don't know what that means, you probably didn't). + +## Running tests locally + +### Test Dependencies + +To run the test suite and build the gem you'll need to install Jekyll's dependencies by running the following command: $ script/bootstrap -Before you start, run the tests and make sure that they pass (to confirm your -environment is configured properly): +Before you make any changes, run the tests and make sure that they pass (to confirm your environment is configured properly): $ script/cibuild @@ -55,56 +128,6 @@ If you are only updating a `.feature` file, you can use the command: Both `script/test` and `script/cucumber` can be run without arguments to run its entire respective suite. -Workflow --------- +## A thank you -Here's the most direct way to get your work merged into the project: - -* [Fork](https://github.com/jekyll/jekyll/fork) the project. -* Clone down your fork ( `git clone git@github.com:[username]/jekyll.git` ). -* Create a topic branch to contain your change ( `git checkout -b my_awesome_feature` ). -* Hack away, add tests. Not necessarily in that order. -* Make sure everything still passes by running `script/cibuild`. -* If necessary, rebase your commits into logical chunks, without errors. -* Push the branch up ( `git push origin my_awesome_feature` ). -* Create a pull request against jekyll/jekyll and describe what your change - does and the why you think it should be merged. - -Updating Documentation ----------------------- - -We want the Jekyll documentation to be the best it can be. We've -open-sourced our docs and we welcome any pull requests if you find it -lacking. - -You can find the documentation for jekyllrb.com in the -[site](https://github.com/jekyll/jekyll/tree/master/site) directory of -Jekyll's repo on GitHub.com. - -All documentation pull requests should be directed at `master`. Pull -requests directed at another branch will not be accepted. - -The [Jekyll wiki](https://github.com/jekyll/jekyll/wiki) on GitHub -can be freely updated without a pull request as all GitHub users have access. - -If you want to add your plugin to the -[list of plugins](http://jekyllrb.com/docs/plugins/#available-plugins), -please submit a pull request modifying the -[plugins page source file](site/_docs/plugins.md) by adding a -link to your plugin under the proper subheading depending upon its type. - -Gotchas -------- - -* Please do not bump the gem version in your pull requests. -* Try to keep your patch(es) based from the latest commit on jekyll/jekyll. - The easier it is to apply your work, the less work the maintainers have to do, - which is always a good thing. -* Please don't tag your GitHub issue with [fix], [feature], etc. The maintainers - actively read the issues and will label it once they come across it. - -Finally... ----------- - -Thanks! Hacking on Jekyll should be fun. If you find any of this hard to figure -out, let us know so we can improve our process or documentation! +Thanks! Hacking on Jekyll should be fun. If you find any of this hard to figure out, let us know so we can improve our process or documentation! diff --git a/site/_docs/history.md b/site/_docs/history.md index 12da9d24..175a3b1a 100644 --- a/site/_docs/history.md +++ b/site/_docs/history.md @@ -1063,7 +1063,7 @@ note: This file is autogenerated. Edit /History.markdown instead. - Patch a couple show-stopping security vulnerabilities ([#1946]({{ site.repository }}/issues/1946)) - Sanitize paths uniformly, in a Windows-friendly way ([#2065]({{ site.repository }}/issues/2065), [#2109]({{ site.repository }}/issues/2109)) - Update gem build steps to work correctly on Windows ([#2118]({{ site.repository }}/issues/2118)) -- Remove obsolete `normalize_options` method call from `bin/jekyll` ([#2121]({{ site.repository }}/issues/2121)). +- Remove obsolete `normalize_options` method call from `bin/jekyll` ([#2121]({{ site.repository }}/issues/2121)) - Remove `+` characters from Pygments lexer names when adding as a CSS class ([#994]({{ site.repository }}/issues/994)) - Remove some code that caused Ruby interpreter warnings ([#2178]({{ site.repository }}/issues/2178)) - Only strip the drive name if it begins the string ([#2175]({{ site.repository }}/issues/2175)) @@ -2061,7 +2061,7 @@ note: This file is autogenerated. Edit /History.markdown instead. - Bug Fixes - Fix pagination % 0 bug ([#78]({{ site.repository }}/issues/78)) -- Ensure all posts are processed first ([#71]({{ site.repository }}/issues/71)) ## NOTE +- Ensure all posts are processed first ([#71]({{ site.repository }}/issues/71)) - After this point I will no longer be giving credit in the history; that is what the commit log is for. From d2fd910828277f04b6b01bb38153e4348301c5c8 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Thu, 10 Mar 2016 10:10:37 -0600 Subject: [PATCH 19/35] Update history to reflect merge of #4596 [ci skip] --- History.markdown | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/History.markdown b/History.markdown index bbc79733..abbc1b47 100644 --- a/History.markdown +++ b/History.markdown @@ -1,5 +1,3 @@ -# History - ## HEAD ### Minor Enhancements @@ -26,6 +24,7 @@ * Add project maintainer profile links (#4591) * Fix state leakage in Kramdown test (#4618) * Unify method for copying special files from repo to site (#4601) + * Refresh the contributing file (#4596) ### Site Enhancements From 0f8a3b29718bf6e2fd4efdcb315d36e741588878 Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Thu, 10 Mar 2016 10:16:07 -0600 Subject: [PATCH 20/35] Proper contributing file in site/. Hello, friends. I have an update for you because i derp'd. [ci skip] --- Rakefile | 2 +- site/_docs/contributing.md | 15 ++++----------- 2 files changed, 5 insertions(+), 12 deletions(-) diff --git a/Rakefile b/Rakefile index 8bbb7728..122237ec 100644 --- a/Rakefile +++ b/Rakefile @@ -92,7 +92,7 @@ def siteify_file(file, front_matter = {}) title = begin File.read(file).match(/\A# (.*)$/)[1] rescue - File.basename(file, ".*") + File.basename(file, ".*").downcase.capitalize end slug = File.basename(file, ".markdown").downcase front_matter = front_matter.merge({ diff --git a/site/_docs/contributing.md b/site/_docs/contributing.md index 9f45f6f3..7845767c 100644 --- a/site/_docs/contributing.md +++ b/site/_docs/contributing.md @@ -1,23 +1,16 @@ --- -title: CONTRIBUTING +title: Contributing to Jekyll layout: docs permalink: "/docs/contributing/" note: This file is autogenerated. Edit /.github/CONTRIBUTING.markdown instead. --- ---- -layout: docs -title: Contributing -permalink: /docs/contributing/ ---- - -# Contribute to Jekyll - Hi there! Interested in contributing to Jekyll? We'd love your help. Jekyll is an open source project, built one contribution at a time by users like you. ## Where to get help or report a problem * If you have a question about using Jekyll, start a discussion on https://talk.jekyllrb.com. +* If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository. * If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new) ## Ways to contribute @@ -25,7 +18,7 @@ Hi there! Interested in contributing to Jekyll? We'd love your help. Jekyll is a Whether you're a developer, a designer, or just a Jekyll devotee, there are lots of ways to contribute. Here's a few ideas: * [Install Jekyll on your computer](https://jekyllrb.com/docs/installation/) and kick the tires. Does it work? Does it do what you'd expect? If not, [open an issue](https://github.com/jekyll/jekyll/issues/new) and let us know. -* Comment on some of the project's [open issue](https://github.com/jekyll/jekyll/issues). Have you experienced the same problem? Know a work around? Do you have a suggestion for how the feature could be better? +* Comment on some of the project's [open issues](https://github.com/jekyll/jekyll/issues). Have you experienced the same problem? Know a work around? Do you have a suggestion for how the feature could be better? * Read through [the documentation](http://jekyllrb.com/docs/home/), and click the "improve this page" button, any time you see something confusing, or have a suggestion for something that could be improved. * Browse through [the Jekyll discussion forum](https://talk.jekyllrb.com/), and lend a hand answering questions. There's a good chance you've already experienced what another user is experiencing. * Find [an open issue](https://github.com/jekyll/jekyll/issues) (especially [those labeled `help-wanted`](https://github.com/jekyll/jekyll/issues?q=is%3Aopen+is%3Aissue+label%3Ahelp-wanted)), and submit a proposed fix. If it's your first pull request, we promise we won't bite, and are glad to answer any questions. @@ -83,7 +76,7 @@ If you want to add your plugin to the [list of plugins](http://jekyllrb.com/docs ## Code Contributions -Interesting in submitting a pull request? Awesome. Read on. There's a few common gotchas, we'd love to help you avoid. +Interesting in submitting a pull request? Awesome. Read on. There's a few common gotchas that we'd love to help you avoid. ### Tests and documentation From 3acf4beb81a37da11ed71dce735514db20008774 Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Thu, 10 Mar 2016 10:21:15 -0600 Subject: [PATCH 21/35] Rakefile: siteify_file should allow overrides from task [ci skip] --- .github/CONTRIBUTING.markdown | 3 ++- Rakefile | 6 +++--- rake/site.rake | 2 +- site/_docs/conduct.md | 4 ++-- site/_docs/contributing.md | 5 +++-- 5 files changed, 11 insertions(+), 9 deletions(-) diff --git a/.github/CONTRIBUTING.markdown b/.github/CONTRIBUTING.markdown index 9ac5a8e2..170b8819 100644 --- a/.github/CONTRIBUTING.markdown +++ b/.github/CONTRIBUTING.markdown @@ -4,9 +4,10 @@ Hi there! Interested in contributing to Jekyll? We'd love your help. Jekyll is a ## Where to get help or report a problem -* If you have a question about using Jekyll, start a discussion on https://talk.jekyllrb.com. +* If you have a question about using Jekyll, start a discussion on [Jekyll Talk](https://talk.jekyllrb.com). * If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository. * If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new) +* More resources are listed on our [Help page](https://jekyllrb.com/help/) ## Ways to contribute diff --git a/Rakefile b/Rakefile index 122237ec..4e9a1057 100644 --- a/Rakefile +++ b/Rakefile @@ -87,7 +87,7 @@ def converted_history(markdown) normalize_bullets(markdown))))) end -def siteify_file(file, front_matter = {}) +def siteify_file(file, overrides_front_matter = {}) abort "You seem to have misplaced your #{file} file. I can haz?" unless File.exists?(file) title = begin File.read(file).match(/\A# (.*)$/)[1] @@ -95,12 +95,12 @@ def siteify_file(file, front_matter = {}) File.basename(file, ".*").downcase.capitalize end slug = File.basename(file, ".markdown").downcase - front_matter = front_matter.merge({ + front_matter = { "title" => title, "layout" => "docs", "permalink" => "/docs/#{slug}/", "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) end diff --git a/rake/site.rake b/rake/site.rake index 3bff7a16..f1af29ba 100644 --- a/rake/site.rake +++ b/rake/site.rake @@ -117,7 +117,7 @@ namespace :site do desc "Copy the contributing file" task :contributing do - siteify_file('.github/CONTRIBUTING.markdown') + siteify_file('.github/CONTRIBUTING.markdown', "title" => "Contributing") end desc "Write the site latest_version.txt file" diff --git a/site/_docs/conduct.md b/site/_docs/conduct.md index b5420b47..d68c5ec5 100644 --- a/site/_docs/conduct.md +++ b/site/_docs/conduct.md @@ -1,10 +1,10 @@ --- -redirect_from: "/conduct/index.html" -editable: false title: Code of Conduct layout: docs permalink: "/docs/conduct/" note: This file is autogenerated. Edit /CONDUCT.markdown instead. +redirect_from: "/conduct/index.html" +editable: false --- As contributors and maintainers of this project, and in the interest of diff --git a/site/_docs/contributing.md b/site/_docs/contributing.md index 7845767c..9ac49666 100644 --- a/site/_docs/contributing.md +++ b/site/_docs/contributing.md @@ -1,5 +1,5 @@ --- -title: Contributing to Jekyll +title: Contributing layout: docs permalink: "/docs/contributing/" note: This file is autogenerated. Edit /.github/CONTRIBUTING.markdown instead. @@ -9,9 +9,10 @@ Hi there! Interested in contributing to Jekyll? We'd love your help. Jekyll is a ## Where to get help or report a problem -* If you have a question about using Jekyll, start a discussion on https://talk.jekyllrb.com. +* If you have a question about using Jekyll, start a discussion on [Jekyll Talk](https://talk.jekyllrb.com). * If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository. * If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new) +* More resources are listed on our [Help page](https://jekyllrb.com/help/) ## Ways to contribute From 2240d523381eda1b595a758d3884cbca9c4d7a6a Mon Sep 17 00:00:00 2001 From: Ben Balter Date: Thu, 10 Mar 2016 11:42:48 -0500 Subject: [PATCH 22/35] add post on contributing file and affinity teams --- ...-making-it-easier-to-contribute-to-jekyll.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 site/_posts/2016-03-11-making-it-easier-to-contribute-to-jekyll.md diff --git a/site/_posts/2016-03-11-making-it-easier-to-contribute-to-jekyll.md b/site/_posts/2016-03-11-making-it-easier-to-contribute-to-jekyll.md new file mode 100644 index 00000000..43244e38 --- /dev/null +++ b/site/_posts/2016-03-11-making-it-easier-to-contribute-to-jekyll.md @@ -0,0 +1,17 @@ +--- +title: Making it easier to contribute to Jekyll +description: We've made it easier to contribute to Jekyll by updating our contributing documentation and introducing Jekyll Affinity Teams, teams dedicated to specific aspects of the project. +layout: news_item +author: benbalter +categories: [community] +--- + +Jekyll is an open source project, built entirely by community members just like you. These community contributions can come in many forms beyond just writing code, from reporting an issue or suggesting a new feature to improving documentation or providing feedback on proposed changes. + +If you've been looking to get involved with the Jekyll community, but didn't know, we've recently made it easier to contribute to Jekyll in two ways: + +First, we've completely rewritten [the project's contributing guidelines](https://jekyllrb.com/docs/contributing/), outlining [the various ways you can contribute](https://jekyllrb.com/docs/contributing/#ways-to-contribute), and including better instructions for [submitting proposed changes via GitHub.com](https://jekyllrb.com/docs/contributing/#submitting-a-pull-request-via-githubcom) or for [submitting your first code improvement](https://jekyllrb.com/docs/contributing/#code-contributions). If you have any feedback, we'd love to hear it! Simply click the "improve this page" button in the top right corner of the contributing documentation. + +Second, this week, we created six community interest groups, we're calling Jekyll affinity teams. If you're interested in a particular aspect of the project (or just want to learn more), you can join any one of these team (or two, or three), to participate in discussions about potential bugs and proposed improvements. And the best part is there's no commitment. If you just want to listen, or if at any point you want to leave (or switch teams), that's totally fine. We won't say a thing. As of today, the teams are "build", "documentation", "ecosystem", "performance", "stability", and "windows". To learn more about the various affinity teams, or to join one (please do!), visit [teams.jekyllrb.com](https://teams.jekyllrb.com/). + +We hope these changes will make it easier for you to make your first (or second, or third) contribution to Jekyll today. Thanks for helping to make Jekyll awesome! From 61e549d317734d22a660604c56e0dd61bf9e3176 Mon Sep 17 00:00:00 2001 From: Ben Balter Date: Thu, 10 Mar 2016 11:44:40 -0500 Subject: [PATCH 23/35] link to affinity teams on firt reference --- .../2016-03-11-making-it-easier-to-contribute-to-jekyll.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_posts/2016-03-11-making-it-easier-to-contribute-to-jekyll.md b/site/_posts/2016-03-11-making-it-easier-to-contribute-to-jekyll.md index 43244e38..07f5a845 100644 --- a/site/_posts/2016-03-11-making-it-easier-to-contribute-to-jekyll.md +++ b/site/_posts/2016-03-11-making-it-easier-to-contribute-to-jekyll.md @@ -12,6 +12,6 @@ If you've been looking to get involved with the Jekyll community, but didn't kno First, we've completely rewritten [the project's contributing guidelines](https://jekyllrb.com/docs/contributing/), outlining [the various ways you can contribute](https://jekyllrb.com/docs/contributing/#ways-to-contribute), and including better instructions for [submitting proposed changes via GitHub.com](https://jekyllrb.com/docs/contributing/#submitting-a-pull-request-via-githubcom) or for [submitting your first code improvement](https://jekyllrb.com/docs/contributing/#code-contributions). If you have any feedback, we'd love to hear it! Simply click the "improve this page" button in the top right corner of the contributing documentation. -Second, this week, we created six community interest groups, we're calling Jekyll affinity teams. If you're interested in a particular aspect of the project (or just want to learn more), you can join any one of these team (or two, or three), to participate in discussions about potential bugs and proposed improvements. And the best part is there's no commitment. If you just want to listen, or if at any point you want to leave (or switch teams), that's totally fine. We won't say a thing. As of today, the teams are "build", "documentation", "ecosystem", "performance", "stability", and "windows". To learn more about the various affinity teams, or to join one (please do!), visit [teams.jekyllrb.com](https://teams.jekyllrb.com/). +Second, this week, we created six community interest groups, we're calling [Jekyll affinity teams](https://teams.jekyllrb.com). If you're interested in a particular aspect of the project (or just want to learn more), you can join any one of these team (or two, or three), to participate in discussions about potential bugs and proposed improvements. And the best part is there's no commitment. If you just want to listen, or if at any point you want to leave (or switch teams), that's totally fine. We won't say a thing. As of today, the teams are "build", "documentation", "ecosystem", "performance", "stability", and "windows". To learn more about the various affinity teams, or to join one (please do!), visit [teams.jekyllrb.com](https://teams.jekyllrb.com/). We hope these changes will make it easier for you to make your first (or second, or third) contribution to Jekyll today. Thanks for helping to make Jekyll awesome! From 3403a76ec8fbec2403101760dd46275b1c96a1d6 Mon Sep 17 00:00:00 2001 From: Ben Balter Date: Thu, 10 Mar 2016 11:44:57 -0500 Subject: [PATCH 24/35] todays the 10th, not the 11th --- ....md => 2016-03-10-making-it-easier-to-contribute-to-jekyll.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename site/_posts/{2016-03-11-making-it-easier-to-contribute-to-jekyll.md => 2016-03-10-making-it-easier-to-contribute-to-jekyll.md} (100%) diff --git a/site/_posts/2016-03-11-making-it-easier-to-contribute-to-jekyll.md b/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md similarity index 100% rename from site/_posts/2016-03-11-making-it-easier-to-contribute-to-jekyll.md rename to site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md From b4ca9a56feaefe3757f48c52cdd5839e02e5c327 Mon Sep 17 00:00:00 2001 From: Ben Balter Date: Thu, 10 Mar 2016 11:45:43 -0500 Subject: [PATCH 25/35] dont list the teams --- .../2016-03-10-making-it-easier-to-contribute-to-jekyll.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md b/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md index 07f5a845..5fa854d2 100644 --- a/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md +++ b/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md @@ -12,6 +12,6 @@ If you've been looking to get involved with the Jekyll community, but didn't kno First, we've completely rewritten [the project's contributing guidelines](https://jekyllrb.com/docs/contributing/), outlining [the various ways you can contribute](https://jekyllrb.com/docs/contributing/#ways-to-contribute), and including better instructions for [submitting proposed changes via GitHub.com](https://jekyllrb.com/docs/contributing/#submitting-a-pull-request-via-githubcom) or for [submitting your first code improvement](https://jekyllrb.com/docs/contributing/#code-contributions). If you have any feedback, we'd love to hear it! Simply click the "improve this page" button in the top right corner of the contributing documentation. -Second, this week, we created six community interest groups, we're calling [Jekyll affinity teams](https://teams.jekyllrb.com). If you're interested in a particular aspect of the project (or just want to learn more), you can join any one of these team (or two, or three), to participate in discussions about potential bugs and proposed improvements. And the best part is there's no commitment. If you just want to listen, or if at any point you want to leave (or switch teams), that's totally fine. We won't say a thing. As of today, the teams are "build", "documentation", "ecosystem", "performance", "stability", and "windows". To learn more about the various affinity teams, or to join one (please do!), visit [teams.jekyllrb.com](https://teams.jekyllrb.com/). +Second, this week, we created six community interest groups, we're calling [Jekyll affinity teams](https://teams.jekyllrb.com). If you're interested in a particular aspect of the project (or just want to learn more), you can join any one of these team (or two, or three), to participate in discussions about potential bugs and proposed improvements. And the best part is there's no commitment. If you just want to listen, or if at any point you want to leave (or switch teams), that's totally fine. We won't say a thing. To learn more about the various affinity teams, or to join one (please do!), visit [teams.jekyllrb.com](https://teams.jekyllrb.com/). We hope these changes will make it easier for you to make your first (or second, or third) contribution to Jekyll today. Thanks for helping to make Jekyll awesome! From 21847980e3c4de6b5c598171dee272912562bd4d Mon Sep 17 00:00:00 2001 From: Ben Balter Date: Thu, 10 Mar 2016 11:46:06 -0500 Subject: [PATCH 26/35] more informal link language --- .../2016-03-10-making-it-easier-to-contribute-to-jekyll.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md b/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md index 5fa854d2..9f710ba7 100644 --- a/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md +++ b/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md @@ -12,6 +12,6 @@ If you've been looking to get involved with the Jekyll community, but didn't kno First, we've completely rewritten [the project's contributing guidelines](https://jekyllrb.com/docs/contributing/), outlining [the various ways you can contribute](https://jekyllrb.com/docs/contributing/#ways-to-contribute), and including better instructions for [submitting proposed changes via GitHub.com](https://jekyllrb.com/docs/contributing/#submitting-a-pull-request-via-githubcom) or for [submitting your first code improvement](https://jekyllrb.com/docs/contributing/#code-contributions). If you have any feedback, we'd love to hear it! Simply click the "improve this page" button in the top right corner of the contributing documentation. -Second, this week, we created six community interest groups, we're calling [Jekyll affinity teams](https://teams.jekyllrb.com). If you're interested in a particular aspect of the project (or just want to learn more), you can join any one of these team (or two, or three), to participate in discussions about potential bugs and proposed improvements. And the best part is there's no commitment. If you just want to listen, or if at any point you want to leave (or switch teams), that's totally fine. We won't say a thing. To learn more about the various affinity teams, or to join one (please do!), visit [teams.jekyllrb.com](https://teams.jekyllrb.com/). +Second, this week, we created six community interest groups, we're calling [Jekyll affinity teams](https://teams.jekyllrb.com). If you're interested in a particular aspect of the project (or just want to learn more), you can join any one of these team (or two, or three), to participate in discussions about potential bugs and proposed improvements. And the best part is there's no commitment. If you just want to listen, or if at any point you want to leave (or switch teams), that's totally fine. We won't say a thing. To learn more about the various affinity teams, or to join one (please do!), just head on over to [teams.jekyllrb.com](https://teams.jekyllrb.com/). We hope these changes will make it easier for you to make your first (or second, or third) contribution to Jekyll today. Thanks for helping to make Jekyll awesome! From 238341ac8a9a4230ba6acaa8a8780976f7d2314b Mon Sep 17 00:00:00 2001 From: Ben Balter Date: Thu, 10 Mar 2016 11:47:02 -0500 Subject: [PATCH 27/35] steel my awesome one contribution at a time line from the contributing file --- .../2016-03-10-making-it-easier-to-contribute-to-jekyll.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md b/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md index 9f710ba7..5405ecc2 100644 --- a/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md +++ b/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md @@ -6,7 +6,7 @@ author: benbalter categories: [community] --- -Jekyll is an open source project, built entirely by community members just like you. These community contributions can come in many forms beyond just writing code, from reporting an issue or suggesting a new feature to improving documentation or providing feedback on proposed changes. +Jekyll is an open source project, built one contribution at a time by community members just like you. These community contributions can come in many forms beyond just writing code, from reporting an issue or suggesting a new feature to improving documentation or providing feedback on proposed changes. If you've been looking to get involved with the Jekyll community, but didn't know, we've recently made it easier to contribute to Jekyll in two ways: From c759771dc7e44e27b26532a85926fa656653508e Mon Sep 17 00:00:00 2001 From: Ben Balter Date: Thu, 10 Mar 2016 11:47:53 -0500 Subject: [PATCH 28/35] super-duper informal --- .../2016-03-10-making-it-easier-to-contribute-to-jekyll.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md b/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md index 5405ecc2..3eb0f1dc 100644 --- a/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md +++ b/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md @@ -10,7 +10,7 @@ Jekyll is an open source project, built one contribution at a time by community If you've been looking to get involved with the Jekyll community, but didn't know, we've recently made it easier to contribute to Jekyll in two ways: -First, we've completely rewritten [the project's contributing guidelines](https://jekyllrb.com/docs/contributing/), outlining [the various ways you can contribute](https://jekyllrb.com/docs/contributing/#ways-to-contribute), and including better instructions for [submitting proposed changes via GitHub.com](https://jekyllrb.com/docs/contributing/#submitting-a-pull-request-via-githubcom) or for [submitting your first code improvement](https://jekyllrb.com/docs/contributing/#code-contributions). If you have any feedback, we'd love to hear it! Simply click the "improve this page" button in the top right corner of the contributing documentation. +First, we've completely rewritten [the project's contributing guidelines](https://jekyllrb.com/docs/contributing/), outlining [the various ways you can contribute](https://jekyllrb.com/docs/contributing/#ways-to-contribute), and including better instructions for [submitting proposed changes via GitHub.com](https://jekyllrb.com/docs/contributing/#submitting-a-pull-request-via-githubcom) or for [submitting your first code improvement](https://jekyllrb.com/docs/contributing/#code-contributions). And if you have any feedback, we'd love to hear it! Simply click the "improve this page" button in the top right corner of the contributing documentation. Second, this week, we created six community interest groups, we're calling [Jekyll affinity teams](https://teams.jekyllrb.com). If you're interested in a particular aspect of the project (or just want to learn more), you can join any one of these team (or two, or three), to participate in discussions about potential bugs and proposed improvements. And the best part is there's no commitment. If you just want to listen, or if at any point you want to leave (or switch teams), that's totally fine. We won't say a thing. To learn more about the various affinity teams, or to join one (please do!), just head on over to [teams.jekyllrb.com](https://teams.jekyllrb.com/). From 1c59be1494ed7b33fcc533419efef7cc0e395a4f Mon Sep 17 00:00:00 2001 From: Ben Balter Date: Thu, 10 Mar 2016 11:52:39 -0500 Subject: [PATCH 29/35] ensure avatars properly render on /news --- site/_includes/news_item.html | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/site/_includes/news_item.html b/site/_includes/news_item.html index 3ded9925..bf04dc9f 100644 --- a/site/_includes/news_item.html +++ b/site/_includes/news_item.html @@ -14,7 +14,8 @@ {{ post.date | date_to_string }}
From 86e4fa9a3594114fd4aa606ec8dc044344f20804 Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Fri, 11 Mar 2016 09:37:11 -0800 Subject: [PATCH 30/35] team ~> teams --- .../2016-03-10-making-it-easier-to-contribute-to-jekyll.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md b/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md index 3eb0f1dc..d735b682 100644 --- a/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md +++ b/site/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md @@ -12,6 +12,6 @@ If you've been looking to get involved with the Jekyll community, but didn't kno First, we've completely rewritten [the project's contributing guidelines](https://jekyllrb.com/docs/contributing/), outlining [the various ways you can contribute](https://jekyllrb.com/docs/contributing/#ways-to-contribute), and including better instructions for [submitting proposed changes via GitHub.com](https://jekyllrb.com/docs/contributing/#submitting-a-pull-request-via-githubcom) or for [submitting your first code improvement](https://jekyllrb.com/docs/contributing/#code-contributions). And if you have any feedback, we'd love to hear it! Simply click the "improve this page" button in the top right corner of the contributing documentation. -Second, this week, we created six community interest groups, we're calling [Jekyll affinity teams](https://teams.jekyllrb.com). If you're interested in a particular aspect of the project (or just want to learn more), you can join any one of these team (or two, or three), to participate in discussions about potential bugs and proposed improvements. And the best part is there's no commitment. If you just want to listen, or if at any point you want to leave (or switch teams), that's totally fine. We won't say a thing. To learn more about the various affinity teams, or to join one (please do!), just head on over to [teams.jekyllrb.com](https://teams.jekyllrb.com/). +Second, this week, we created six community interest groups, we're calling [Jekyll affinity teams](https://teams.jekyllrb.com). If you're interested in a particular aspect of the project (or just want to learn more), you can join any one of these teams (or two, or three), to participate in discussions about potential bugs and proposed improvements. And the best part is there's no commitment. If you just want to listen, or if at any point you want to leave (or switch teams), that's totally fine. We won't say a thing. To learn more about the various affinity teams, or to join one (please do!), just head on over to [teams.jekyllrb.com](https://teams.jekyllrb.com/). We hope these changes will make it easier for you to make your first (or second, or third) contribution to Jekyll today. Thanks for helping to make Jekyll awesome! From 8c9ebd2674d9dac8bbd63b712649bbddd30114f7 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Fri, 11 Mar 2016 11:37:35 -0600 Subject: [PATCH 31/35] Update history to reflect merge of #4645 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index abbc1b47..bf9d3793 100644 --- a/History.markdown +++ b/History.markdown @@ -37,6 +37,7 @@ * Update documentation: HTMLProofer CLI command (#4641) * Document that subdirectories of `_posts` are no longer categories (#4639) * Update continuous-integration docs with sudo: false information (#4628) + * Blog post on refreshed contributing file and new affinity teams (#4645) ## 3.1.2 / 2016-02-19 From 79f8210fffae24fd3de9cfa2eb3ccd1b9355477e Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Fri, 11 Mar 2016 10:04:36 -0800 Subject: [PATCH 32/35] 'jekyll clean': also remove .sass-cache --- lib/jekyll/commands/clean.rb | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/lib/jekyll/commands/clean.rb b/lib/jekyll/commands/clean.rb index 371b7043..ca19d9b5 100644 --- a/lib/jekyll/commands/clean.rb +++ b/lib/jekyll/commands/clean.rb @@ -19,21 +19,19 @@ module Jekyll options = configuration_from_options(options) destination = options['destination'] metadata_file = File.join(options['source'], '.jekyll-metadata') + sass_cache = File.join(options['source'], '.sass-cache') - if File.directory? destination - Jekyll.logger.info "Cleaning #{destination}..." - FileUtils.rm_rf(destination) - Jekyll.logger.info "", "done." - else - Jekyll.logger.info "Nothing to do for #{destination}." - end + remove(destination, checker_func: :directory?) + remove(metadata_file, checker_func: :file?) + remove(sass_cache, checker_func: :directory?) + end - if File.file? metadata_file - Jekyll.logger.info "Removing #{metadata_file}..." - FileUtils.rm_rf(metadata_file) - Jekyll.logger.info "", "done." + def remove(filename, checker_func: :file?) + if File.public_send(checker_func, filename) + Jekyll.logger.info "Cleaner:", "Removing #{filename}..." + FileUtils.rm_rf(filename) else - Jekyll.logger.info "Nothing to do for #{metadata_file}." + Jekyll.logger.info "Cleaner:", "Nothing to do for #{filename}." end end end From 4948b5a3b370647bf0a2cb00a16906182c20bab7 Mon Sep 17 00:00:00 2001 From: Mike Linksvayer Date: Fri, 11 Mar 2016 11:09:03 -0800 Subject: [PATCH 33/35] change smartify doc from copy/paste of mardownify doc --- lib/jekyll/filters.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/jekyll/filters.rb b/lib/jekyll/filters.rb index d318977f..183c9c58 100644 --- a/lib/jekyll/filters.rb +++ b/lib/jekyll/filters.rb @@ -15,11 +15,11 @@ module Jekyll converter.convert(input) end - # Convert a Markdown string into HTML output. + # Convert quotes into smart quotes. # - # input - The Markdown String to convert. + # input - The String to convert. # - # Returns the HTML formatted String. + # Returns the smart-quotified String. def smartify(input) site = @context.registers[:site] converter = site.find_converter_instance(Jekyll::Converters::SmartyPants) From c206df3401d26480d2c4767bcbcab02c4ea8ea30 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Fri, 11 Mar 2016 13:14:53 -0600 Subject: [PATCH 34/35] Update history to reflect merge of #4652 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index bf9d3793..30b9be57 100644 --- a/History.markdown +++ b/History.markdown @@ -9,6 +9,7 @@ * Adding a debug log statment for skipped future documents. (#4558) * Site Template: Changed main `
` to `
` and added accessibility info (#4636) * Add array support to `where` filter (#4555) + * 'jekyll clean': also remove .sass-cache (#4652) ### Bug Fixes From e92a46e156316c09e68e90ab6b2f6d2d2d66f072 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Fri, 11 Mar 2016 13:35:23 -0600 Subject: [PATCH 35/35] Update history to reflect merge of #4653 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 30b9be57..35a01ad5 100644 --- a/History.markdown +++ b/History.markdown @@ -26,6 +26,7 @@ * Fix state leakage in Kramdown test (#4618) * Unify method for copying special files from repo to site (#4601) * Refresh the contributing file (#4596) + * change smartify doc from copy/paste of mardownify doc (#4653) ### Site Enhancements