From ab0b3e6d8e8c1ec9417b67c3cb412d7a17284bcd Mon Sep 17 00:00:00 2001 From: Robert Lord Date: Thu, 5 Jul 2018 16:55:45 -0700 Subject: [PATCH 01/46] Update issue template to direct users to changelog instead of git commits --- .github/ISSUE_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index c026a82da63..9c25c1acce2 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -9,7 +9,7 @@ If you've found a bug with Slate upstream that you're still encountering even in --> Operating system: ✍️ TODO -Last upstream commit (run `git log --author="Robert Lord" | head -n 1`): ✍️ TODO +Last upstream version (check `CHANGELOG.md` for the latest version): ✍️ TODO Browser version(s): ✍️ TODO Ruby version (run `ruby -v`): ✍️ TODO From 1d6404a7b5396bed7525e1e8b9a9030301dc343a Mon Sep 17 00:00:00 2001 From: Grey Baker Date: Wed, 7 Nov 2018 00:58:32 +0000 Subject: [PATCH 02/46] [Security] Bump nokogiri from 1.8.2 to 1.8.5 (#1026) Bumps [nokogiri](https://github.com/sparklemotion/nokogiri) from 1.8.2 to 1.8.5. **This update includes security fixes.** - [Release notes](https://github.com/sparklemotion/nokogiri/releases) - [Changelog](https://github.com/sparklemotion/nokogiri/blob/master/CHANGELOG.md) - [Commits](https://github.com/sparklemotion/nokogiri/compare/v1.8.2...v1.8.5) Signed-off-by: dependabot[bot] --- Gemfile | 2 +- Gemfile.lock | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Gemfile b/Gemfile index 79d41fff6dd..6c8967ffeef 100644 --- a/Gemfile +++ b/Gemfile @@ -8,4 +8,4 @@ gem 'middleman-autoprefixer', '~> 2.7.0' gem 'middleman-sprockets', '~> 4.1.0' gem 'rouge', '~> 2.0.5' gem 'redcarpet', '~> 3.4.0' -gem 'nokogiri', '~> 1.8.2' +gem 'nokogiri', '~> 1.8.5' diff --git a/Gemfile.lock b/Gemfile.lock index eebb95a9694..cff46a21ecc 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -81,7 +81,7 @@ GEM rouge (~> 2.0) mini_portile2 (2.3.0) minitest (5.10.1) - nokogiri (1.8.2) + nokogiri (1.8.5) mini_portile2 (~> 2.3.0) padrino-helpers (0.13.3.3) i18n (~> 0.6, >= 0.6.7) @@ -118,7 +118,7 @@ DEPENDENCIES middleman-autoprefixer (~> 2.7.0) middleman-sprockets (~> 4.1.0) middleman-syntax (~> 3.0.0) - nokogiri (~> 1.8.2) + nokogiri (~> 1.8.5) redcarpet (~> 3.4.0) rouge (~> 2.0.5) From 99cdc40578aa57d2e048cf21dd3e964808eb9c13 Mon Sep 17 00:00:00 2001 From: Christian Oliff Date: Mon, 4 Feb 2019 03:28:05 +0900 Subject: [PATCH 03/46] Update link in .editorconfig to https (#1049) --- .editorconfig | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.editorconfig b/.editorconfig index b54e172c0db..1692977cec8 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,4 +1,4 @@ -# EditorConfig is awesome: http://EditorConfig.org +# EditorConfig is awesome: https://EditorConfig.org # Top-most EditorConfig file root = true From c8b73553558380474bf2b5617879b20f20fb4f8b Mon Sep 17 00:00:00 2001 From: Jeff Stieler Date: Sun, 3 Feb 2019 11:30:15 -0700 Subject: [PATCH 04/46] Fix lowercase "c" in "WooCommerce". (#1043) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c9017010ae6..675aad33460 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ Companies Using Slate * [Best Buy](https://bestbuyapis.github.io/api-documentation/) * [Travis-CI](https://docs.travis-ci.com/api/) * [Greenhouse](https://developers.greenhouse.io/harvest.html) -* [Woocommerce](http://woocommerce.github.io/woocommerce-rest-api-docs/) +* [WooCommerce](http://woocommerce.github.io/woocommerce-rest-api-docs/) * [Dwolla](https://docs.dwolla.com/) * [Clearbit](https://clearbit.com/docs) * [Coinbase](https://developers.coinbase.com/api) From 16d2b1e27c171f607d3dec88c3b06517da23b242 Mon Sep 17 00:00:00 2001 From: Grey Baker Date: Sat, 1 Jun 2019 19:08:00 +0100 Subject: [PATCH 05/46] [Security] Bump ffi from 1.9.17 to 1.9.25 (#1017) Bumps [ffi](https://github.com/ffi/ffi) from 1.9.17 to 1.9.25. **This update includes security fixes.** - [Release notes](https://github.com/ffi/ffi/releases) - [Changelog](https://github.com/ffi/ffi/blob/master/CHANGELOG.md) - [Commits](https://github.com/ffi/ffi/compare/1.9.17...1.9.25) Signed-off-by: dependabot[bot] --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index cff46a21ecc..95d793e1636 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -25,7 +25,7 @@ GEM fast_blank (1.0.0) fastimage (2.0.1) addressable (~> 2) - ffi (1.9.17) + ffi (1.9.25) haml (4.0.7) tilt hamster (3.0.0) From 3dfde2c078881c0df1f10774a9d33441989cd966 Mon Sep 17 00:00:00 2001 From: Grey Baker Date: Sat, 1 Jun 2019 19:11:08 +0100 Subject: [PATCH 06/46] [Security] Bump rack from 2.0.5 to 2.0.6 (#1038) Bumps [rack](https://github.com/rack/rack) from 2.0.5 to 2.0.6. **This update includes security fixes.** - [Release notes](https://github.com/rack/rack/releases) - [Changelog](https://github.com/rack/rack/blob/master/CHANGELOG.md) - [Commits](https://github.com/rack/rack/compare/2.0.5...2.0.6) Signed-off-by: dependabot[bot] --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index 95d793e1636..cb455faa095 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -91,7 +91,7 @@ GEM activesupport (>= 3.1) parallel (1.10.0) public_suffix (2.0.5) - rack (2.0.5) + rack (2.0.6) rb-fsevent (0.9.8) rb-inotify (0.9.8) ffi (>= 0.5.0) From 98951d5ca970eeda84cd5d522adef81ef73c0216 Mon Sep 17 00:00:00 2001 From: Robert Lord Date: Sat, 1 Jun 2019 13:18:59 -0700 Subject: [PATCH 07/46] Bundle update; upgrade middleman, add sass gem Patch taken from #1092, thanks jakemack --- Gemfile | 9 ++-- Gemfile.lock | 115 +++++++++++++++++++++++++++------------------------ 2 files changed, 66 insertions(+), 58 deletions(-) diff --git a/Gemfile b/Gemfile index 6c8967ffeef..a77f013adca 100644 --- a/Gemfile +++ b/Gemfile @@ -2,10 +2,11 @@ ruby '>=2.3.1' source 'https://rubygems.org' # Middleman -gem 'middleman', '~>4.2.1' -gem 'middleman-syntax', '~> 3.0.0' -gem 'middleman-autoprefixer', '~> 2.7.0' -gem 'middleman-sprockets', '~> 4.1.0' +gem 'middleman', '~>4.3' +gem 'middleman-syntax', '~> 3.0' +gem 'middleman-autoprefixer', '~> 2.7' +gem 'middleman-sprockets', '~> 4.1' gem 'rouge', '~> 2.0.5' gem 'redcarpet', '~> 3.4.0' gem 'nokogiri', '~> 1.8.5' +gem 'sass' diff --git a/Gemfile.lock b/Gemfile.lock index cb455faa095..142d13eeec8 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,60 +1,57 @@ GEM remote: https://rubygems.org/ specs: - activesupport (5.0.1) + activesupport (5.0.7.2) concurrent-ruby (~> 1.0, >= 1.0.2) - i18n (~> 0.7) + i18n (>= 0.7, < 2) minitest (~> 5.1) tzinfo (~> 1.1) - addressable (2.5.0) - public_suffix (~> 2.0, >= 2.0.2) - autoprefixer-rails (6.6.1) + addressable (2.6.0) + public_suffix (>= 2.0.2, < 4.0) + autoprefixer-rails (9.5.1.1) execjs - backports (3.6.8) + backports (3.15.0) coffee-script (2.4.1) coffee-script-source execjs coffee-script-source (1.12.2) - compass-import-once (1.0.5) - sass (>= 3.2, < 3.5) - concurrent-ruby (1.0.5) + concurrent-ruby (1.1.5) contracts (0.13.0) - dotenv (2.2.0) + dotenv (2.7.2) erubis (2.7.0) execjs (2.7.0) fast_blank (1.0.0) - fastimage (2.0.1) - addressable (~> 2) - ffi (1.9.25) - haml (4.0.7) + fastimage (2.1.5) + ffi (1.11.1) + haml (5.1.1) + temple (>= 0.8.0) tilt hamster (3.0.0) concurrent-ruby (~> 1.0) - hashie (3.5.1) - i18n (0.7.0) - kramdown (1.13.2) + hashie (3.6.0) + i18n (0.9.5) + concurrent-ruby (~> 1.0) + kramdown (1.17.0) listen (3.0.8) rb-fsevent (~> 0.9, >= 0.9.4) rb-inotify (~> 0.9, >= 0.9.7) - memoist (0.15.0) - middleman (4.2.1) + memoist (0.16.0) + middleman (4.3.4) coffee-script (~> 2.2) - compass-import-once (= 1.0.5) haml (>= 4.0.5) kramdown (~> 1.2) - middleman-cli (= 4.2.1) - middleman-core (= 4.2.1) - sass (>= 3.4.0, < 4.0) - middleman-autoprefixer (2.7.1) - autoprefixer-rails (>= 6.5.2, < 7.0.0) + middleman-cli (= 4.3.4) + middleman-core (= 4.3.4) + middleman-autoprefixer (2.10.1) + autoprefixer-rails (~> 9.1) middleman-core (>= 3.3.3) - middleman-cli (4.2.1) + middleman-cli (4.3.4) thor (>= 0.17.0, < 2.0) - middleman-core (4.2.1) + middleman-core (4.3.4) activesupport (>= 4.2, < 5.1) addressable (~> 2.3) backports (~> 3.6) - bundler (~> 1.1) + bundler contracts (~> 0.13.0) dotenv erubis @@ -63,67 +60,77 @@ GEM fastimage (~> 2.0) hamster (~> 3.0) hashie (~> 3.4) - i18n (~> 0.7.0) + i18n (~> 0.9.0) listen (~> 3.0.0) memoist (~> 0.14) padrino-helpers (~> 0.13.0) parallel rack (>= 1.4.5, < 3) - sass (>= 3.4) + sassc (~> 2.0) servolux - tilt (~> 2.0) + tilt (~> 2.0.9) uglifier (~> 3.0) - middleman-sprockets (4.1.0) + middleman-sprockets (4.1.1) middleman-core (~> 4.0) sprockets (>= 3.0) middleman-syntax (3.0.0) middleman-core (>= 3.2) rouge (~> 2.0) mini_portile2 (2.3.0) - minitest (5.10.1) + minitest (5.11.3) nokogiri (1.8.5) mini_portile2 (~> 2.3.0) - padrino-helpers (0.13.3.3) + padrino-helpers (0.13.3.4) i18n (~> 0.6, >= 0.6.7) - padrino-support (= 0.13.3.3) + padrino-support (= 0.13.3.4) tilt (>= 1.4.1, < 3) - padrino-support (0.13.3.3) + padrino-support (0.13.3.4) activesupport (>= 3.1) - parallel (1.10.0) - public_suffix (2.0.5) - rack (2.0.6) - rb-fsevent (0.9.8) - rb-inotify (0.9.8) - ffi (>= 0.5.0) + parallel (1.17.0) + public_suffix (3.1.0) + rack (2.0.7) + rake (12.3.2) + rb-fsevent (0.10.3) + rb-inotify (0.10.0) + ffi (~> 1.0) redcarpet (3.4.0) rouge (2.0.7) - sass (3.4.23) - servolux (0.12.0) + sass (3.7.4) + sass-listen (~> 4.0.0) + sass-listen (4.0.0) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + sassc (2.0.1) + ffi (~> 1.9) + rake + servolux (0.13.0) sprockets (3.7.2) concurrent-ruby (~> 1.0) rack (> 1, < 3) - thor (0.19.4) - thread_safe (0.3.5) - tilt (2.0.6) - tzinfo (1.2.2) + temple (0.8.1) + thor (0.20.3) + thread_safe (0.3.6) + tilt (2.0.9) + tzinfo (1.2.5) thread_safe (~> 0.1) - uglifier (3.0.4) + uglifier (3.2.0) execjs (>= 0.3.0, < 3) PLATFORMS ruby DEPENDENCIES - middleman (~> 4.2.1) - middleman-autoprefixer (~> 2.7.0) - middleman-sprockets (~> 4.1.0) - middleman-syntax (~> 3.0.0) + middleman (~> 4.3) + middleman-autoprefixer (~> 2.7) + middleman-sprockets (~> 4.1) + middleman-syntax (~> 3.0) nokogiri (~> 1.8.5) redcarpet (~> 3.4.0) rouge (~> 2.0.5) + sass RUBY VERSION ruby 2.3.3p222 BUNDLED WITH - 1.15.4 + 2.0.1 From 0b195a99083b997ddfe152d583432cbd75b82af9 Mon Sep 17 00:00:00 2001 From: Robert Lord Date: Sat, 1 Jun 2019 13:27:21 -0700 Subject: [PATCH 08/46] Update to bundler 2.0 in travis.yml --- .travis.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.travis.yml b/.travis.yml index 0d6d210d94a..9b52b6b18db 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,5 +6,9 @@ rvm: - 2.3.3 - 2.4.0 +before_install: + - gem update --system + - gem install bundler + cache: bundler script: bundle exec middleman build From f81909ea6ee0696573f35d4c549bcb3e9a13eade Mon Sep 17 00:00:00 2001 From: Dan <48282179+dan-os@users.noreply.github.com> Date: Thu, 16 May 2019 23:40:45 +0100 Subject: [PATCH 09/46] Update issue templates --- .../start-here.md} | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) rename .github/{ISSUE_TEMPLATE.md => ISSUE_TEMPLATE/start-here.md} (81%) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/start-here.md similarity index 81% rename from .github/ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/start-here.md index 9c25c1acce2..4199c901d58 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/start-here.md @@ -1,3 +1,12 @@ +--- +name: Start Here +about: Help improve Slate! +title: "✍️ TODO" +labels: '' +assignees: '' + +--- + Operating system: ✍️ TODO -Last upstream version (check `CHANGELOG.md` for the latest version): ✍️ TODO +Last upstream commit (run `git log --author="Robert Lord" | head -n 1`): ✍️ TODO Browser version(s): ✍️ TODO Ruby version (run `ruby -v`): ✍️ TODO From 36b7e4430d81ddfd34bf4ed5bc1f571382e1c206 Mon Sep 17 00:00:00 2001 From: Sam Gilman Date: Sun, 2 Jun 2019 05:36:44 +0800 Subject: [PATCH 10/46] updated config.rb to activate asset_hash (#1076) --- config.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/config.rb b/config.rb index 24887979fea..b3ba23ed052 100644 --- a/config.rb +++ b/config.rb @@ -40,6 +40,7 @@ # Build Configuration configure :build do + activate :asset_hash # If you're having trouble with Middleman hanging, commenting # out the following two lines has been known to help activate :minify_css From e7eb64785b52ed4d45a77210ac37adbb8fc691ce Mon Sep 17 00:00:00 2001 From: daniel-korbit Date: Sun, 8 Sep 2019 04:21:17 +0900 Subject: [PATCH 11/46] change example link correctly (#1130) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 675aad33460..a73fdf8f648 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@

Screenshot of Example Documentation created with Slate

-

The example above was created with Slate. Check it out at lord.github.io/slate.

+

The example above was created with Slate. Check it out at slatedocs.github.io/slate.

Features ------------ From 151c3034c1cc05c948d17389cfa13e345a187ae1 Mon Sep 17 00:00:00 2001 From: Arun Date: Tue, 15 Oct 2019 00:27:23 +0530 Subject: [PATCH 12/46] Change default value of base fork in PR template (#1137) --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index eebe789aa08..151e45d78cd 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,5 @@ \ No newline at end of file From 894534b5d3830518a5b6142b26967a9bc5b39013 Mon Sep 17 00:00:00 2001 From: Gustavo Gawryszewski <318831+gawry@users.noreply.github.com> Date: Mon, 14 Oct 2019 15:59:32 -0300 Subject: [PATCH 13/46] Updated README.md from lord/slate to slatedocs/slate (#1140) --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a73fdf8f648..04081e5aa3f 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Features * **RTL Support** Full right-to-left layout for RTL languages such as Arabic, Persian (Farsi), Hebrew etc. -Getting started with Slate is super easy! Simply fork this repository and follow the instructions below. Or, if you'd like to check out what Slate is capable of, take a look at the [sample docs](http://lord.github.io/slate). +Getting started with Slate is super easy! Simply fork this repository and follow the instructions below. Or, if you'd like to check out what Slate is capable of, take a look at the [sample docs](https://slatedocs.github.io/slate/). Getting Started with Slate ------------------------------ @@ -60,9 +60,9 @@ vagrant up You can now see the docs at http://localhost:4567. Whoa! That was fast! -Now that Slate is all set up on your machine, you'll probably want to learn more about [editing Slate markdown](https://github.com/lord/slate/wiki/Markdown-Syntax), or [how to publish your docs](https://github.com/lord/slate/wiki/Deploying-Slate). +Now that Slate is all set up on your machine, you'll probably want to learn more about [editing Slate markdown](https://github.com/slatedocs/slate/wiki/Markdown-Syntax), or [how to publish your docs](https://github.com/slatedocs/slate/wiki/Deploying-Slate). -If you'd prefer to use Docker, instructions are available [in the wiki](https://github.com/lord/slate/wiki/Docker). +If you'd prefer to use Docker, instructions are available [in the wiki](https://github.com/slatedocs/slate/wiki/Docker). ### Note on JavaScript Runtime @@ -83,14 +83,14 @@ Companies Using Slate * [Parrot Drones](http://developer.parrot.com/docs/bebop/) * [Scale](https://docs.scaleapi.com/) -You can view more in [the list on the wiki](https://github.com/lord/slate/wiki/Slate-in-the-Wild). +You can view more in [the list on the wiki](https://github.com/slatedocs/slate/wiki/Slate-in-the-Wild). Questions? Need Help? Found a bug? -------------------- If you've got questions about setup, deploying, special feature implementation in your fork, or just want to chat with the developer, please feel free to [start a thread in our Spectrum community](https://spectrum.chat/slate)! -Found a bug with upstream Slate? Go ahead and [submit an issue](https://github.com/lord/slate/issues). And, of course, feel free to submit pull requests with bug fixes or changes to the `dev` branch. +Found a bug with upstream Slate? Go ahead and [submit an issue](https://github.com/slatedocs/slate/issues). And, of course, feel free to submit pull requests with bug fixes or changes to the `dev` branch. Contributors -------------------- From b3a4f1f5c575940eb23e6c53dba7106caaf58f76 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Mon, 14 Oct 2019 16:04:23 -0300 Subject: [PATCH 14/46] Update url for travis badge --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 04081e5aa3f..d1e1768e2d9 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

Slate: API Documentation Generator
- Build Status + Build Status

Slate helps you create beautiful, intelligent, responsive API documentation.

From bc5b66f9f8c728e3a6c59cd11b2699767a4d4dac Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Sat, 19 Oct 2019 04:40:44 -0300 Subject: [PATCH 15/46] [Security] Upgrade nokogiri to 1.10.4 (#1150) --- Gemfile | 2 +- Gemfile.lock | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Gemfile b/Gemfile index a77f013adca..d6ec76e6ffa 100644 --- a/Gemfile +++ b/Gemfile @@ -8,5 +8,5 @@ gem 'middleman-autoprefixer', '~> 2.7' gem 'middleman-sprockets', '~> 4.1' gem 'rouge', '~> 2.0.5' gem 'redcarpet', '~> 3.4.0' -gem 'nokogiri', '~> 1.8.5' +gem 'nokogiri', '~> 1.10.4' gem 'sass' diff --git a/Gemfile.lock b/Gemfile.lock index 142d13eeec8..15e3d633504 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -76,10 +76,10 @@ GEM middleman-syntax (3.0.0) middleman-core (>= 3.2) rouge (~> 2.0) - mini_portile2 (2.3.0) + mini_portile2 (2.4.0) minitest (5.11.3) - nokogiri (1.8.5) - mini_portile2 (~> 2.3.0) + nokogiri (1.10.4) + mini_portile2 (~> 2.4.0) padrino-helpers (0.13.3.4) i18n (~> 0.6, >= 0.6.7) padrino-support (= 0.13.3.4) @@ -124,7 +124,7 @@ DEPENDENCIES middleman-autoprefixer (~> 2.7) middleman-sprockets (~> 4.1) middleman-syntax (~> 3.0) - nokogiri (~> 1.8.5) + nokogiri (~> 1.10.4) redcarpet (~> 3.4.0) rouge (~> 2.0.5) sass @@ -133,4 +133,4 @@ RUBY VERSION ruby 2.3.3p222 BUNDLED WITH - 2.0.1 + 2.0.2 From 2019c63b839d7dc70c7258f0b52b368e95343f9a Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Sat, 19 Oct 2019 04:56:11 -0300 Subject: [PATCH 16/46] Cut version 2.4.0 --- CHANGELOG.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 218f5caa99e..496939c105a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,19 @@ # Changelog +## Version 2.4.0 + +*October 19, 2019* + +- Move repository from lord/slate to slatedocs/slate +- Fix documentation to point at new repo link, thanks to [Arun](https://github.com/slash-arun), [Gustavo Gawryszewski](https://github.com/gawry), and [Daniel Korbit](https://github.com/danielkorbit) +- Update `nokogiri` to 1.10.4 +- Update `ffi` in `Gemfile.lock` to fix security warnings, thanks to [Grey Baker](https://github.com/greysteil) and [jackmack](https://github.com/jakemack) +- Update `rack` to 2.0.7 in `Gemfile.lock` to fix security warnings, thanks to [Grey Baker](https://github.com/greysteil) and [jackmack](https://github.com/jakemack) +- Update middleman to `4.3` and relax constraints on middleman related gems, thanks to [jackmack](https://github.com/jakemack) +- Add sass gem, thanks to [jackmack](https://github.com/jackmack) +- Activate `asset_cache` in middleman to improve cacheability of static files, thanks to [Sam Gilman](https://github.com/thenengah) +- Update to using bundler 2 for `Gemfile.lock`, thanks to [jackmack](https://github.com/jakemack) + ## Version 2.3.1 *July 5, 2018* From c51fa227cf8012d6e1d69b7091f7fa1d1e274e0b Mon Sep 17 00:00:00 2001 From: BigBlueHat Date: Fri, 10 Jan 2020 09:27:41 -0500 Subject: [PATCH 17/46] Use the full Apache License 2.0 text in LICENSE Per the Apache Software Foundation guidelines for applying the Apache License 2.0: https://www.apache.org/foundation/license-faq.html#Apply-My-Software > You should include a copy of the Apache License, typically in a file called LICENSE, in your work, and consider also including a NOTICE file. --- LICENSE | 208 +++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 198 insertions(+), 10 deletions(-) diff --git a/LICENSE b/LICENSE index 5ceddf59f68..261eeb9e9f8 100644 --- a/LICENSE +++ b/LICENSE @@ -1,13 +1,201 @@ -Copyright 2008-2013 Concur Technologies, Inc. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ -Licensed under the Apache License, Version 2.0 (the "License"); you may -not use this file except in compliance with the License. You may obtain -a copy of the License at + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - http://www.apache.org/licenses/LICENSE-2.0 + 1. Definitions. -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -License for the specific language governing permissions and limitations -under the License. \ No newline at end of file + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. From 274949c002b5bae5385ff112cc0889de3a28ca11 Mon Sep 17 00:00:00 2001 From: Alex Mayer Date: Tue, 4 Feb 2020 08:32:50 -0500 Subject: [PATCH 18/46] Update GitHub Links on example generated site (#1196) --- source/index.html.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/index.html.md b/source/index.html.md index e101e66ef94..27cf28aa991 100644 --- a/source/index.html.md +++ b/source/index.html.md @@ -9,7 +9,7 @@ language_tabs: # must be one of https://git.io/vQNgJ toc_footers: - Sign Up for a Developer Key - - Documentation Powered by Slate + - Documentation Powered by Slate includes: - errors @@ -23,7 +23,7 @@ Welcome to the Kittn API! You can use our API to access Kittn API endpoints, whi We have language bindings in Shell, Ruby, Python, and JavaScript! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right. -This example API documentation page was created with [Slate](https://github.com/lord/slate). Feel free to edit it and use it as a base for your own API's documentation. +This example API documentation page was created with [Slate](https://github.com/slatedocs/slate). Feel free to edit it and use it as a base for your own API's documentation. # Authentication From 1be12d20273e22f77f1459e48dce38c99204091d Mon Sep 17 00:00:00 2001 From: Brad Thurber Date: Thu, 31 Oct 2019 08:16:12 -0400 Subject: [PATCH 19/46] Update Vagrantfile to Ubuntu 18.04 (#1158) * Slate 2.4 breaks vagrant * Update Vagrantfile * Update Vagrantfile --- Vagrantfile | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/Vagrantfile b/Vagrantfile index 6f2444e2133..0ad63944257 100644 --- a/Vagrantfile +++ b/Vagrantfile @@ -1,5 +1,5 @@ Vagrant.configure(2) do |config| - config.vm.box = "ubuntu/trusty64" + config.vm.box = "ubuntu/bionic64" config.vm.network :forwarded_port, guest: 4567, host: 4567 config.vm.provider "virtualbox" do |vb| vb.memory = "2048" @@ -8,12 +8,11 @@ Vagrant.configure(2) do |config| config.vm.provision "bootstrap", type: "shell", inline: <<-SHELL - sudo apt-add-repository ppa:brightbox/ruby-ng sudo apt-get update - sudo apt-get install -yq ruby2.4 ruby2.4-dev + sudo apt-get install -yq ruby ruby-dev sudo apt-get install -yq pkg-config build-essential nodejs git libxml2-dev libxslt-dev sudo apt-get autoremove -yq - gem2.4 install --no-ri --no-rdoc bundler + gem install --no-ri --no-rdoc bundler SHELL # add the local user git config to the vm From 73e45c537c9cbabd09256626b6ac691164b21be6 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Thu, 31 Oct 2019 09:20:14 -0300 Subject: [PATCH 20/46] Ignore generated log file from running Vagrant --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index 10501583560..1d5d08dd245 100644 --- a/.gitignore +++ b/.gitignore @@ -22,3 +22,6 @@ build/ _yardoc doc/ .idea/ + +# Vagrant artifacts +ubuntu-*-console.log From 391f3d82065f2ec0ed762d86dc0285fe825a8755 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Thu, 31 Oct 2019 12:05:53 -0300 Subject: [PATCH 21/46] Update tested versions of ruby on Travis (#1160) --- .travis.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.travis.yml b/.travis.yml index 9b52b6b18db..f51c859e4bb 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,14 +1,14 @@ -sudo: false - language: ruby - rvm: - - 2.3.3 - - 2.4.0 + - 2.3 + - 2.4 + - 2.5 + - 2.6 + +cache: bundler before_install: - gem update --system - gem install bundler -cache: bundler script: bundle exec middleman build From 252a48b31e7d34b4099b590bead3ea021a65cff6 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Tue, 5 Nov 2019 10:39:26 -0300 Subject: [PATCH 22/46] Fully parse arguments first in deploy (#1153) * Do not build sources when using --help * Use variables for build/push if statements * fix error message --- deploy.sh | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/deploy.sh b/deploy.sh index f122ba7ce62..f872d23f713 100755 --- a/deploy.sh +++ b/deploy.sh @@ -36,7 +36,7 @@ parse_args() { while : ; do if [[ $1 = "-h" || $1 = "--help" ]]; then echo "$help_message" - return 0 + exit 0 elif [[ $1 = "-v" || $1 = "--verbose" ]]; then verbose=true shift @@ -49,11 +49,22 @@ parse_args() { elif [[ $1 = "-n" || $1 = "--no-hash" ]]; then GIT_DEPLOY_APPEND_HASH=false shift + elif [[ $1 = "--source-only" ]]; then + source_only=true + shift + elif [[ $1 = "--push-only" ]]; then + push_only=true + shift else break fi done + if [ ${source_only} ] && [ ${push_only} ]; then + >&2 echo "You can only specify one of --source-only or --push-only" + exit 1 + fi + # Set internal option vars from the environment and arg flags. All internal # vars should be declared here, with sane defaults if applicable. @@ -73,8 +84,6 @@ parse_args() { } main() { - parse_args "$@" - enable_expanded_output if ! git diff --exit-code --quiet --cached; then @@ -205,9 +214,11 @@ sanitize() { "$@" 2> >(filter 1>&2) | filter } -if [[ $1 = --source-only ]]; then +parse_args "$@" + +if [[ ${source_only} ]]; then run_build -elif [[ $1 = --push-only ]]; then +elif [[ ${push_only} ]]; then main "$@" else run_build From a4854b03a4e4df8d016c2144fbcc831af0b6b8eb Mon Sep 17 00:00:00 2001 From: Robert Lord Date: Tue, 3 Dec 2019 10:14:59 -0500 Subject: [PATCH 23/46] List maintainers in README (#1164) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d1e1768e2d9..fa3c23487c0 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,7 @@ Found a bug with upstream Slate? Go ahead and [submit an issue](https://github.c Contributors -------------------- -Slate was built by [Robert Lord](https://lord.io) while interning at [TripIt](https://www.tripit.com/). +Slate was built by [Robert Lord](https://lord.io) while at [TripIt](https://www.tripit.com/). The project is now maintained by [Matthew Peveler](https://github.com/MasterOdin) and [Mike Ralphson](https://github.com/MikeRalphson). Thanks to the following people who have submitted major pull requests: From 375af3c6cc9945e4305359c59981e4b8dbf77c84 Mon Sep 17 00:00:00 2001 From: Fernando Aguilar Date: Wed, 19 Feb 2020 10:00:58 -0800 Subject: [PATCH 24/46] Install nodejs in Vagrantfile (#1202) Co-authored-by: Matthew Peveler --- Vagrantfile | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Vagrantfile b/Vagrantfile index 0ad63944257..4166fb6ba24 100644 --- a/Vagrantfile +++ b/Vagrantfile @@ -8,6 +8,9 @@ Vagrant.configure(2) do |config| config.vm.provision "bootstrap", type: "shell", inline: <<-SHELL + # add nodejs v12 repository + curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash - + sudo apt-get update sudo apt-get install -yq ruby ruby-dev sudo apt-get install -yq pkg-config build-essential nodejs git libxml2-dev libxslt-dev From d11eb1f13c50428c0780b55b4fc84dffe4820e8e Mon Sep 17 00:00:00 2001 From: KaliArch <18329903316@163.com> Date: Thu, 2 Apr 2020 21:27:33 +0800 Subject: [PATCH 25/46] add Dockerfile (#1124) * add Dockerfile add Dockerfile * Update Dockerfile Co-authored-by: Matthew Peveler --- Dockerfile | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 Dockerfile diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000000..5a9526fd42f --- /dev/null +++ b/Dockerfile @@ -0,0 +1,21 @@ +FROM ruby:2.5-alpine + +RUN apk --no-cache add \ + g++ \ + gcc \ + libc-dev \ + make \ + nodejs \ + && gem install bundler + +WORKDIR /srv/slate + +COPY . /srv/slate + +RUN bundle install + +VOLUME /srv/slate/source + +EXPOSE 4567 + +CMD ["bundle", "exec", "middleman", "server", "--watcher-force-polling"] From 7cecafe5ff7b1dcb8ae18a9903ad0bf0eb0ff387 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Thu, 2 Apr 2020 09:29:14 -0400 Subject: [PATCH 26/46] add instructions to running docker to README Signed-off-by: Matthew Peveler --- .dockerignore | 2 ++ README.md | 4 ++++ 2 files changed, 6 insertions(+) create mode 100644 .dockerignore diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 00000000000..1cf061121fc --- /dev/null +++ b/.dockerignore @@ -0,0 +1,2 @@ +build/ +.github/ diff --git a/README.md b/README.md index fa3c23487c0..0166dc1a876 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,10 @@ bundle exec middleman server # OR run this to run with vagrant vagrant up + +# OR run this to run with docker +docker build . -t slate:latest # this only needs to be run once +docker run -p 4567:4567 -v $(pwd)/source:/srv/slate/source slate:latest ``` You can now see the docs at http://localhost:4567. Whoa! That was fast! From a8eb386690684e2296d2e64ba099c121338d82d0 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Thu, 2 Apr 2020 20:53:30 -0400 Subject: [PATCH 27/46] Remove line in README about Docker wiki Signed-off-by: Matthew Peveler --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 0166dc1a876..e695302cf19 100644 --- a/README.md +++ b/README.md @@ -66,8 +66,6 @@ You can now see the docs at http://localhost:4567. Whoa! That was fast! Now that Slate is all set up on your machine, you'll probably want to learn more about [editing Slate markdown](https://github.com/slatedocs/slate/wiki/Markdown-Syntax), or [how to publish your docs](https://github.com/slatedocs/slate/wiki/Deploying-Slate). -If you'd prefer to use Docker, instructions are available [in the wiki](https://github.com/slatedocs/slate/wiki/Docker). - ### Note on JavaScript Runtime For those who don't have JavaScript runtime or are experiencing JavaScript runtime issues with ExecJS, it is recommended to add the [rubyracer gem](https://github.com/cowboyd/therubyracer) to your gemfile and run `bundle` again. From f31c73831ec86e77606e1754886d3ea339c73184 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Fri, 3 Apr 2020 16:25:19 -0400 Subject: [PATCH 28/46] update middleman dep to 4.3.6 Signed-off-by: Matthew Peveler --- Gemfile.lock | 52 +++++++++++++++++++++++++--------------------------- 1 file changed, 25 insertions(+), 27 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 15e3d633504..68a69be694d 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -6,24 +6,24 @@ GEM i18n (>= 0.7, < 2) minitest (~> 5.1) tzinfo (~> 1.1) - addressable (2.6.0) - public_suffix (>= 2.0.2, < 4.0) + addressable (2.7.0) + public_suffix (>= 2.0.2, < 5.0) autoprefixer-rails (9.5.1.1) execjs - backports (3.15.0) + backports (3.17.0) coffee-script (2.4.1) coffee-script-source execjs coffee-script-source (1.12.2) - concurrent-ruby (1.1.5) + concurrent-ruby (1.1.6) contracts (0.13.0) - dotenv (2.7.2) + dotenv (2.7.5) erubis (2.7.0) execjs (2.7.0) fast_blank (1.0.0) - fastimage (2.1.5) - ffi (1.11.1) - haml (5.1.1) + fastimage (2.1.7) + ffi (1.12.2) + haml (5.1.2) temple (>= 0.8.0) tilt hamster (3.0.0) @@ -35,19 +35,19 @@ GEM listen (3.0.8) rb-fsevent (~> 0.9, >= 0.9.4) rb-inotify (~> 0.9, >= 0.9.7) - memoist (0.16.0) - middleman (4.3.4) + memoist (0.16.2) + middleman (4.3.6) coffee-script (~> 2.2) haml (>= 4.0.5) kramdown (~> 1.2) - middleman-cli (= 4.3.4) - middleman-core (= 4.3.4) + middleman-cli (= 4.3.6) + middleman-core (= 4.3.6) middleman-autoprefixer (2.10.1) autoprefixer-rails (~> 9.1) middleman-core (>= 3.3.3) - middleman-cli (4.3.4) + middleman-cli (4.3.6) thor (>= 0.17.0, < 2.0) - middleman-core (4.3.4) + middleman-core (4.3.6) activesupport (>= 4.2, < 5.1) addressable (~> 2.3) backports (~> 3.6) @@ -77,7 +77,7 @@ GEM middleman-core (>= 3.2) rouge (~> 2.0) mini_portile2 (2.4.0) - minitest (5.11.3) + minitest (5.14.0) nokogiri (1.10.4) mini_portile2 (~> 2.4.0) padrino-helpers (0.13.3.4) @@ -86,12 +86,11 @@ GEM tilt (>= 1.4.1, < 3) padrino-support (0.13.3.4) activesupport (>= 3.1) - parallel (1.17.0) - public_suffix (3.1.0) - rack (2.0.7) - rake (12.3.2) + parallel (1.19.1) + public_suffix (4.0.3) + rack (2.2.2) rb-fsevent (0.10.3) - rb-inotify (0.10.0) + rb-inotify (0.10.1) ffi (~> 1.0) redcarpet (3.4.0) rouge (2.0.7) @@ -100,18 +99,17 @@ GEM sass-listen (4.0.0) rb-fsevent (~> 0.9, >= 0.9.4) rb-inotify (~> 0.9, >= 0.9.7) - sassc (2.0.1) + sassc (2.2.1) ffi (~> 1.9) - rake servolux (0.13.0) sprockets (3.7.2) concurrent-ruby (~> 1.0) rack (> 1, < 3) - temple (0.8.1) - thor (0.20.3) + temple (0.8.2) + thor (1.0.1) thread_safe (0.3.6) - tilt (2.0.9) - tzinfo (1.2.5) + tilt (2.0.10) + tzinfo (1.2.7) thread_safe (~> 0.1) uglifier (3.2.0) execjs (>= 0.3.0, < 3) @@ -133,4 +131,4 @@ RUBY VERSION ruby 2.3.3p222 BUNDLED WITH - 2.0.2 + 2.1.4 From 88b28d4d6f684d3940f208f76481ccc23f391e08 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Fri, 3 Apr 2020 16:34:14 -0400 Subject: [PATCH 29/46] update middleman-syntax and rouge to ~>3.2 Signed-off-by: Matthew Peveler --- Gemfile | 4 ++-- Gemfile.lock | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Gemfile b/Gemfile index d6ec76e6ffa..80d521548e2 100644 --- a/Gemfile +++ b/Gemfile @@ -3,10 +3,10 @@ source 'https://rubygems.org' # Middleman gem 'middleman', '~>4.3' -gem 'middleman-syntax', '~> 3.0' +gem 'middleman-syntax', '~> 3.2' gem 'middleman-autoprefixer', '~> 2.7' gem 'middleman-sprockets', '~> 4.1' -gem 'rouge', '~> 2.0.5' +gem 'rouge', '~> 3.2' gem 'redcarpet', '~> 3.4.0' gem 'nokogiri', '~> 1.10.4' gem 'sass' diff --git a/Gemfile.lock b/Gemfile.lock index 68a69be694d..08acc767875 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -73,9 +73,9 @@ GEM middleman-sprockets (4.1.1) middleman-core (~> 4.0) sprockets (>= 3.0) - middleman-syntax (3.0.0) + middleman-syntax (3.2.0) middleman-core (>= 3.2) - rouge (~> 2.0) + rouge (~> 3.2) mini_portile2 (2.4.0) minitest (5.14.0) nokogiri (1.10.4) @@ -93,7 +93,7 @@ GEM rb-inotify (0.10.1) ffi (~> 1.0) redcarpet (3.4.0) - rouge (2.0.7) + rouge (3.17.0) sass (3.7.4) sass-listen (~> 4.0.0) sass-listen (4.0.0) @@ -121,10 +121,10 @@ DEPENDENCIES middleman (~> 4.3) middleman-autoprefixer (~> 2.7) middleman-sprockets (~> 4.1) - middleman-syntax (~> 3.0) + middleman-syntax (~> 3.2) nokogiri (~> 1.10.4) redcarpet (~> 3.4.0) - rouge (~> 2.0.5) + rouge (~> 3.2) sass RUBY VERSION From 5b25b04c343cd4fe059e519876c016dc2803bd94 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Fri, 8 May 2020 19:31:43 -0400 Subject: [PATCH 30/46] update nokogiri to ~> 1.10.8 Signed-off-by: Matthew Peveler --- Gemfile | 2 +- Gemfile.lock | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Gemfile b/Gemfile index 80d521548e2..95029e39a5c 100644 --- a/Gemfile +++ b/Gemfile @@ -8,5 +8,5 @@ gem 'middleman-autoprefixer', '~> 2.7' gem 'middleman-sprockets', '~> 4.1' gem 'rouge', '~> 3.2' gem 'redcarpet', '~> 3.4.0' -gem 'nokogiri', '~> 1.10.4' +gem 'nokogiri', '~> 1.10.8' gem 'sass' diff --git a/Gemfile.lock b/Gemfile.lock index 08acc767875..d6d48a62fd2 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -78,7 +78,7 @@ GEM rouge (~> 3.2) mini_portile2 (2.4.0) minitest (5.14.0) - nokogiri (1.10.4) + nokogiri (1.10.9) mini_portile2 (~> 2.4.0) padrino-helpers (0.13.3.4) i18n (~> 0.6, >= 0.6.7) @@ -122,7 +122,7 @@ DEPENDENCIES middleman-autoprefixer (~> 2.7) middleman-sprockets (~> 4.1) middleman-syntax (~> 3.2) - nokogiri (~> 1.10.4) + nokogiri (~> 1.10.8) redcarpet (~> 3.4.0) rouge (~> 3.2) sass From 4f5b12fe86e49345c42b5fafb6424dce96613766 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Fri, 8 May 2020 20:12:50 -0400 Subject: [PATCH 31/46] add 2.5.0 release to changelog Signed-off-by: Matthew Peveler --- CHANGELOG.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 496939c105a..8d318cb8558 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,20 @@ # Changelog +## Version 2.5.0 + +*May 8, 2020* + +* __[security]__ update nokogiri to ~> 1.10.8 +* Update links in example docs to https://github.com/slatedocs/slate from https://github.com/lord/slate +* Update LICENSE to include full Apache 2.0 text +* Test slate against Ruby 2.5 and 2.6 on Travis-CI +* Update Vagrantfile to use Ubuntu 18.04 (thanks @bradthurber) +* Parse arguments and flags for deploy.sh on script start, instead of potentially after building source files +* Install nodejs inside Vagrantfile (thanks @fernandoaguilar) +* Add Dockerfile for running slate (thanks @redhatxl) +* update middleman-syntax and rouge to ~>3.2 +* update middleman to 4.3.6 + ## Version 2.4.0 *October 19, 2019* From 33c4acc09972dca0a58d4f6c5c18f4c19d113253 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Tue, 12 May 2020 18:45:41 +0300 Subject: [PATCH 32/46] update screenshot in README with new rouge styling (#1228) Signed-off-by: Matthew Peveler --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e695302cf19..a12f37c91a1 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@

- Slate: API Documentation Generator + Slate: API Documentation Generator
Build Status

Slate helps you create beautiful, intelligent, responsive API documentation.

-

Screenshot of Example Documentation created with Slate

+

Screenshot of Example Documentation created with Slate

The example above was created with Slate. Check it out at slatedocs.github.io/slate.

From aace071f89993ccbaf3809273bdeaf199c0ebf90 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Tue, 12 May 2020 15:33:23 +0300 Subject: [PATCH 33/46] fix bc style breaks from rouge 3.x (#1226) * fix bc style breaks from rouge 3.x Signed-off-by: Matthew Peveler * use bright_pink for Name::Label Signed-off-by: Matthew Peveler --- config.rb | 1 + lib/monokai_sublime_slate.rb | 95 ++++++++++++++++++++++++++++++ source/layouts/layout.erb | 2 +- source/stylesheets/screen.css.scss | 4 ++ 4 files changed, 101 insertions(+), 1 deletion(-) create mode 100644 lib/monokai_sublime_slate.rb diff --git a/config.rb b/config.rb index b3ba23ed052..22e956dd8df 100644 --- a/config.rb +++ b/config.rb @@ -23,6 +23,7 @@ # Activate the syntax highlighter activate :syntax ready do + require './lib/monokai_sublime_slate.rb' require './lib/multilang.rb' end diff --git a/lib/monokai_sublime_slate.rb b/lib/monokai_sublime_slate.rb new file mode 100644 index 00000000000..cd2de33172d --- /dev/null +++ b/lib/monokai_sublime_slate.rb @@ -0,0 +1,95 @@ +# -*- coding: utf-8 -*- # +# frozen_string_literal: true + +# this is based on https://github.com/rouge-ruby/rouge/blob/master/lib/rouge/themes/monokai_sublime.rb +# but without the added background, and changed styling for JSON keys to be soft_yellow instead of white + +module Rouge + module Themes + class MonokaiSublimeSlate < CSSTheme + name 'monokai.sublime.slate' + + palette :black => '#000000' + palette :bright_green => '#a6e22e' + palette :bright_pink => '#f92672' + palette :carmine => '#960050' + palette :dark => '#49483e' + palette :dark_grey => '#888888' + palette :dark_red => '#aa0000' + palette :dimgrey => '#75715e' + palette :emperor => '#555555' + palette :grey => '#999999' + palette :light_grey => '#aaaaaa' + palette :light_violet => '#ae81ff' + palette :soft_cyan => '#66d9ef' + palette :soft_yellow => '#e6db74' + palette :very_dark => '#1e0010' + palette :whitish => '#f8f8f2' + palette :orange => '#f6aa11' + palette :white => '#ffffff' + + style Generic::Heading, :fg => :grey + style Literal::String::Regex, :fg => :orange + style Generic::Output, :fg => :dark_grey + style Generic::Prompt, :fg => :emperor + style Generic::Strong, :bold => false + style Generic::Subheading, :fg => :light_grey + style Name::Builtin, :fg => :orange + style Comment::Multiline, + Comment::Preproc, + Comment::Single, + Comment::Special, + Comment, :fg => :dimgrey + style Error, + Generic::Error, + Generic::Traceback, :fg => :carmine + style Generic::Deleted, + Generic::Inserted, + Generic::Emph, :fg => :dark + style Keyword::Constant, + Keyword::Declaration, + Keyword::Reserved, + Name::Constant, + Keyword::Type, :fg => :soft_cyan + style Literal::Number::Float, + Literal::Number::Hex, + Literal::Number::Integer::Long, + Literal::Number::Integer, + Literal::Number::Oct, + Literal::Number, + Literal::String::Char, + Literal::String::Escape, + Literal::String::Symbol, :fg => :light_violet + style Literal::String::Doc, + Literal::String::Double, + Literal::String::Backtick, + Literal::String::Heredoc, + Literal::String::Interpol, + Literal::String::Other, + Literal::String::Single, + Literal::String, :fg => :soft_yellow + style Name::Attribute, + Name::Class, + Name::Decorator, + Name::Exception, + Name::Function, :fg => :bright_green + style Name::Variable::Class, + Name::Namespace, + Name::Entity, + Name::Builtin::Pseudo, + Name::Variable::Global, + Name::Variable::Instance, + Name::Variable, + Text::Whitespace, + Text, + Name, :fg => :white + style Name::Label, :fg => :bright_pink + style Operator::Word, + Name::Tag, + Keyword, + Keyword::Namespace, + Keyword::Pseudo, + Operator, :fg => :bright_pink + end + end + end diff --git a/source/layouts/layout.erb b/source/layouts/layout.erb index 29b80d72a32..14537281a17 100644 --- a/source/layouts/layout.erb +++ b/source/layouts/layout.erb @@ -32,7 +32,7 @@ under the License. <%= current_page.data.title || "API Documentation" %> <%= stylesheet_link_tag :screen, media: :screen %> <%= stylesheet_link_tag :print, media: :print %> diff --git a/source/stylesheets/screen.css.scss b/source/stylesheets/screen.css.scss index 83da68cca2c..ed23b312215 100644 --- a/source/stylesheets/screen.css.scss +++ b/source/stylesheets/screen.css.scss @@ -511,6 +511,10 @@ html, body { // This is all the stuff that appears in the right half of the page .content { + &>div.highlight { + clear:none; + } + pre, blockquote { background-color: $code-bg; color: #fff; From 589df5fd21eaeee25456e2edabec433c5a1d61d7 Mon Sep 17 00:00:00 2001 From: lord Date: Sat, 16 May 2020 09:38:35 -0700 Subject: [PATCH 34/46] Change instructions to use templates instead of forking (#1234) --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a12f37c91a1..7d5e450233a 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Features * **RTL Support** Full right-to-left layout for RTL languages such as Arabic, Persian (Farsi), Hebrew etc. -Getting started with Slate is super easy! Simply fork this repository and follow the instructions below. Or, if you'd like to check out what Slate is capable of, take a look at the [sample docs](https://slatedocs.github.io/slate/). +Getting started with Slate is super easy! Simply press the green "use this template" button above and follow the instructions below. Or, if you'd like to check out what Slate is capable of, take a look at the [sample docs](https://slatedocs.github.io/slate/). Getting Started with Slate ------------------------------ @@ -44,10 +44,11 @@ You're going to need: ### Getting Set Up -1. Fork this repository on GitHub. -2. Clone *your forked repository* (not our original one) to your hard drive with `git clone https://github.com/YOURUSERNAME/slate.git` -3. `cd slate` -4. Initialize and start Slate. You can either do this locally, or with Vagrant: +1. Press the green "use this template" button at the top of this page. +2. Follow the instructions to create a new copy of the Slate repository. +3. Clone your repository (not our original one) to your hard drive with `git clone https://github.com/YOURUSERNAME/slate.git` +4. `cd slate` +5. Initialize and start Slate. You can either do this locally, or with Vagrant: ```shell # either run this to run locally From 8c329dcf2a6bf44a64ce06bffb7827846f1b09c9 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Mon, 18 May 2020 07:16:00 +0300 Subject: [PATCH 35/46] disable asset hash for woff and woff2 files out of the box (#1231) Signed-off-by: Matthew Peveler --- config.rb | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/config.rb b/config.rb index 22e956dd8df..6f8b677f617 100644 --- a/config.rb +++ b/config.rb @@ -41,13 +41,16 @@ # Build Configuration configure :build do - activate :asset_hash + # We do want to hash woff and woff2 as there's a bug where woff2 will use + # woff asset hash which breaks things. Trying to use a combination of ignore and + # rewrite_ignore does not work as it conflicts weirdly with relative_assets. Disabling + # the .woff2 extension only does not work as .woff will still activate it so have to + # have both. See https://github.com/slatedocs/slate/issues/1171 for more details. + activate :asset_hash, :exts => app.config[:asset_extensions] - %w[.woff .woff2] # If you're having trouble with Middleman hanging, commenting # out the following two lines has been known to help activate :minify_css activate :minify_javascript - # activate :relative_assets - # activate :asset_hash # activate :gzip end From 8bea1238ab3eeedbfb869bf798f38db4c0423b2a Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Mon, 18 May 2020 07:16:10 +0300 Subject: [PATCH 36/46] switch to using debian for docker base for bash (#1233) Signed-off-by: Matthew Peveler --- Dockerfile | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/Dockerfile b/Dockerfile index 5a9526fd42f..33b80ca4216 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,21 +1,20 @@ -FROM ruby:2.5-alpine - -RUN apk --no-cache add \ - g++ \ - gcc \ - libc-dev \ - make \ - nodejs \ - && gem install bundler +FROM ruby:2.6-slim WORKDIR /srv/slate -COPY . /srv/slate - -RUN bundle install - VOLUME /srv/slate/source - EXPOSE 4567 +COPY . /srv/slate + +RUN apt-get update \ + && apt-get install -y --no-install-recommends \ + build-essential \ + nodejs \ + && gem install bundler \ + && bundle install \ + && apt-get remove -y build-essential \ + && apt-get autoremove -y \ + && rm -rf /var/lib/apt/lists/* + CMD ["bundle", "exec", "middleman", "server", "--watcher-force-polling"] From 3582930885fe0e4641f542281da7aeee32d0594f Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Tue, 19 May 2020 16:51:24 -0400 Subject: [PATCH 37/46] update sassc to 2.3.0 in Gemfile.lock Signed-off-by: Matthew Peveler --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index d6d48a62fd2..76bafa3044d 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -99,7 +99,7 @@ GEM sass-listen (4.0.0) rb-fsevent (~> 0.9, >= 0.9.4) rb-inotify (~> 0.9, >= 0.9.7) - sassc (2.2.1) + sassc (2.3.0) ffi (~> 1.9) servolux (0.13.0) sprockets (3.7.2) From f0e8682e78d8a142f14f9c4336aab8aab0596a95 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Tue, 19 May 2020 23:52:20 +0300 Subject: [PATCH 38/46] v2.6.0 release Signed-off-by: Matthew Peveler --- CHANGELOG.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8d318cb8558..493b25f0c41 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,19 @@ # Changelog +## Version 2.6.0 + +*May 18, 2020* + +__Note__: 2.5.0 was "pulled" due to a breaking bug discovered after release. It is recommended to skip it, and move straight to 2.6.0. + +* Fix large whitespace gap in middle column for sections with codeblocks +* Fix highlighted code elements having a different background than rest of code block +* Change JSON keys to have a different font color than their values +* Disable asset hashing for woff and woff2 elements due to middleman bug breaking woff2 asset hashing in general +* Move Dockerfile to Debian from Alpine +* Converted repo to a [GitHub template](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-template-repository) +* Update sassc to 2.3.0 in Gemfile.lock + ## Version 2.5.0 *May 8, 2020* From c7c9eaa27fdc69b9bcbc64bda8f6ad7f580fa327 Mon Sep 17 00:00:00 2001 From: lord Date: Thu, 21 May 2020 15:21:14 -0700 Subject: [PATCH 39/46] Update bug report templates, remove links to Spectrum (#1239) --- .github/ISSUE_TEMPLATE/bug.md | 22 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++++ .github/ISSUE_TEMPLATE/start-here.md | 27 --------------------------- README.md | 2 +- 4 files changed, 28 insertions(+), 28 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/start-here.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 00000000000..25fcdb1d2e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,22 @@ +--- +name: Report a Bug +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Bug Description** +A clear and concise description of what the bug is and how to reproduce it. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Browser (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Last upstream Slate commit (run `git log --author="Robert Lord" | head -n 1`):** +Put the commit hash here diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..16f4beed616 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Questions, Ideas, Discussions + url: https://github.com/slatedocs/slate/discussions + about: Ask and answer questions, and propose new features. diff --git a/.github/ISSUE_TEMPLATE/start-here.md b/.github/ISSUE_TEMPLATE/start-here.md deleted file mode 100644 index 4199c901d58..00000000000 --- a/.github/ISSUE_TEMPLATE/start-here.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Start Here -about: Help improve Slate! -title: "✍️ TODO" -labels: '' -assignees: '' - ---- - - https://spectrum.chat/slate <- - -If you've found a bug with Slate upstream that you're still encountering even in a lightly modified Slate, you're in the right place! Please fill out the form below with the issue you're having and we'll take a look. :) ---> - -Operating system: ✍️ TODO -Last upstream commit (run `git log --author="Robert Lord" | head -n 1`): ✍️ TODO -Browser version(s): ✍️ TODO -Ruby version (run `ruby -v`): ✍️ TODO - ---- - -✍️ TODO write your issue here diff --git a/README.md b/README.md index 7d5e450233a..57b3ffa0842 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ You can view more in [the list on the wiki](https://github.com/slatedocs/slate/w Questions? Need Help? Found a bug? -------------------- -If you've got questions about setup, deploying, special feature implementation in your fork, or just want to chat with the developer, please feel free to [start a thread in our Spectrum community](https://spectrum.chat/slate)! +If you've got questions about setup, deploying, special feature implementation in your fork, or just want to chat with the developer, please feel free to [start a thread in our Discussions tab](https://github.com/slatedocs/slate/discussions)! Found a bug with upstream Slate? Go ahead and [submit an issue](https://github.com/slatedocs/slate/issues). And, of course, feel free to submit pull requests with bug fixes or changes to the `dev` branch. From ce2c03444331e863c39ec3ac4afdef5234e94a7a Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Sat, 23 May 2020 17:29:31 +0300 Subject: [PATCH 40/46] Replace travis with github actions (#1240) Signed-off-by: Matthew Peveler --- .github/workflows/build.yml | 36 ++++++++++++++++++++++++++++++++++++ .github/workflows/deploy.yml | 32 ++++++++++++++++++++++++++++++++ .travis.yml | 14 -------------- README.md | 2 +- 4 files changed, 69 insertions(+), 15 deletions(-) create mode 100644 .github/workflows/build.yml create mode 100644 .github/workflows/deploy.yml delete mode 100644 .travis.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 00000000000..3d55c61d605 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,36 @@ +name: Build + +on: + push: + branches: [ '*' ] + pull_request: + branches: [ '*' ] + +jobs: + test: + runs-on: ubuntu-latest + + strategy: + matrix: + ruby-version: [2.3, 2.4, 2.5, 2.6, 2.7] + + steps: + - uses: actions/checkout@v2 + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: ${{ matrix.ruby-version }} + + - uses: actions/cache@v1 + with: + path: vendor/bundle + key: gems-${{ runner.os }}-${{ matrix.ruby-version }}-${{ hashFiles('**/Gemfile.lock') }} + + # necessary to get ruby 2.3 to work nicely with bundler vendor/bundle cache + # can remove once ruby 2.3 is no longer supported + - run: gem update --system + + - run: bundle config set deployment 'true' + - run: bundle install + + - run: bundle exec middleman build diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 00000000000..cc64ac35ea5 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,32 @@ +name: Deploy + +on: + push: + branches: [ 'master' ] + +jobs: + test: + runs-on: ubuntu-latest + env: + ruby-version: 2.5 + + steps: + - uses: actions/checkout@v2 + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: ${{ env.ruby-version }} + + - uses: actions/cache@v1 + with: + path: vendor/bundle + key: gems-${{ runner.os }}-${{ env.ruby-version }}-${{ hashFiles('**/Gemfile.lock') }} + + - run: bundle config set deployment 'true' + - run: bundle install + + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./build diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index f51c859e4bb..00000000000 --- a/.travis.yml +++ /dev/null @@ -1,14 +0,0 @@ -language: ruby -rvm: - - 2.3 - - 2.4 - - 2.5 - - 2.6 - -cache: bundler - -before_install: - - gem update --system - - gem install bundler - -script: bundle exec middleman build diff --git a/README.md b/README.md index 57b3ffa0842..fb6dd0ed6e6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

Slate: API Documentation Generator
- Build Status + Build Status

Slate helps you create beautiful, intelligent, responsive API documentation.

From 215e6ee1a630039da8b53b1546e624c388a0f39e Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Sat, 23 May 2020 10:36:58 -0400 Subject: [PATCH 41/46] add missing middleman build step to deploy gh workflow Signed-off-by: Matthew Peveler --- .github/workflows/deploy.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index cc64ac35ea5..7eff1f14ea4 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -5,7 +5,7 @@ on: branches: [ 'master' ] jobs: - test: + deploy: runs-on: ubuntu-latest env: ruby-version: 2.5 @@ -25,6 +25,8 @@ jobs: - run: bundle config set deployment 'true' - run: bundle install + - run: bundle exec middleman build + - name: Deploy uses: peaceiris/actions-gh-pages@v3 with: From 887f6bbf1018b47e9dc225cf326f0a727f16cff8 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Fri, 29 May 2020 00:48:54 +0300 Subject: [PATCH 42/46] Replace README Getting Started with links to wiki (#1246) --- README.md | 41 ++++++----------------------------------- 1 file changed, 6 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index fb6dd0ed6e6..b5f95f0651e 100644 --- a/README.md +++ b/README.md @@ -34,42 +34,13 @@ Getting started with Slate is super easy! Simply press the green "use this templ Getting Started with Slate ------------------------------ -### Prerequisites +To get started with Slate, please check out the Getting Started](https://github.com/slatedocs/slate/wiki#getting-started) +section in our [wiki](https://github.com/slate/wiki). -You're going to need: - - - **Linux or macOS** — Windows may work, but is unsupported. - - **Ruby, version 2.3.1 or newer** - - **Bundler** — If Ruby is already installed, but the `bundle` command doesn't work, just run `gem install bundler` in a terminal. - -### Getting Set Up - -1. Press the green "use this template" button at the top of this page. -2. Follow the instructions to create a new copy of the Slate repository. -3. Clone your repository (not our original one) to your hard drive with `git clone https://github.com/YOURUSERNAME/slate.git` -4. `cd slate` -5. Initialize and start Slate. You can either do this locally, or with Vagrant: - -```shell -# either run this to run locally -bundle install -bundle exec middleman server - -# OR run this to run with vagrant -vagrant up - -# OR run this to run with docker -docker build . -t slate:latest # this only needs to be run once -docker run -p 4567:4567 -v $(pwd)/source:/srv/slate/source slate:latest -``` - -You can now see the docs at http://localhost:4567. Whoa! That was fast! - -Now that Slate is all set up on your machine, you'll probably want to learn more about [editing Slate markdown](https://github.com/slatedocs/slate/wiki/Markdown-Syntax), or [how to publish your docs](https://github.com/slatedocs/slate/wiki/Deploying-Slate). - -### Note on JavaScript Runtime - -For those who don't have JavaScript runtime or are experiencing JavaScript runtime issues with ExecJS, it is recommended to add the [rubyracer gem](https://github.com/cowboyd/therubyracer) to your gemfile and run `bundle` again. +We support running Slate in three different ways: +* [Natively](https://github.com/slatedocs/slate/wiki/Using-Slate-Natively) +* [Using Vagrant](https://github.com/slatedocs/slate/wiki/Using-Slate-in-Vagrant) +* [Using Docker](https://github.com/slatedocs/slate/wiki/Using-Slate-in-Docker) Companies Using Slate --------------------------------- From fb25af567197a8a65dfef6d853916013856e1eca Mon Sep 17 00:00:00 2001 From: "dependabot-preview[bot]" <27856297+dependabot-preview[bot]@users.noreply.github.com> Date: Thu, 28 May 2020 17:52:02 -0400 Subject: [PATCH 43/46] Bump middleman from 4.3.6 to 4.3.7 (#1247) Bumps [middleman](https://github.com/middleman/middleman) from 4.3.6 to 4.3.7. - [Release notes](https://github.com/middleman/middleman/releases) - [Changelog](https://github.com/middleman/middleman/blob/v4.3.7/CHANGELOG.md) - [Commits](https://github.com/middleman/middleman/compare/v4.3.6...v4.3.7) Signed-off-by: dependabot-preview[bot] Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> --- Gemfile.lock | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 76bafa3044d..b3c7f116a3f 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ GEM remote: https://rubygems.org/ specs: - activesupport (5.0.7.2) + activesupport (5.2.4.3) concurrent-ruby (~> 1.0, >= 1.0.2) i18n (>= 0.7, < 2) minitest (~> 5.1) @@ -10,7 +10,7 @@ GEM public_suffix (>= 2.0.2, < 5.0) autoprefixer-rails (9.5.1.1) execjs - backports (3.17.0) + backports (3.17.2) coffee-script (2.4.1) coffee-script-source execjs @@ -36,19 +36,19 @@ GEM rb-fsevent (~> 0.9, >= 0.9.4) rb-inotify (~> 0.9, >= 0.9.7) memoist (0.16.2) - middleman (4.3.6) + middleman (4.3.7) coffee-script (~> 2.2) haml (>= 4.0.5) kramdown (~> 1.2) - middleman-cli (= 4.3.6) - middleman-core (= 4.3.6) + middleman-cli (= 4.3.7) + middleman-core (= 4.3.7) middleman-autoprefixer (2.10.1) autoprefixer-rails (~> 9.1) middleman-core (>= 3.3.3) - middleman-cli (4.3.6) + middleman-cli (4.3.7) thor (>= 0.17.0, < 2.0) - middleman-core (4.3.6) - activesupport (>= 4.2, < 5.1) + middleman-core (4.3.7) + activesupport (>= 4.2, < 6.0) addressable (~> 2.3) backports (~> 3.6) bundler @@ -77,7 +77,7 @@ GEM middleman-core (>= 3.2) rouge (~> 3.2) mini_portile2 (2.4.0) - minitest (5.14.0) + minitest (5.14.1) nokogiri (1.10.9) mini_portile2 (~> 2.4.0) padrino-helpers (0.13.3.4) @@ -87,9 +87,9 @@ GEM padrino-support (0.13.3.4) activesupport (>= 3.1) parallel (1.19.1) - public_suffix (4.0.3) + public_suffix (4.0.5) rack (2.2.2) - rb-fsevent (0.10.3) + rb-fsevent (0.10.4) rb-inotify (0.10.1) ffi (~> 1.0) redcarpet (3.4.0) From 595b532832b1487dae6198e0ffcb35b8ba96fd89 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Sat, 30 May 2020 21:29:38 +0300 Subject: [PATCH 44/46] cut v2.6.1 release (#1249) Signed-off-by: Matthew Peveler --- CHANGELOG.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 493b25f0c41..2ef19cb3b0c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Changelog +## Version 2.6.1 + +*May 30, 2020* + +* __[security]__ update child dependency activesupport in Gemfile.lock to 5.4.2.3 +* Update Middleman in Gemfile.lock to 4.3.7 +* Replace Travis-CI with GitHub actions for continuous integration +* Replace Spectrum with GitHub discussions + ## Version 2.6.0 *May 18, 2020* From 4df1048d4d392f4e6c9234b4334d49ad6af62244 Mon Sep 17 00:00:00 2001 From: Ritesh Kumar Date: Mon, 1 Jun 2020 19:53:29 +0530 Subject: [PATCH 45/46] Fix broken "Getting Started" link in README (#1251) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b5f95f0651e..d052a1139da 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ Getting started with Slate is super easy! Simply press the green "use this templ Getting Started with Slate ------------------------------ -To get started with Slate, please check out the Getting Started](https://github.com/slatedocs/slate/wiki#getting-started) +To get started with Slate, please check out the [Getting Started](https://github.com/slatedocs/slate/wiki#getting-started) section in our [wiki](https://github.com/slate/wiki). We support running Slate in three different ways: From fc7612cccacfdb9b15ff7e0ad57e479ae10009eb Mon Sep 17 00:00:00 2001 From: Simon Marcus Date: Wed, 3 Jun 2020 23:11:21 -0400 Subject: [PATCH 46/46] Fix link to wiki in README (#1253) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d052a1139da..5920785ee37 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Getting Started with Slate ------------------------------ To get started with Slate, please check out the [Getting Started](https://github.com/slatedocs/slate/wiki#getting-started) -section in our [wiki](https://github.com/slate/wiki). +section in our [wiki](https://github.com/slatedocs/slate/wiki). We support running Slate in three different ways: * [Natively](https://github.com/slatedocs/slate/wiki/Using-Slate-Natively)