public/geek-cookbook
1
0
Fork 0
mirror of https://github.com/funkypenguin/geek-cookbook/ synced 2025-12-13 01:36:23 +00:00
Code Issues Releases Wiki Activity

Update community pages

Browse Source 
Signed-off-by: David Young <davidy@funkypenguin.co.nz>
This commit is contained in:
David Young
2022-08-23 12:22:19 +12:00
parent 4a7847578b
commit 1593f04918
11 changed files with 128 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

119
_snippets/common-links.md
View File

@@ -1,58 +1,61 @@
[archivebox]: /recipes/archivebox/ [archivebox]: /recipes/archivebox/
[authelia]: /docker-swarm/authelia/ [authelia]: /docker-swarm/authelia/
[autopirate]: /recipes/autopirate/ [autopirate]: /recipes/autopirate/
[bazarr]: /recipes/autopirate/bazarr/ [bazarr]: /recipes/autopirate/bazarr/
[calibre-web]: /recipes/calibre-web/ [calibre-web]: /recipes/calibre-web/
[cert_aws]: https://www.credly.com/badges/a0c4a196-55ab-4472-b46b-b610b44dc00f [cert_aws]: https://www.credly.com/badges/a0c4a196-55ab-4472-b46b-b610b44dc00f
[cert_cka]: https://www.credly.com/badges/cd307d51-544b-4bc6-97b0-9015e40df40d [cert_cka]: https://www.credly.com/badges/cd307d51-544b-4bc6-97b0-9015e40df40d
[cert_ckad]: https://www.credly.com/badges/9ed9280a-fb92-46ca-b307-8f74a2cccf1d [cert_ckad]: https://www.credly.com/badges/9ed9280a-fb92-46ca-b307-8f74a2cccf1d
[cert_cks]: https://www.credly.com/badges/93fa53da-1f38-47a9-b6ee-dce6a8fad9fc [cert_cks]: https://www.credly.com/badges/93fa53da-1f38-47a9-b6ee-dce6a8fad9fc
[community/mastodon]: /community/mastodon/ [community/discord]: /community/discord/
[contact]: https://www.funkypenguin.co.nz/contact [community/discourse]: /community/discourse/
[cyberchef]: /recipes/cyberchef/ [community/github]: /community/github/
[discord]: https://chat.funkypenguin.co.nz [community/mastodon]: /community/mastodon/
[duplicity]: /recipes/autopirate/duplicity/ [contact]: https://www.funkypenguin.co.nz/contact
[emby]: /recipes/emby/ [cyberchef]: /recipes/cyberchef/
[funkwhale]: /recipes/autopirate/funkwhale/ [discord]: https://chat.funkypenguin.co.nz
[github_sponsor]: https://github.com/sponsors/funkypenguin [duplicity]: /recipes/autopirate/duplicity/
[headphones]: /recipes/autopirate/headphones/ [emby]: /recipes/emby/
[homeassistant]: /recipes/homeassistant/ [funkwhale]: /recipes/autopirate/funkwhale/
[immich]: /recipes/immich/ [github_sponsor]: https://github.com/sponsors/funkypenguin
[jackett]: /recipes/autopirate/jackett/ [headphones]: /recipes/autopirate/headphones/
[jellyfin]: /recipes/jellyfin/ [homeassistant]: /recipes/homeassistant/
[k8s/mastodon]: /recipes/kubernetes/mastodon/ [immich]: /recipes/immich/
[kavita]: /recipes/kavita/ [jackett]: /recipes/autopirate/jackett/
[keycloak]: /recipes/keycloak/ [jellyfin]: /recipes/jellyfin/
[komga]: /recipes/komga/ [k8s/mastodon]: /recipes/kubernetes/mastodon/
[lazylibrarian]: /recipes/autopirate/lazylibrarian/ [kavita]: /recipes/kavita/
[lidarr]: /recipes/autopirate/lidarr/ [keycloak]: /recipes/keycloak/
[linx]: /recipes/linx/ [komga]: /recipes/komga/
[mastodon]: /recipes/mastodon/ [lazylibrarian]: /recipes/autopirate/lazylibrarian/
[mealie]: /recipes/mealie/ [lidarr]: /recipes/autopirate/lidarr/
[miniflux]: /recipes/miniflux/ [linx]: /recipes/linx/
[minio]: /recipes/minio/ [mastodon]: /recipes/mastodon/
[mylar]: /recipes/autopirate/mylar/ [mealie]: /recipes/mealie/
[nightscout]: /recipes/nightscout/ [miniflux]: /recipes/miniflux/
[nzbget]: /recipes/autopirate/nzbget/ [minio]: /recipes/minio/
[nzbhydra]: /recipes/autopirate/nzbhydra/ [mylar]: /recipes/autopirate/mylar/
[ombi]: /recipes/autopirate/ombi/ [nightscout]: /recipes/nightscout/
[openldap]: /recipes/openldap/ [nzbget]: /recipes/autopirate/nzbget/
[oscarr]: /recipes/autopirate/oscarr/ [nzbhydra]: /recipes/autopirate/nzbhydra/
[paperless-ng]: /recipes/paperless-ng/ [ombi]: /recipes/autopirate/ombi/
[patreon]: https://www.patreon.com/bePatron?u=6982506 [openldap]: /recipes/openldap/
[photoprism]: /recipes/photoprism/ [oscarr]: /recipes/autopirate/oscarr/
[plex]: /recipes/plex/ [paperless-ng]: /recipes/paperless-ng/
[portainer]: /recipes/portainer/ [patreon]: https://www.patreon.com/bePatron?u=6982506
[prowlarr]: /recipes/autopirate/prowlarr/ [photoprism]: /recipes/photoprism/
[radarr]: /recipes/autopirate/radarr/ [plex]: /recipes/plex/
[readarr]: /recipes/autopirate/readarr/ [portainer]: /recipes/portainer/
[review/immich]: /review/immich/ [prowlarr]: /recipes/autopirate/prowlarr/
[review/mastodon]: /review/mastodon/ [radarr]: /recipes/autopirate/radarr/
[rss-bridge]: /recipes/rss-bridge/ [readarr]: /recipes/autopirate/readarr/
[rtorrent]: /recipes/autopirate/rtorrent/ [review/immich]: /review/immich/
[sabnzbd]: /recipes/autopirate/sabnzbd/ [review/mastodon]: /review/mastodon/
[sonarr]: /recipes/autopirate/sonarr/ [rss-bridge]: /recipes/rss-bridge/
[tfa-dex-static]: /docker-swarm/traefik-forward-auth/dex-static/ [rtorrent]: /recipes/autopirate/rtorrent/
[tfa-google]: /docker-swarm/traefik-forward-auth/google/ [sabnzbd]: /recipes/autopirate/sabnzbd/
[tfa-keycloak]: /docker-swarm/traefik-forward-auth/keycloak/ [sonarr]: /recipes/autopirate/sonarr/
[tfa]: /docker-swarm/traefik-forward-auth/ [tfa-dex-static]: /docker-swarm/traefik-forward-auth/dex-static/
[tfa-google]: /docker-swarm/traefik-forward-auth/google/
[tfa-keycloak]: /docker-swarm/traefik-forward-auth/keycloak/
[tfa]: /docker-swarm/traefik-forward-auth/

