mirror of
https://github.com/funkypenguin/geek-cookbook/
synced 2025-12-13 01:36:23 +00:00
Update community pages
Signed-off-by: David Young <davidy@funkypenguin.co.nz>
This commit is contained in:
David Young
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: 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.
|
||||
title: Funky Penguin's Community Code of Conduct
|
||||
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
|
||||
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
---
|
||||
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!
|
||||
icon: material/gift
|
||||
---
|
||||
# Contribute
|
||||
|
||||
# Get started with your Open Source contribution
|
||||
|
||||
## 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!
|
||||
|
||||
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:
|
||||
|
||||
@@ -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](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:
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
@@ -67,4 +69,4 @@ The process is basically:
|
||||
|
||||
## 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,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!
|
||||
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)
|
||||
|
||||
|
||||
@@ -4,7 +4,8 @@ description: Funky Penguin's Discourse Forums serve our geeky communtiy, and con
|
||||
icon: fontawesome/brands/discourse
|
||||
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*).
|
||||
|
||||
|
||||
@@ -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).
|
||||
|
||||
{ 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"
|
||||
|
||||
@@ -4,7 +4,8 @@ description: Looking for your geeky niche in the "fediverse"? Join our Mastodon
|
||||
icon: fontawesome/brands/mastodon
|
||||
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.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ description: If you're a redditor, jump on over to our subreddit at https://www.
|
||||
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!
|
||||
|
||||
|
||||
Reference in New Issue
Block a user