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

Merge pull request #269 from geek-cookbook/add-matrix

Browse Source
This commit is contained in:
David Young
2023-02-24 19:42:56 +13:00
committed by GitHub
parent ee13c7b719 dbdea2b4cd
commit 374c33df6d
6 changed files with 136 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
_snippets/channels.md
View File

@@ -1,24 +0,0 @@
## Channels
### 📔 Information
| Channel Name | Channel Use |
|--------------------|------------------------------------------------------------|
| #announcements | Used for important announcements |
| #changelog | Used for major changes to the cookbook (to be deprecated) |
| #cookbook-updates | Updates on all pushes to the master branch of the cookbook |
| #premix-updates | Updates on all pushes to the master branch of the premix |
### 💬 Discussion
| Channel Name | Channel Use |
|----------------|----------------------------------------------------------|
| #introductions | New? Pop in here and say hi :) |
| #general | General chat - anything goes |
| #cookbook | Discussions specifically around the cookbook and recipes |
| #kubernetes | Discussions about Kubernetes |
| #docker-swarm | Discussions about Docker Swarm |
| #today-i-learned | Post tips/tricks you've stumbled across
| #jobs | For seeking / advertising jobs, bounties, projects, etc |
| #advertisements | In here you can advertise your stream, services or websites, at a limit of 2 posts per day |
| #dev | Used for collaboration around current development. |

2
_snippets/common-links.md
View File

@@ -12,6 +12,8 @@
[community/discourse]: /community/discourse/
[community/github]: /community/github/
[community/mastodon]: /community/mastodon/
[community/matrix]: /community/matrix/
[community/slack]: /community/slack/
[contact]: https://www.funkypenguin.co.nz/contact
[cyberchef]: /recipes/cyberchef/
[discord]: https://chat.funkypenguin.co.nz

61
docs/community/discord.md
View File

