From 802c975eef93ede91522baec6f70ee847bdde09f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Niedzielski?= Date: Sat, 25 May 2019 17:49:26 +0200 Subject: [PATCH 1/6] jekyll gh-pages --- docs/_config.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 docs/_config.yml diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 000000000..7952a85ff --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,23 @@ +title: enqueue-dev +description: A Jekyll theme for documentation +baseurl: "/enqueue-dev/" # the subpath of your site, e.g. /blog +url: "https://steveb-p.github.io" # the base hostname & protocol for your site, e.g. http://example.com + +permalink: pretty +exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"] + +# Enable or disable the site search +search_enabled: true + +# Aux links for the upper right navigation +aux_links: + "enqueue-dev on GitHub": + - "//github.com/enqueue-dev/enqueue-dev" + +# Color scheme currently only supports "dark" or nil (default) +color_scheme: dark + +remote_theme: pmarsceill/just-the-docs + +plugins: + - jekyll-seo-tag From 40f02f4c049104a7a29c1bed1eafbc042097b8e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Niedzielski?= Date: Sat, 25 May 2019 19:05:10 +0200 Subject: [PATCH 2/6] WIP --- docs/Gemfile | 31 +++++++++++++++++++++++++++++++ docs/_config.yml | 8 +++++--- docs/index.md | 11 +++++++++-- 3 files changed, 45 insertions(+), 5 deletions(-) create mode 100644 docs/Gemfile diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 000000000..93bfdf9a5 --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,31 @@ +source "https://rubygems.org" + +# Hello! This is where you manage which Jekyll version is used to run. +# When you want to use a different version, change it below, save the +# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: +# +# bundle exec jekyll serve +# +# This will help ensure the proper Jekyll version is running. +# Happy Jekylling! +gem "jekyll", "~> 3.8.5" + +# This is the default theme for new Jekyll sites. You may change this to anything you like. +# gem "minima", "~> 2.0" +gem "just-the-docs" + +# If you want to use GitHub Pages, remove the "gem "jekyll"" above and +# uncomment the line below. To upgrade, run `bundle update github-pages`. +gem "github-pages", group: :jekyll_plugins + +# If you have any plugins, put them here! +# group :jekyll_plugins do +# gem "jekyll-feed", "~> 0.6" +# end + +# Windows does not include zoneinfo files, so bundle the tzinfo-data gem +gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby] + +# Performance-booster for watching directories on Windows +gem "wdm", "~> 0.1.0" if Gem.win_platform? + diff --git a/docs/_config.yml b/docs/_config.yml index 7952a85ff..7ae441011 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,11 +1,13 @@ title: enqueue-dev description: A Jekyll theme for documentation -baseurl: "/enqueue-dev/" # the subpath of your site, e.g. /blog -url: "https://steveb-p.github.io" # the base hostname & protocol for your site, e.g. http://example.com +baseurl: "" # the subpath of your site, e.g. /blog +url: "" # the base hostname & protocol for your site, e.g. http://example.com permalink: pretty exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"] +markdown: kramdown + # Enable or disable the site search search_enabled: true @@ -15,7 +17,7 @@ aux_links: - "//github.com/enqueue-dev/enqueue-dev" # Color scheme currently only supports "dark" or nil (default) -color_scheme: dark +color_scheme: nil remote_theme: pmarsceill/just-the-docs diff --git a/docs/index.md b/docs/index.md index 521e642fa..a33582272 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,10 @@ +--- +# Feel free to add content and custom Front Matter to this file. +# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults + +layout: home +--- +

Supporting Enqueue

