mirror of
https://github.com/funkypenguin/geek-cookbook/
synced 2025-12-13 01:36:23 +00:00
Add docs on how to contribute
This commit is contained in:
David Young
41
manuscript/community/contribute.md
Normal file
41
manuscript/community/contribute.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Contribute
|
||||
|
||||
## Spread the word ❤️
|
||||
|
||||
Got nothing to contribute, but want to give back to the community? Here are some ideas:
|
||||
|
||||
1. Star :star: the [repo](https://github.com/geek-cookbook/geek-cookbook/)
|
||||
2. [Sponsor](https://github.com/sponsors/funkypenguin) :heart: the chef
|
||||
3. Tweet 🐦 the [meat](https://ctt.ac/Vl6mc)!
|
||||
|
||||
## Contributing bugfixes 🐛
|
||||
|
||||
Found a typo / error in a recipe? Each recipe includes a link to make the fix, directly on GitHub:
|
||||
|
||||
|
||||
|
||||
Click the link to edit the recipe in Markdown format, and save to create a pull request!
|
||||
|
||||
Here's a [113-second video](https://static.funkypenguin.co.nz/how-to-contribute-to-geek-cookbook-quick-pr.mp4) illustrating the process!
|
||||
|
||||
## Contributing recipes 🎁
|
||||
|
||||
Want to contributing an entirely new recipe! Awesome!
|
||||
|
||||
The process is basically:
|
||||
|
||||
1. [Fork the repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
|
||||
2. Clone your forked repo locally
|
||||
3. Make a new branch for your recipe (*not strictly necessary, but it helps to differentiate multiple in-flight recipes*)
|
||||
4. Create your new recipe as a markdown file within the existing structure of the [manuscript folder](https://github.com/geek-cookbook/geek-cookbook/tree/master/manuscript)
|
||||
5. Add your recipe to the navigation by editing [mkdocs.yml](https://github.com/geek-cookbook/geek-cookbook/blob/master/mkdocs.yml#L32)
|
||||
6. Test locally by running `./scripts/serve.sh` in the repo folder (*this launches a preview in Docker*), and navigating to http://localhost:8123
|
||||
7. Rinse and repeat until you're ready to submit a PR
|
||||
8. Create a pull request via the GitHub UI
|
||||
9. The pull request will trigger the creation of a preview environment, as illustrated below. Use the deploy preview to confirm that your recipe is as tasty as possible!
|
||||
|
||||
|
||||
|
||||
## Contributing skillz 💪
|
||||
|
||||
Got mad skillz, but neither the time nor inclination for recipe-cooking? 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!
|
||||
@@ -16,6 +16,9 @@ Yeah, I know. I also thought Discord was just for the gamer kids, but it turns o
|
||||
1. Create [an account](https://discordapp.com)
|
||||
2. [Join the geek party](http://chat.funkypenguin.co.nz)!
|
||||
|
||||
|
||||
<iframe src="https://discordapp.com/widget?id=396055506072109067&theme=dark" width="350" height="400" allowtransparency="true" frameborder="0"></iframe>
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
With the goal of creating a safe and inclusive community, we've adopted the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/), as described [here](/community/code-of-conduct/).
|
||||
|
||||
@@ -1 +1,4 @@
|
||||
# Discourse
|
||||
|
||||
You've found an intentionally un-linked page! This page is under construction, and will be up shortly. In the meantime, head to https://discourse.geek-kitchen.funkypenguin.co.nz!
|
||||
|
||||
|
||||
@@ -1,2 +1,4 @@
|
||||
# GitHub
|
||||
|
||||
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!
|
||||
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
# Support
|
||||
|
||||
> "Excuse me... waiter, there's a bug in this recipe!"
|
||||
!!! note "Excuse me... waiter, there's a bug in this recipe!"
|
||||
|
||||
How do you get support for these receipes? There are several options...
|
||||
|
||||
## Discord: Where the cool kids are
|
||||
|
||||
All the cool kids are hanging out in the [Discord server](/discord/).
|
||||
All the cool kids are hanging out in the [Discord server](/community/discord/).
|
||||
|
||||
> "Eh? What's a Discord? Get off my lawn, young whippersnappers!!"
|
||||
!!! question "Eh? What's a Discord? Get off my lawn, young whippersnappers!!"
|
||||
|
||||
Yeah, I know. I also thought Discord was just for the gamer kids, but it turns out it's great for a geeky community. Why? [Let me elucidate ya.][2]..
|
||||
|
||||
@@ -17,20 +17,24 @@ Yeah, I know. I also thought Discord was just for the gamer kids, but it turns o
|
||||
3. Costs nothing, no ads
|
||||
4. Mobile notifications are reliable, individual channels mutable, etc
|
||||
|
||||
## Forums: Party like it's 1999
|
||||
## Discourse: Long-live discussion!
|
||||
|
||||
For community support and engagement, I've setup a [Discourse forum][3]. Using this as the primary means of topical discussions makes it easy to share recipes / experiences with future geeks.
|
||||
For community support and engagement, we have a [Discourse forum][3]. Using this as the primary means of topical discussions makes it easy to share recipes / experiences with future geeks.
|
||||
|
||||
## Discuss a recipe
|
||||
|
||||
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 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 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_)
|
||||
|
||||
## 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.
|
||||
|
||||
## Contribute a recipe
|
||||
|
||||
The only thing I love more than recipe ideas is recipe contributions! See details on contributing a recipe [here](/community/contribute/)
|
||||
|
||||
## Spit out a bug
|
||||
|
||||
Found a bug in your soup? Tell the chef by either:
|
||||
@@ -42,11 +46,11 @@ Found a bug in your soup? Tell the chef by either:
|
||||
|
||||
### Buy my book 📖
|
||||
|
||||
I'm also writing the Geek Cookbook as a formal eBook, on Leanpub (https://leanpub.com/geeks-cookbook). Buy it for $0.99 (_which is really just a token gesture of support_) - you can get it for free (_in PDF, mobi, or epub format_), or pay me what you think it's worth!
|
||||
I'm also writing the Geek Cookbook as a formal eBook, on Leanpub (https://leanpub.com/geeks-cookbook).
|
||||
|
||||
### [Sponsor][7] / [Patreonize][8] me 💰
|
||||
|
||||
The best way to support this work is to become a [Sponsor]() (_GitHub_) or a [Patron][10] (_Patreon_). For as little as $5/month, you get:
|
||||
The best way to support this work is to become a [Sponsor]() (_GitHub_) or a [Patron][10] (_Patreon_). Sponsors get:
|
||||
|
||||
* warm fuzzies,
|
||||
* access to the pre-mix repo,
|
||||
@@ -59,13 +63,8 @@ Impulsively **[click here (NOW quick do it!)][11]** to sponsor me, or instead th
|
||||
|
||||
### Engage me 🏢
|
||||
|
||||
Need some Cloud / Microservices / DevOps / Infrastructure design work done? I'm a full-time [AWS-certified][13] consultant, this stuff is my bread and butter! :bread: :fork\_and\_knife: [Contact][14] me and let's talk!
|
||||
Need some Cloud / Microservices / DevOps / Infrastructure design work done? I'm a full-time [AWS-certified][13] consultant, this stuff is my bread and butter! :bread: :fork_and_knife: [Contact][14] me and let's talk!
|
||||
|
||||
### Discord
|
||||
|
||||
Come and hang out in Discord..
|
||||
|
||||
<iframe src="https://discordapp.com/widget?id=396055506072109067&theme=dark" width="350" height="500" allowtransparency="true" frameborder="0"></iframe>
|
||||
|
||||
[1]: http://chat.funkypenguin.co.nz
|
||||
[2]: https://www.youtube.com/watch?v=1qHoSWxVqtE
|
||||
|
||||
11
mkdocs.yml
11
mkdocs.yml
@@ -166,13 +166,16 @@ nav:
|
||||
- Design: premix/ansible/design.md
|
||||
- Swarm: premix/swarm.md
|
||||
- Kubernetes: premix/kubernetes.md
|
||||
- CHANGELOG: CHANGELOG.md
|
||||
- CHANGELOG:
|
||||
- Start: CHANGELOG.md
|
||||
- Support:
|
||||
- Start: support.md
|
||||
- Community:
|
||||
- Support: support.md
|
||||
- Code of Conduct: community/code-of-conduct.md
|
||||
- Contribute: community/contribute.md
|
||||
- Discord: community/discord.md
|
||||
# - Discourse: community/discourse.md
|
||||
# - GitHub: community/github.md
|
||||
# # - Discourse: community/discourse.md
|
||||
# # - GitHub: community/github.md
|
||||
|
||||
theme:
|
||||
name: 'material'
|
||||
|
||||
Reference in New Issue
Block a user