From 5d7f73df5b24a0ab54825df0fd074c0cb38b4382 Mon Sep 17 00:00:00 2001 From: David Young Date: Sat, 2 Jul 2022 19:57:23 +1200 Subject: [PATCH] Remove references to leanpub book (leanpub pricing changes) Signed-off-by: David Young --- .cache/plugin/git-committers/authors.json | 1 + Dockerfile | 3 +- README.md | 5 -- manuscript/extras/css/icons.css | 6 +++ manuscript/extras/javascript/feedback.js | 11 +++++ manuscript/index.md | 57 +++++++++++++++++++---- manuscript/support.md | 4 -- mkdocs.yml | 38 +++++++++++---- requirements.txt | 3 +- 9 files changed, 97 insertions(+), 31 deletions(-) create mode 100644 .cache/plugin/git-committers/authors.json create mode 100644 manuscript/extras/css/icons.css create mode 100644 manuscript/extras/javascript/feedback.js diff --git a/.cache/plugin/git-committers/authors.json b/.cache/plugin/git-committers/authors.json new file mode 100644 index 0000000..da729d0 --- /dev/null +++ b/.cache/plugin/git-committers/authors.json @@ -0,0 +1 @@ +{"David Young": {"login": "David Young", "name": "David Young", "url": "#", "avatar": "https://www.gravatar.com/avatar/5a68fe19164248ff2daacd7814aa1442?d=identicon"}, "funkypenguin": {"login": "funkypenguin", "name": "funkypenguin", "url": "#", "avatar": "https://www.gravatar.com/avatar/5a68fe19164248ff2daacd7814aa1442?d=identicon"}} \ No newline at end of file diff --git a/Dockerfile b/Dockerfile index 9c72772..a1aa482 100644 --- a/Dockerfile +++ b/Dockerfile @@ -5,4 +5,5 @@ RUN pip install \ mkdocs-autolinks-plugin \ mkdocs-htmlproofer-plugin \ mkdocs-git-revision-date-localized-plugin \ - mkdocs-macros-plugin + mkdocs-macros-plugin \ + mkdocs-git-committers-plugin-2 diff --git a/README.md b/README.md index 4878977..6e171b8 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,6 @@ - [What have you done for me lately? (CHANGELOG)](#what-have-you-done-for-me-lately-changelog) - [What do you want from me?](#what-do-you-want-from-me) - [Get in touch 👋](#get-in-touch-) - - [Buy my book 📖](#buy-my-book-) - [Sponsor me ❤️](#sponsor--patronizepatreon-me-️) - [Work with me 🤝](#work-with-me-) @@ -73,10 +72,6 @@ I want your [support][github_sponsor], either in the [financial][github_sponsor] - Tweet me up, I'm [@funkypenguin][twitter]! 🐦 - [Contact me][contact] by a variety of channels -### Buy my book 📖 - -I'm also publishing the Geek Cookbook as a formal eBook (*PDF, mobi, epub*), on Leanpub (). Buy it for as little as $5 (_which is really just a token gesture of support, since all the content is available online anyway!_) or pay what you think it's worth! - ### [Sponsor][github_sponsor] / [Patronize][patreon] me ❤️ The best way to support this work is to become a [GitHub Sponsor](https://github.com/sponsors/funkypenguin) / [Patreon patron][patreon] (_for as little as $1/month!_) - You get : diff --git a/manuscript/extras/css/icons.css b/manuscript/extras/css/icons.css new file mode 100644 index 0000000..57f8a32 --- /dev/null +++ b/manuscript/extras/css/icons.css @@ -0,0 +1,6 @@ +.kubernetes { + color: #3970e4; + } +.docker { + color: #0db7ed; +} \ No newline at end of file diff --git a/manuscript/extras/javascript/feedback.js b/manuscript/extras/javascript/feedback.js new file mode 100644 index 0000000..fcf4709 --- /dev/null +++ b/manuscript/extras/javascript/feedback.js @@ -0,0 +1,11 @@ +var feedback = document.forms.feedback +feedback.addEventListener("submit", function(ev) { + ev.preventDefault() + + /* Retrieve page and feedback value */ + var page = document.location.pathname + var data = ev.submitter.getAttribute("data-md-value") + + /* Send feedback value */ + console.log(page, data) +}) diff --git a/manuscript/index.md b/manuscript/index.md index c5d5b25..da5d926 100644 --- a/manuscript/index.md +++ b/manuscript/index.md @@ -4,14 +4,14 @@ hide: # - toc # Hide table of contents --- -# Welcome, fellow geek :wave: +# Welcome, fellow geek :wave:, start here :point_down: + +[Dive into Docker Swarm](/ha-docker-swarm/design/){: .md-button .md-button--primary} +[Kick it with Kubernetes](/kubernetes/){: .md-button .md-button--primary} ## What is this? -Funky Penguin's "**[Geek Cookbook](https://geek-cookbook.funkypenguin.co.nz)**" is a collection of how-to guides for establishing your own container-based self-hosting platform, using either [Docker Swarm](/ha-docker-swarm/design/) or [Kubernetes](/kubernetes/). - -[Dive into Docker Swarm](/ha-docker-swarm/design/){: .md-button .md-button--primary} -[Kick it with Kubernetes](/kubernetes/){: .md-button} +The "*Geek Cookbook*" is a collection of how-to guides for establishing your own container-based self-hosting platform, using either [Docker Swarm](/ha-docker-swarm/design/) or [Kubernetes](/kubernetes/). Running such a platform enables you to run self-hosted tools such as [AutoPirate](/recipes/autopirate/) (*Radarr, Sonarr, NZBGet and friends*), [Plex](https://www.plex.tv/), [NextCloud](https://nextcloud.com/), and includes elements such as: @@ -40,6 +40,47 @@ So if you're familiar enough with the concepts above, and you've done self-hosti "One of the surprising realizations from following Funky Penguins cookbooks for so long is how useful the recipes are for people just getting started with containers and how it gives them real, interesting usecases to attach to their learning" - [DevOps Daniel (@DanielSHouston)](https://twitter.com/DanielSHouston/status/1213419203379773442) +## Where do I start? + +
+ +- __Dive into :material-docker:{ .docker .lg .middle } [Docker Swarm](/ha-docker-swarm/design/)__ + + --- + + Focus on your content and generate a responsive and searchable static site + + [:octicons-arrow-right-24: Docker Swarm](#) + +- __Kick it with :material-kubernetes:{ .kubernetes .lg .middle } [Kubernetes](/kubernetes/)__ + + --- + + Install [`mkdocs-material`](#) with [`pip`](#) and get up + and running in minutes :octicons-heart-fill: + + [:octicons-arrow-right-24: Kubernetes](#) + + + +- :material-format-font:{ .lg .middle } __Made to measure__ + + --- + + Change the colors, fonts, language, icons, logo and more with a few lines + + [:octicons-arrow-right-24: Customization](#) + +- :material-scale-balance:{ .lg .middle } __Open Source, MIT__ + + --- + + Material for MkDocs is licensed under MIT and available on [GitHub] + + [:octicons-arrow-right-24: License](#) + +
+ ## Who are you? :wave: Hi, I'm [David](https://www.funkypenguin.co.nz/about/) @@ -87,17 +128,13 @@ Impulsively **[click here (NOW quick do it!)](https://github.com/sponsors/funkyp -- John McDowall, Founder, [kiso.io](https://kiso.io) -### Buy my book 📖 - -I'm publishing the Geek Cookbook as a formal eBook (*PDF, mobi, epub*), on Leanpub (). Check it out! - ### Buy me a coffee ☕️ A sponsorship is too much commitment, and a book is TL;DR? Hit me up with a [one-time caffine shot](https://www.buymeacoffee.com/funkypenguin)! ### Sponsored Projects -I'm supported and motivated by [GitHub Sponsors](https://github.com/sponsors/funkypenguin), [Patreon patrons](https://www.patreon.com/funkypenguin) and [LeanPub readers](https://leanpub.com/geeks-cookbook) who have generously sponsored me. +I'm supported and motivated by [GitHub Sponsors](https://github.com/sponsors/funkypenguin) and [Patreon patrons](https://www.patreon.com/funkypenguin) who have generously sponsored me. I regularly donate to / sponsor the following projects. **Join me** in supporting these geeks, and encouraging them to continue building the ingredients for your favourite recipes! diff --git a/manuscript/support.md b/manuscript/support.md index dc69041..97c1dd8 100644 --- a/manuscript/support.md +++ b/manuscript/support.md @@ -57,10 +57,6 @@ The best way to support this work is to become a [Sponsor][11] (_GitHub_) or a [ Impulsively **[click here (NOW quick do it!)][11]** to sponsor me, or instead thoughtfully and analytically review my GitHub profile **[here][12]** and make up your own mind. -### Buy my book 📖 - -I'm also writing the Geek Cookbook as a formal eBook, on Leanpub (). Buying it supports me once-off, and you continue to have access to the book as future recipes are added. - ### Buy me a coffee ☕️ A sponsorship is too much commitment, and a book is TL;DR? Hit me up with a [one-time caffine shot](https://www.buymeacoffee.com/funkypenguin)! diff --git a/mkdocs.yml b/mkdocs.yml index 7dbe551..fea2885 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -33,6 +33,9 @@ plugins: # 504: ['https://www.mkdocs.org/'] # 404: ['https://github.com/manuzhang/mkdocs-htmlproofer-plugin'] # 400: ['*'] + git-committers: + repository: geek-cookbook/geek-cookbook + token: !ENV GH_TOKEN #theme_dir: mkdocs-material nav: @@ -261,24 +264,37 @@ theme: - navigation.sections - navigation.indexes - navigation.top + - navigation.pruning - search.suggest - search.share - content.code.annotate + - header.autohide + - announce.dismiss + - toc.follow icon: repo: 'fontawesome/brands/github' palette: + + # Palette toggle for automatic mode + - media: "(prefers-color-scheme)" + toggle: + icon: material/brightness-auto + name: Switch to light mode + # Toggle light mode - - scheme: default + - media: "(prefers-color-scheme: light)" + scheme: default primary: 'black' - accent: 'indigo' + accent: 'orange' toggle: icon: material/toggle-switch name: Burn my eyes! # Toggle dark mode - - scheme: slate - primary: 'grey' - accent: 'indigo' + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: 'black' + accent: 'orange' toggle: icon: material/toggle-switch-off-outline name: Love my eyes! @@ -299,8 +315,6 @@ extra: link: 'https://www.funkypenguin.co.nz/' - icon: 'fontawesome/brands/linkedin' link: 'https://www.linkedin.com/in/funkypenguin' - - icon: 'material/library' - link: 'https://leanpub.com/geeks-cookbook' - icon: 'material/mailbox' link: 'mailto:davidy@funkypenguin.co.nz?Subject=Hello%2C%20from%20a%20geek-cookbook%20reader%20%3B%29' generator: false @@ -336,12 +350,15 @@ extra: # Help us improve this page by # using our feedback form. -# extra_css: +extra_css: + - extras/css/icons.css extra_javascript: - extras/javascript/discord.js - extras/javascript/sortable-tables.js + - extras/javascript/feedback.js - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js + # Extensions markdown_extensions: @@ -362,8 +379,8 @@ markdown_extensions: check_paths: true base_path: _snippets - pymdownx.emoji: - emoji_index: !!python/name:pymdownx.emoji.twemoji - emoji_generator: !!python/name:pymdownx.emoji.to_svg + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg - pymdownx.inlinehilite - pymdownx.magiclink: repo_url_shorthand: true @@ -381,3 +398,4 @@ markdown_extensions: - pymdownx.tilde - pymdownx.tabbed - meta + - md_in_html diff --git a/requirements.txt b/requirements.txt index 09f4b18..879ddd5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -6,4 +6,5 @@ mkdocs-autolinks-plugin>=0.2.0 # mkdocs-htmlproofer-plugin>=0.0.3 mkdocs-git-revision-date-localized-plugin>=0.4.8 mkdocs-macros-plugin -mkdocs-material \ No newline at end of file +mkdocs-material +mkdocs-git-committers-plugin-2 \ No newline at end of file