Enqueue is an MIT-licensed open source project with its ongoing development made possible entirely by the support of community and our customers. If you'd like to join them, please consider: @@ -37,7 +44,7 @@ Enqueue is an MIT-licensed open source project with its ongoing development made * [Job queue](#job-queue) - [Run unique job](job_queue/run_unique_job.md) - [Run sub job(s)](job_queue/run_sub_job.md) -* [EnqueueBundle (Symfony)](#enqueue-bundle-symfony). +* [EnqueueBundle (Symfony)](#enqueue-bundle-symfony). - [Quick tour](bundle/quick_tour.md) - [Config reference](bundle/config_reference.md) - [Cli commands](bundle/cli_commands.md) @@ -49,7 +56,7 @@ Enqueue is an MIT-licensed open source project with its ongoing development made - [Consumption extension](bundle/consumption_extension.md) - [Production settings](bundle/production_settings.md) - [Debugging](bundle/debugging.md) - - [Functional testing](bundle/functional_testing.md) + - [Functional testing](bundle/functional_testing.md) * [Laravel](#laravel) - [Quick tour](laravel/quick_tour.md) - [Queues](laravel/queues.md) From 509da7cbdfdc8718d1ac16b1d18c80cae80a19cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Niedzielski?= Date: Sat, 25 May 2019 19:45:33 +0200 Subject: [PATCH 3/6] Add instructions on how to easily build documentation locally --- docs/.gitignore | 2 ++ docs/Gemfile | 9 +++------ docs/_config.yml | 19 ++++++++++++++++--- docs/index.md | 11 ++++++++++- 4 files changed, 31 insertions(+), 10 deletions(-) create mode 100644 docs/.gitignore diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..29949d465 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,2 @@ +/_site +/Gemfile.lock diff --git a/docs/Gemfile b/docs/Gemfile index 93bfdf9a5..5b4694d54 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -14,14 +14,11 @@ gem "jekyll", "~> 3.8.5" # gem "minima", "~> 2.0" gem "just-the-docs" -# If you want to use GitHub Pages, remove the "gem "jekyll"" above and -# uncomment the line below. To upgrade, run `bundle update github-pages`. -gem "github-pages", group: :jekyll_plugins - # If you have any plugins, put them here! -# group :jekyll_plugins do +group :jekyll_plugins do + gem "github-pages" # gem "jekyll-feed", "~> 0.6" -# end +end # Windows does not include zoneinfo files, so bundle the tzinfo-data gem gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby] diff --git a/docs/_config.yml b/docs/_config.yml index 7ae441011..7ab62a76f 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,10 +1,23 @@ title: enqueue-dev description: A Jekyll theme for documentation baseurl: "" # the subpath of your site, e.g. /blog -url: "" # the base hostname & protocol for your site, e.g. http://example.com +url: "http://localhost" # the base hostname & protocol for your site, e.g. http://example.com permalink: pretty -exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"] +exclude: + - "node_modules/" + - "*.gemspec" + - "*.gem" + - "Gemfile" + - "Gemfile.lock" + - "package.json" + - "package-lock.json" + - "script/" + - "LICENSE.txt" + - "lib/" + - "bin/" + - "README.md" + - "Rakefile" markdown: kramdown @@ -14,7 +27,7 @@ search_enabled: true # Aux links for the upper right navigation aux_links: "enqueue-dev on GitHub": - - "//github.com/enqueue-dev/enqueue-dev" + - "//github.com/php-enqueue/enqueue-dev" # Color scheme currently only supports "dark" or nil (default) color_scheme: nil diff --git a/docs/index.md b/docs/index.md index a33582272..90480af56 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,7 @@ # Feel free to add content and custom Front Matter to this file. # To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults -layout: home +layout: default ---

Supporting Enqueue

@@ -98,3 +98,12 @@ Enqueue is an MIT-licensed open source project with its ongoing development made * [Yii PHP Framework has adopted AMQP Interop.](https://blog.forma-pro.com/yii-php-framework-has-adopted-amqp-interop-85ab47c9869f) * [(En)queue Symfony console commands](http://tech.yappa.be/enqueue-symfony-console-commands) * [From RabbitMq to PhpEnqueue via Symfony Messenger](https://medium.com/@stefanoalletti_40357/from-rabbitmq-to-phpenqueue-via-symfony-messenger-b8260d0e506c) + +## Contributing to this documentation + +To run this documentation locally, you can either create Jekyll environment on your local computer or use docker container. +To run docker container you can use a command from repository root directory: +```shell +docker run -p 4000:4000 --rm --volume="${PWD}/docs:/srv/jekyll" -it jekyll/jekyll jekyll serve --watch +``` +Documentation will then be available for you on http://localhost:4000/ once build completes and rebuild automatically on changes. From fce750a3e2f77e5c90156a5c6e9007ad231c9a83 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Niedzielski?= Date: Sat, 25 May 2019 19:57:06 +0200 Subject: [PATCH 4/6] Fix assets --- docs/_config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_config.yml b/docs/_config.yml index 7ab62a76f..0e457d2e6 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,7 +1,7 @@ title: enqueue-dev description: A Jekyll theme for documentation baseurl: "" # the subpath of your site, e.g. /blog -url: "http://localhost" # the base hostname & protocol for your site, e.g. http://example.com +url: "" # the base hostname & protocol for your site, e.g. http://example.com permalink: pretty exclude: From 1fd00227afdaa9fc6d731ed98648309dac3f0c6d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Niedzielski?= Date: Sat, 25 May 2019 20:00:29 +0200 Subject: [PATCH 5/6] Fix assets --- docs/_config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_config.yml b/docs/_config.yml index 0e457d2e6..4145394fe 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,6 +1,6 @@ title: enqueue-dev description: A Jekyll theme for documentation -baseurl: "" # the subpath of your site, e.g. /blog +baseurl: "/enqueue-dev" # the subpath of your site, e.g. /blog url: "" # the base hostname & protocol for your site, e.g. http://example.com permalink: pretty From 55e9a8a1fe585730aaa15dc023baeb8ca290bf96 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Niedzielski?= Date: Sat, 25 May 2019 20:24:23 +0200 Subject: [PATCH 6/6] Add button for switching to dark mode. At least for now. --- docs/_includes/nav.html | 62 +++++++++++++++++++++++++++++++++++++++++ docs/index.md | 1 + 2 files changed, 63 insertions(+) create mode 100644 docs/_includes/nav.html diff --git a/docs/_includes/nav.html b/docs/_includes/nav.html new file mode 100644 index 000000000..fa2492acc --- /dev/null +++ b/docs/_includes/nav.html @@ -0,0 +1,62 @@ + diff --git a/docs/index.md b/docs/index.md index 90480af56..6fda30bee 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,6 +3,7 @@ # To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults layout: default +title: Index ---

Supporting Enqueue