@@ -4,9 +4,18 @@ description: The most realtime and exciting way engage with our geeky community
icon: fontawesome/brands/discord
---
# How to geek out in Discord
# Community Geeking out in Discord
The most realtime and exciting way engage with our geeky community is in our [Discord server](http://chat.funkypenguin.co.nz)
Do you want to talk to somebody, stat!? Are you a fan of group messaging / chat platforms?
One of the most realtime and exciting way engage with our geeky community is in our [Discord server][community/discord] (*which is also synced with our [Matrix][community/matrix] and [Slack][community/slack] servers*)
---
[![Matrix](https://img.shields.io/matrix/geek-cookbook:matrix.funkypenguin.co.nz?label=geeks&logo=matrix&logoColor=white)][community/matrix]
[![Discord](https://img.shields.io/discord/396055506072109067?label=geeks&logo=discord&logoColor=white)][community/discord]
[![Slack](https://img.shields.io/badge/geeks-42-green?style=flat&logo=slack)][community/slack]
Here's what Discord looks like:
<!-- markdownlint-disable MD033 -->
<iframe src="https://e.widgetbot.io/channels/396055506072109067/396055506663374849" height="600" width="800"></iframe>
@@ -19,6 +28,8 @@ The most realtime and exciting way engage with our geeky community is in our [Di
3. Costs nothing, no ads
4. Mobile notifications are reliable, individual channels mutable, etc
However, if Discord is not your thing, take a look at [Matrix][community/matrix] or [Slack][community/slack] ;)
## How do I join the Discord server?
1. Create [an account](https://discordapp.com)
@@ -36,32 +47,42 @@ Your report message will immediately be deleted from the channel, and an alert r
## Channels
### 📔 Information
### 📔 Information (read-only)
The following channels are automated, and provide updates for issues like new PRs, subreddit posts, etc:
| Channel Name | Channel Use |
|--------------------|------------------------------------------------------------|
| #announcements | Used for important announcements |
| #changelog | Used for major changes to the cookbook (to be deprecated) |
| #cookbook-updates | Updates on all pushes to the master branch of the cookbook |
| #premix-updates | Updates on all pushes to the master branch of the premix |
| #forum-threads | Updates to Discourse topics |
| #subreddit-posts | New topics in r/funkypenguin |
| [#announcements](https://discord.com/channels/396055506072109067/456690093886013471) | Used for community announcements |
| [#blog-posts](https://discord.com/channels/396055506072109067/456589284342890506) | Receives announcemnets about new [Geek Cookbook Blog Posts](/blog/) |
| [#cookbook-updates](https://discord.com/channels/396055506072109067/454567388759982091) | Issues, PRs, commits on the [geek-cookbook/geek-cookbook](https://github.com/geek-cookbook/geek-cookbook) repo |
| [#premix-updates](https://discord.com/channels/396055506072109067/459291605460058112) | Issues, PRs, commits on the [funkypenguin/geek-cookbook-premix](https://github.com/funkypenguin/geek-cookbook-premix) repo |
|[#forum-threads](https://discord.com/channels/396055506072109067/515827101589569541) | New and updated [forum threads](https://forum.funkypenguin.co.nz) |
| [#subreddit-posts](https://discord.com/channels/396055506072109067/1015041696033157210) | New topics in [r/funkypenguin](https://reddit.com/r/funkypenguin) |
### 💬 Discussion
### 💬 Discussion (read-write)
| Channel Name | Channel Use |
|----------------|----------------------------------------------------------|
| #introductions | New? Pop in here and say hi :) |
| #general | General chat - anything goes |
| #cookbook | Discussions specifically around the cookbook and recipes |
| #kubernetes | Discussions about Kubernetes |
| #docker-swarm | Discussions about Docker Swarm |
| #today-i-learned | Post tips/tricks you've stumbled across
| #jobs | For seeking / advertising jobs, bounties, projects, etc |
| #promotion | In here you can advertise your stream, services or websites, at a limit of 2 posts per day |
| #dev | Used for collaboratio around current development. |
| [#introductions](https://discord.com/channels/396055506072109067/586796820685127680) | New? Pop in here and say hi :) |
| [#general](https://discord.com/channels/396055506072109067/396055506663374849) | General chat - anything goes |
| [#cookbook](https://discord.com/channels/396055506072109067/456689991326760973) | Discussions specifically around the cookbook and recipes |
| [#kubernetes](https://discord.com/channels/396055506072109067/720432577823113237) | Discussions about Kubernetes |
| [#docker-swarm](https://discord.com/channels/396055506072109067/720432631853875251) | Discussions about Docker Swarm |
| [#today-i-learned](https://discord.com/channels/396055506072109067/647643207932313620) | Post tips/tricks you've stumbled across
| [#jobs](https://discord.com/channels/396055506072109067/566348370466308096) | For seeking / advertising jobs, bounties, projects, etc |
| [#promotion](https://discord.com/channels/396055506072109067/645577294223769620) | In here you can advertise your stream, services or websites, at a limit of 2 posts per day |
| [#dev](https://discord.com/channels/396055506072109067/473408473497993236) | Used for collaboration around current development.
### ❤️ Premium ([sponsors][github_sponsor])
[Sponsors][github_sponsor] get extra super-duper secrit access to the following:
| Channel Name | Channel Use |
|----------------|----------------------------------------------------------|
| [#premium-chat](https://discord.com/channels/396055506072109067/396058059182440448) | Premium discussion |
| [#premium-support](https://discord.com/channels/396055506072109067/1024789060348284989) | Premium support (*Discord forums, not synced*) |
|
## How to get help.
@@ -83,3 +104,5 @@ Discord supports minimal message formatting using [markdown](https://support.dis
!!! tip "Editing your most recent message"
You can edit your most-recent message by pushing the up arrow, make your edits, and then push `Enter` to save!
--8<-- "common-links.md"

87
docs/community/matrix.md
View File

@@ -7,69 +7,67 @@ status: new
# How to geek out in [m]atrix
If you're hesitant to dip your toes into the wall-garden of our [Discord server](http://chat.funkypenguin.co.nz), then Matrix is the place for you!
Do you want to talk to somebody, stat!? Are you a fan of group messaging / chat platforms, but you're wary of "big tech" owned platforms? Do you prefer [tooting][review/mastodon] to tweeting?
!!! question "Eh? What's this federated chat thing? Who own my data? (/puts on tin-foil hat) !!"
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.](https://www.youtube.com/watch?v=1qHoSWxVqtE)..
Scratch your itch for realtime communication, without tech obligarch vanity concerns, on our [Matrix server](https://matrix.funkypenguin.co.nz)! (*which is also synced with our [Discord][community/discord] and [Slack][community/slack] servers*)
1. Native markdown for code blocks
2. Drag-drop screenshots
3. Costs nothing, no ads
4. Mobile notifications are reliable, individual channels mutable, etc
---
[![Matrix](https://img.shields.io/matrix/geek-cookbook:matrix.funkypenguin.co.nz?label=geeks&logo=matrix&logoColor=white)][community/matrix]
[![Discord](https://img.shields.io/discord/396055506072109067?label=geeks&logo=discord&logoColor=white)][community/discord]
[![Slack](https://img.shields.io/badge/geeks-42-green?style=flat&logo=slack)][community/slack]
!!! question "Eh? What's this federated chat thing? Who own my data? (*/me puts on tin-foil hat*) !!"
1. Matrix is a **federedated** group messaging platform. This means that you can sign in to **any** Matrix instance (*even your own!*), and participate in **any** room on **any** server!
2. Also, since Matrix is an open standard, there are a [plethora of clients](https://matrix.org/clients/) you can use!
## How do I join the Matrix server?
1. If you already have a matrix account, you can use it to access our server (the magic of federation). See the channels list below for details
1. If you already have an account on a matrix server (*a "home server"*), you can use it to access our server (*the magic of federation*). See the channels list below for details
2. If you don't have an account yet, [create one](https://m.fnky.nz), using your email address, or just login with GitHub
3. Use the WebUI, or get one of the [many available](https://matrix.org/clients/) mobile / desktop clients
4. Join the channels you're interested in (*below*)! and say hi!
## How do I search?
Maybe it's just my years of using Discord, but I expected to be able to enter any search string in the main "search" field in my Matrix client, and have the relevant messages surfaced. Turns out, that's not how it works! The primary "search" field in the Elements UI, for example, searches **room names** (*i.e., show me all the rooms matching the string "chat"*). To search **within** a room, it's necessary to first navigate to that room, and then "room search" is a contextual action you can take **within** the room. I've not yet found out how do a partial string match though (*"chatgpt" matches, but "chatgp" does no*t).
## 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/), and use of the Matrix instance is subject to this 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/), and use of our Matrix server is subject to this code of conduct.
## Channels
### 📔 Information
### 📔 Information (read-only)
The following channels are automated, and provide updates for issues like new PRs, subreddit posts, etc:
| Channel Name | Channel Use |
|--------------------|------------------------------------------------------------|
| [#announcements](https://matrix.to/#/#announcements:m.fnky.nz) | Used for important announcements |
| #cookbook-updates | Updates on all pushes to the master branch of the cookbook |
| #premix-updates | Updates on all pushes to the master branch of the premix |
| #discourse-updates | Updates to Discourse topics |
| [#announcements](https://matrix.to/#/#announcements:matrix.funkypenguin.co.nz) | Used for community announcements |
| [#blog-posts](https://matrix.to/#/#blog-posts:matrix.funkypenguin.co.nz) | Receives announcemnets about new [Geek Cookbook Blog Posts](/blog/) |
| [#cookbook-updates](https://matrix.to/#/#cookbook-updates:matrix.funkypenguin.co.nz) | Issues, PRs, commits on the [geek-cookbook/geek-cookbook](https://matrix.to/#/#geek-cookbook:matrix.funkypenguin.co.nz) repo |
| [#premix-updates](https://matrix.to/#/#premix-updates:matrix.funkypenguin.co.nz) | Issues, PRs, commits on the [funkypenguin/geek-cookbook-premix](https://github.com/funkypenguin/geek-cookbook-premix) repo |
|[#forum-threads](https://matrix.to/#/#forum-threads:matrix.funkypenguin.co.nz) | New and updated [forum threads](https://forum.funkypenguin.co.nz) |
| [#subreddit-posts](https://matrix.to/#/#subreddit-posts:matrix.funkypenguin.co.nz) | New topics in [r/funkypenguin](https://reddit.com/r/funkypenguin) |
### 💬 Discussion
### 💬 Discussion (read-write)
| Channel Name | Channel Use |
|----------------|----------------------------------------------------------|
| #introductions | New? Pop in here and say hi :) |
| [#general](https://matrix.to/#/#general:m.fnky.nz) | General chat - anything goes |
| [#cookbook](https://matrix.to/#/#cookbook:m.fnky.nz) | Discussions specifically around the cookbook and recipes |
| [#kubernetes](https://matrix.to/#/#kubernetes:m.fnky.nz) | Discussions about Kubernetes |
| [#docker-swarm](https://matrix.to/#/#docker-swarm:m.fnky.nz) | Discussions about Docker Swarm |
| #today-i-learned | Post tips/tricks you've stumbled across
| [#jobs](https://matrix.to/#/#jobs:m.fnky.nz) | For seeking / advertising jobs, bounties, projects, etc |
| [#advertisements](https://matrix.to/#/#advertisments:m.fnky.nz) | In here you can advertise your stream, services or websites, at a limit of 2 posts per day |
| [#dev](https://matrix.to/#/#dev:m.fnky.nz) | Used for collaboratio around current development. |
| [#introductions](https://matrix.to/#/#introductions:matrix.funkypenguin.co.nz) | New? Pop in here and say hi :) |
| [#general](https://matrix.to/#/#general:matrix.funkypenguin.co.nz) | General chat - anything goes |
| [#cookbook](https://matrix.to/#/#cookbook:matrix.funkypenguin.co.nz) | Discussions specifically around the cookbook and recipes |
| [#kubernetes](https://matrix.to/#/#kubernetes:matrix.funkypenguin.co.nz) | Discussions about Kubernetes |
| [#docker-swarm](https://matrix.to/#/#docker-swarm:matrix.funkypenguin.co.nz) | Discussions about Docker Swarm |
| [#today-i-learned](https://matrix.to/#/#today-i-learned:matrix.funkypenguin.co.nz) | Post tips/tricks you've stumbled across
| [#jobs](https://matrix.to/#/#jobs:matrix.funkypenguin.co.nz) | For seeking / advertising jobs, bounties, projects, etc |
| [#promotion](https://matrix.to/#/#promotion:matrix.funkypenguin.co.nz) | In here you can advertise your stream, services or websites, at a limit of 2 posts per day |
| [#dev](https://matrix.to/#/#dev:matrix.funkypenguin.co.nz) | Used for collaboration around current development.
### Suggestions
### ❤️ Premium ([sponsors][github_sponsor])
| Channel Name | Channel Use |
|--------------|-------------------------------------|
| #in-flight | A list of all suggestions in-flight |
| #completed | A list of completed suggestions |
[Sponsors][github_sponsor] get extra super-duper secrit access to the following:
### Music
| Channel Name | Channel Use |
|------------------|-----------------------------------|
| #music | DJs go here to control music |
| #listen-to-music | Jump in here to rock out to music |
| Channel Name | Channel Use |
|----------------|----------------------------------------------------------|
| [#premium-chat](https://matrix.to/#/#premium-chat:matrix.funkypenguin.co.nz) | Premium discussion |
| [#premium-support](https://matrix.to/#/#premium-support:matrix.funkypenguin.co.nz) | Premium support |
## How to get help.
@@ -86,6 +84,10 @@ Invite your co-geeks to Discord by:
1. Sending them a link to <http://chat.funkypenguin.co.nz>, or
2. Right-click on the Discord server name and click "Invite People"
## How do I search?
Maybe it's just my years of using Discord, but I expected to be able to enter any search string in the main "search" field in my Matrix client, and have the relevant messages surfaced. Turns out, that's not how it works! The primary "search" field in the Elements UI, for example, searches **room names** (*i.e., show me all the rooms matching the string "chat"*). To search **within** a room, it's necessary to first navigate to that room, and then "room search" is a contextual action you can take **within** the room. I've not yet found out how do a partial string match though (*"chatgpt" matches, but "chatgp" does not*).
## Formatting your message
Discord supports minimal message formatting using [markdown](https://support.discord.com/hc/en-us/articles/210298617-Markdown-Text-101-Chat-Formatting-Bold-Italic-Underline-).
@@ -93,9 +95,4 @@ Discord supports minimal message formatting using [markdown](https://support.dis
!!! tip "Editing your most recent message"
You can edit your most-recent message by pushing the up arrow, make your edits, and then push `Enter` to save!
## How do I suggest something?
1. Find the #completed channel (*under the **Suggestions** category*), and confirm that your suggestion hasn't already been voted on.
2. Find the #in-flight channel (*also under **Suggestions***), and confirm that your suggestion isn't already in-flight (*but not completed yet*)
3. In any channel, type `!suggest [your suggestion goes here]`. A post will be created in #in-flight for other users to vote on your suggestion. Suggestions change color as more users vote on them.
4. When your suggestion is completed (*or a decision has been made*), you'll receive a DM from carl-bot
--8<-- "common-links.md"

49
docs/community/slack.md
View File

@@ -5,7 +5,16 @@ icon: fontawesome/brands/slack
status: new
---
# How to geek on Slack
# Join our Geeky Slack server
Do you live in Slack? Are you a master of the search, filter, status, and mobile notifications?
One of the most realtime and exciting way engage with our geeky community is in our Slack server (*which is also synced with our [Discord][community/discord] and [Matrix][community/matrix] servers*)
---
[![Matrix](https://img.shields.io/matrix/geek-cookbook:matrix.funkypenguin.co.nz?label=geeks&logo=matrix&logoColor=white)][community/matrix]
[![Discord](https://img.shields.io/discord/396055506072109067?label=geeks&logo=discord&logoColor=white)][community/discord]
[![Slack](https://img.shields.io/badge/geeks-42-green?style=flat&logo=slack)][community/slack]
## Get yer invite!
@@ -15,6 +24,44 @@ Joing a Slack server requires an invite. To get yours, go [here](https://communi
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/). Use of the Slack server is subject to this code of conduct.
## Channels
### 📔 Information (read-only)
The following channels are automated, and provide updates for issues like new PRs, subreddit posts, etc:
| Channel Name | Channel Use |
|--------------------|------------------------------------------------------------|
| [#announcements](https://funkypenguin.slack.com/archives/C04QW5XS1SS) | Used for community announcements |
| [#blog-posts](https://funkypenguin.slack.com/archives/C04R58A1WH2) | Receives announcemnets about new [Geek Cookbook Blog Posts](/blog/) |
| [#cookbook-updates](https://funkypenguin.slack.com/archives/C04QB7WKNFQ) | Issues, PRs, commits on the [geek-cookbook/geek-cookbook](https://github.com/geek-cookbook/geek-cookbook) repo |
| [#premix-updates](https://funkypenguin.slack.com/archives/C04QW81EP4N) | Issues, PRs, commits on the [funkypenguin/geek-cookbook-premix](https://github.com/funkypenguin/geek-cookbook-premix) repo |
|[#forum-threads](https://funkypenguin.slack.com/archives/C04RSGHR2GY) | New and updated [forum threads](https://forum.funkypenguin.co.nz) |
| [#subreddit-posts](https://funkypenguin.slack.com/archives/C04QW84UAPQ) | New topics in [r/funkypenguin](https://reddit.com/r/funkypenguin) |
### 💬 Discussion (read-write)
| Channel Name | Channel Use |
|----------------|----------------------------------------------------------|
| [#introductions](https://funkypenguin.slack.com/archives/C04QF0P5VPX) | New? Pop in here and say hi :) |
| [#general](https://funkypenguin.slack.com/archives/CFQRX6SKS) | General chat - anything goes |
| [#cookbook](https://funkypenguin.slack.com/archives/C04PYJHM78D) | Discussions specifically around the cookbook and recipes |
| [#kubernetes](https://funkypenguin.slack.com/archives/C04PP838W6B) | Discussions about Kubernetes |
| [#docker-swarm](https://funkypenguin.slack.com/archives/C04Q1DAF9MZ) | Discussions about Docker Swarm |
| [#today-i-learned](https://funkypenguin.slack.com/archives/C04QP9X7TE2) | Post tips/tricks you've stumbled across
| [#jobs](https://funkypenguin.slack.com/archives/C04QR7LJF32) | For seeking / advertising jobs, bounties, projects, etc |
| [#promotion](https://funkypenguin.slack.com/archives/C04RBV16MGQ) | In here you can advertise your stream, services or websites, at a limit of 2 posts per day |
| [#dev](https://funkypenguin.slack.com/archives/C04PYJJKY4D) | Used for collaboration around current development. |
### ❤️ Premium ([sponsors][github_sponsor])
[Sponsors][github_sponsor] get extra super-duper secrit access to the following:
| Channel Name | Channel Use |
|----------------|----------------------------------------------------------|
| [#premium-chat](https://funkypenguin.slack.com/archives/C04RSAM4VPS) | Premium discussion |
| [#premium-support](https://funkypenguin.slack.com/archives/C04RT0D32MN) | Premium support |
## Spread the love (inviting others)
Invite your co-geeks to Slack by sending them a link to this page, or directly to the [invite generator](https://communityinviter.com/apps/funkypenguin/geek-with-us)

4
mkdocs.yml
View File

@@ -294,8 +294,8 @@ nav:
- Contribute: community/contribute.md
- Code of Conduct: community/code-of-conduct.md
- Discord: community/discord.md
# - Slack: community/slack.md
# - Matrix: community/matrix.md
- Slack: community/slack.md
- Matrix: community/matrix.md
- Reddit: community/reddit.md
- Mastodon: community/mastodon.md
- Forum: community/discourse.md