5
docs/community/code-of-conduct.md
View File

@@ -1,6 +1,7 @@
--- ---
title: Community Code of Conduct title: Funky Penguin's Community Code of Conduct
description: We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. description: Inspired by the leadership of other great open source projects, we've adopted the Contributor Covenant Code of Conduct
icon: material/police-badge-outline
--- ---
# Code of Conduct # Code of Conduct

10
docs/community/contribute.md
View File

@@ -1,8 +1,10 @@
--- ---
title: How to contribute to Geek Cookbook title: How to contribute to Geek Cookbook
description: Loving the geeky recipes, and looking for a way to give back / get involved. It's not all coding - here are some ideas re various ways you can be involved! description: Loving the geeky recipes, and looking for a way to give back / get involved. It's not all coding - here are some ideas re various ways you can be involved!
icon: material/gift
--- ---
# Contribute
# Get started with your Open Source contribution
## Spread the word ❤️ ## Spread the word ❤️
@@ -29,7 +31,7 @@ Here's a [113-second video](https://static.funkypenguin.co.nz/how-to-contribute-
Want to contributing an entirely new recipe? Awesome! Want to contributing an entirely new recipe? Awesome!
For the best experience, start by [creating an issue](https://github.com/geek-cookbook/geek-cookbook/issues/) in the repo (*check whether an existing issue for this recipe exists too!*). Populating the issue template will flesh out the requirements for the recipe, and having the new recipe pre-approved will avoid wasted effort if the recipe _doesn't_ meet requirements for addition, for some reason (*i.e., if it's been superceded by an existing recipe*) For the best experience, start by [creating an issue](https://github.com/geek-cookbook/geek-cookbook/issues/new/choose) in the repo (*check whether an existing issue for this recipe exists too!*). Populating the issue template will flesh out the requirements for the recipe, and having the new recipe pre-approved will avoid wasted effort if the recipe *doesn't* meet requirements for addition, for some reason (*i.e., if it's been superceded by an existing recipe*)
Once your issue has been reviewed and approved, start working on a PR using either GitHub Codespaces or local dev (below). As soon as you're ready to share your work, create a WIP PR, so that a preview URL will be generated. Iterate on your PR, marking it as ready for review when it's ... ready :grin: Once your issue has been reviewed and approved, start working on a PR using either GitHub Codespaces or local dev (below). As soon as you're ready to share your work, create a WIP PR, so that a preview URL will be generated. Iterate on your PR, marking it as ready for review when it's ... ready :grin:
@@ -39,7 +41,7 @@ GitPod (free up to 50h/month) is by far the smoothest and most slick way to edi
### 🥈 GitHub Codespaces ### 🥈 GitHub Codespaces
[GitHub Codespaces](https://github.com/features/codespaces) (_no longer free now that it's out of beta_) provides a browser-based VSCode interface, pre-configured for your development environment. For no-hassle contributions to the cookbook with realtime previews, visit the [repo](https://github.com/geek-cookbook/geek-cookbook), and when clicking the download button (*where you're usually get the URL to clone a repo*), click on "**Open with CodeSpaces**" instead: [GitHub Codespaces](https://github.com/features/codespaces) (*no longer free now that it's out of beta*) provides a browser-based VSCode interface, pre-configured for your development environment. For no-hassle contributions to the cookbook with realtime previews, visit the [repo](https://github.com/geek-cookbook/geek-cookbook), and when clicking the download button (*where you're usually get the URL to clone a repo*), click on "**Open with CodeSpaces**" instead:
![How to use GitHub Codespaces](https://static.funkypenguin.co.nz/2021/geek-cookbookgeek-cookbook_The_Geeks_Cookbook_is_a_collection_of_guides_for_establishing_your_own_highly-available_privat_2021-01-07_11-41-25.png){ loading=lazy } ![How to use GitHub Codespaces](https://static.funkypenguin.co.nz/2021/geek-cookbookgeek-cookbook_The_Geeks_Cookbook_is_a_collection_of_guides_for_establishing_your_own_highly-available_privat_2021-01-07_11-41-25.png){ loading=lazy }
@@ -67,4 +69,4 @@ The process is basically:
## Contributing skillz 💪 ## Contributing skillz 💪
Got mad skillz, but neither the time nor inclination for recipe-cooking? [Scan the GitHub contributions page](https://github.com/geek-cookbook/geek-cookbook/contribute), [Discussions](https://github.com/geek-cookbook/geek-cookbook/discussions), or jump into [Discord](/community/discord/) or [Discourse](/community/discourse/), and help your fellow geeks with their questions, or just hang out bump up our member count! Got mad skillz, but neither the time nor inclination for recipe-cooking? [Scan the GitHub contributions page](https://github.com/geek-cookbook/geek-cookbook/contribute), jump into [Discord](/community/discord/) or [Discourse](/community/discourse/), and help your fellow geeks with their questions, or just hang out bump up our member count!

3
docs/community/discord.md
View File

@@ -3,7 +3,8 @@ title: Geek out with Funky Penguin's Discord Server
description: The most realtime and exciting way engage with our geeky community is in our Discord server! description: The most realtime and exciting way engage with our geeky community is in our Discord server!
icon: fontawesome/brands/discord icon: fontawesome/brands/discord
--- ---
# Discord
# How to geek out in Discord
The most realtime and exciting way engage with our geeky community is in our [Discord server](http://chat.funkypenguin.co.nz) The most realtime and exciting way engage with our geeky community is in our [Discord server](http://chat.funkypenguin.co.nz)

3
docs/community/discourse.md
View File

@@ -4,7 +4,8 @@ description: Funky Penguin's Discourse Forums serve our geeky communtiy, and con
icon: fontawesome/brands/discourse icon: fontawesome/brands/discourse
status: new status: new
--- ---
# Discourse
# How to geek out on Discourse
If you're not into the new-fangled microblogging of Mastodon, or realtime chatting of Discord, can still party with us like it's 2001, using our Discourse forums (*this is also how all the recipe comments work*). If you're not into the new-fangled microblogging of Mastodon, or realtime chatting of Discord, can still party with us like it's 2001, using our Discourse forums (*this is also how all the recipe comments work*).

45
docs/community/github.md
View File

@@ -1,3 +1,44 @@
# GitHub ---
title: Engage with the Geek Cookbook in GitHub
description: How to use GitHub to interact with the Geek Cookbook community
icon: fontawesome/brands/github
status: new
---
You've found an intentionally un-linked page! This page is under construction, and will be up shortly. In the meantime, head to <https://github.com/geek-cookbook/geek-cookbook>! # How to geek on GitHub
Any changes to the cookbook start as issues in [our GitHub repository](https://github.com/geek-cookbook/geek-cookbook).
![GitHub Screenshot](/images/github.png){ loading=lazy }
## Report a bug
If you've found a bug with a recipe, [create a bug report](https://github.com/geek-cookbook/geek-cookbook/issues/new?assignees=funkypenguin&labels=bug&template=bug-report.yaml&title=%5Bbug+report%5D+). The issue template will walk you through the required information :)
## Request a recipe
What if you've got no bug to report, but you'd like to suggest a recipe? [Request a recipe](https://github.com/geek-cookbook/geek-cookbook/issues/new?assignees=&labels=recipe%2Frequest%2Cstatus%2Fbacklog%2Cgood+first+issue&template=recipe-request.yaml&title=%5Brecipe%5D+), and once again, you'll be prompted for the relevant details to start the process.
## Make a suggestion
What if you'd like to suggest a change, but it's not really a recipe or a bug? [Make a suggestion](https://github.com/geek-cookbook/geek-cookbook/issues/new?assignees=&labels=&template=suggestion.yaml&title=%5Bsuggestion%5D+)!
## Support Request
Actually, GitHub is **not** the place for support requests. I.e. if **your** implementation of a recipe isn't working, the places for support are:
- [Discord][community/discord]
- [Discourse][community/discourse]
## Contribute an improvment
The process of contributing improvements and fixes is best explained in details in our community [contribution guide](/community/contribute/) :thumbsup:
## Follow / sponsor me! ❤️
Follow (*and sponsor!*) my account, as well as the geek-cookbook organization:
- [funkypenguin](https://github.com/funkypenguin) ([sponsor](https://github.com/sponsors/funkypenguin))
- [geek-cookbook](https://github.com/geek-cookbook) ([sponsor](https://github.com/sponsors/geek-cookbook))
--8<-- "common-links.md"

3
docs/community/mastodon.md
View File

@@ -4,7 +4,8 @@ description: Looking for your geeky niche in the "fediverse"? Join our Mastodon
icon: fontawesome/brands/mastodon icon: fontawesome/brands/mastodon
status: new status: new
--- ---
# Toot me up, buttercup!
# Join geeky / selfhosted Mastodon
Mastondon is a self-hosted / open-source microblogging platform (*heavily inspired by Twitter*), which supports federation, rather than centralization. Like email, any user on any Mastodon instance can follow, "toot" (*not tweet!*), and reply to any user on any *other* instance. Mastondon is a self-hosted / open-source microblogging platform (*heavily inspired by Twitter*), which supports federation, rather than centralization. Like email, any user on any Mastodon instance can follow, "toot" (*not tweet!*), and reply to any user on any *other* instance.

2
docs/community/reddit.md
View File

@@ -4,7 +4,7 @@ description: If you're a redditor, jump on over to our subreddit at https://www.
icon: fontawesome/brands/reddit icon: fontawesome/brands/reddit
--- ---
# Reddit # Join friendly subreddit for selfhosted Kubernetes / Docker
If you're a redditor, jump on over to our subreddit ([r/funkypenguin](https://www.reddit.com/r/funkypenguin/)), to engage / share the latest! If you're a redditor, jump on over to our subreddit ([r/funkypenguin](https://www.reddit.com/r/funkypenguin/)), to engage / share the latest!

BIN
docs/images/github.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 124 KiB

6
docs/support.md
View File

@@ -1,6 +1,7 @@
--- ---
title: Awesome selfhosted is selfTOASTED? Help is here! title: Awesome selfhosted is selfTOASTED? Help is here!
description: When there's something strange, and it don't look good, who you gonna call? Discord / forum / one-on-on support, that's who! description: When there's something strange, and it don't look good, who you gonna call? Discord / forum / one-on-on support, that's who!
icon: material/lifebuoy
--- ---
# Support # Support
@@ -29,11 +30,11 @@ For community support and engagement, we have a [Discourse forum][3]. Using this
Every recipe includes a section at the end for comments. Every recipe includes a section at the end for comments.
If you have a comment / question about a specific recipe, navigate to the recipe, scroll to the bottom, and add your comment. You'll be sent to the [kitchen][4] to post the actual comment, but it'll be visible beneath the recipe _and_ at the kitchen. (_To post, you'll need to sign in using OAuth from Discord, github, google, etc, or create a new account_) If you have a comment / question about a specific recipe, navigate to the recipe, scroll to the bottom, and add your comment. You'll be sent to Discourse to post the actual comment, but it'll be visible beneath the recipe _and_ at Discourse. (_To post, you'll need to sign in using OAuth from Discord, github, google, etc, or create a new account_)
## Request a recipe ## Request a recipe
I'd love to hear your ideas for more recipes. To request/suggest a recipe, create a new post in the [kitchen][5] with the details. I'd love to hear your ideas for more recipes. To request/suggest a recipe, create a new issue in [GitHub](/community/github)
## Contribute a recipe ## Contribute a recipe
@@ -72,7 +73,6 @@ A sponsorship is too much commitment, and a book is TL;DR? Hit me up with a [one
[1]: http://chat.funkypenguin.co.nz [1]: http://chat.funkypenguin.co.nz
[2]: https://www.youtube.com/watch?v=1qHoSWxVqtE [2]: https://www.youtube.com/watch?v=1qHoSWxVqtE
[3]: https://forum.funkypenguin.co.nz/ [3]: https://forum.funkypenguin.co.nz/
[4]: https://forum.funkypenguin.co.nz/
[5]: https://forum.funkypenguin.co.nz/ [5]: https://forum.funkypenguin.co.nz/
[6]: https://github.com/funkypenguin/geek-cookbook/issues [6]: https://github.com/funkypenguin/geek-cookbook/issues
[7]: https://github.com/sponsors/funkypenguin [7]: https://github.com/sponsors/funkypenguin

10
mkdocs.yml
View File

@@ -286,16 +286,14 @@ nav:
- Contribute: community/contribute.md - Contribute: community/contribute.md
- Community: - Community:
- community/index.md - community/index.md
- Support: support.md
- Contribute: community/contribute.md
- Code of Conduct: community/code-of-conduct.md
- Discord: community/discord.md - Discord: community/discord.md
- Reddit: community/reddit.md - Reddit: community/reddit.md
- Mastodon: community/mastodon.md - Mastodon: community/mastodon.md
- Forum: community/discourse.md - Forum: community/discourse.md
- Support: support.md - GitHub: community/github.md
- Contribute: community/contribute.md
- Code of Conduct: community/code-of-conduct.md
# # - Discourse: community/discourse.md
# # - GitHub: community/github.md
theme: theme:
name: 'material' name: 'material'