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

Improve Discord docs

Browse Source
This commit is contained in:
David Young
2020-06-12 10:13:51 +12:00
parent b95e849b7c
commit a01a4e0555
3 changed files with 66 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

107
manuscript/discord.md
View File

@@ -1,25 +1,68 @@
## A Beginners Guide to Discord
# Discord
The best way to engage with our geeky community is in our [Discord server](http://chat.funkypenguin.co.nz)
!!! 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.](https://www.youtube.com/watch?v=1qHoSWxVqtE)..
1. Native markdown for code blocks
2. Drag-drop screenshots
3. Costs nothing, no ads
4. Mobile notifications are reliable, individual channels mutable, etc
## How do I join the Discord server?
1. Create [an account](https://discordapp.com)
2. [Join the geek party](http://chat.funkypenguin.co.nz)!
## Code of Conduct
This section will be fleshed out in future, but as a guideline, all interaction is expected to be civil and respectful.
## 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 |
| #discourse-updates | Updates to Discourse topics |
### 💬 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 collaboratio around current development. |
### Why do we use Discord?
### Suggestions
We use discord because we feel that it is the easiest way for the geeky community to be able to communicate with each other without any hassle, Discord supports markdown so you can make your sentences bold, italic, underlined, you can automate many tasks on Discord for example when a change is made to the github repo it automaticlly posts to Discord.
| Channel Name | Channel Use |
|--------------|-------------------------------------|
| #in-flight | A list of all suggestions in-flight |
| #completed | A list of completed suggestions |
### How do I join the Discord server?
### Music
Once you have [Created An Account](https://discordapp.com) You can join the Funkypenguin Discord server [Here](https://discord.gg/NHZzU7Q)
### Discord code of conduct
Below is what we appreciate of users when they are on the server
Keep spam to a minimum
Being respectful to all users
Only advertising in the correct channels eg #advertisements or #jobs if its about a job position
| Channel Name | Channel Use |
|------------------|-----------------------------------|
| #music | DJs go here to control music |
| #listen-to-music | Jump in here to rock out to music |
### How to get help.
## How to get help.
If you need assistance at any time there are a few commands that you can run in order to get help.
@@ -28,42 +71,18 @@ If you need assistance at any time there are a few commands that you can run in
`!faq` Shows frequently asked questions.
### How Do I invite other people.
## Spread the love (inviting others)
If you want to send your friends a link to the Discord server there are two ways that you can do so. The most easiest way is you can send them http://chat.funkypenguin.co.nz Or you can right click on the Discord server and click "Invite People"
If you want to send your friends a link to the Discord server there are two ways that you can do so. The most easiest way is you can send them http://chat.funkypenguin.co.nz, or you can right click on the Discord server and click "Invite People"
## Formatting your message
### Formatting your message
Discord supports markdown, markdown allows you to format your messages for example you can bold your message, you can underline it. If you want to learn how to use markdown you can read one of the guides that Discord made on [how to use markdown](https://support.discord.com/hc/en-us/articles/210298617-Markdown-Text-101-Chat-Formatting-Bold-Italic-Underline-)
### What are each of the channels for?
Each channel has a purpose, All of the channels in the discord have a correct way of using them and incorrect ways
| Channel Name | Channel Use |
|-------------------|-----------------------------------------------------------------------------------------------|
| #announcements | This is the announcements channel where funkypenguin will send important information. |
| #changelog | This is the announcements channel where funkypenguin will send important information. |
| #discourse | Messages from the discourse are posted here. |
| #cookbook-updates | When the cookbook is updated it will be posted here. |
| #premix-updates | When the premix is updated it will be posted here. |
| #introductions | In here you can introduce yourself to the server. |
| #livegeeking | When funkypenguin goes live it will be posted in here. |
| #general | Used for general day to day conversations. |
| #suggestions | Used to post suggestions for the discord or the cookbook. |
| #cookbook | Used for discussions around the cookbook. |
| #dev | Used for conversations around development. |
| #💼jobs | This channel is used if any jobs need doing or if a certain company is hiring. |
| #advertisements | In here you can advertise your services and websites. |
| #TIL | Today I learnt, You can use this channel to post what you have learnt that day. |
### How do I suggest something?
## How do I suggest something?
The first thing you will need to do is find the #suggestions channel in the Discord. Next you will make sure that your suggestion has not been suggested before. You can see if your suggestion has been requested by either reading the channel or you can use the search feature in the top right of your screen. If it has not been suggested then you will type the following message `!suggest [Suggestion]` For example `!suggest A guide on how to use Discord`. When you send the message a new message will appear with your suggestion where users can upvote or downvote your suggestion.
If there is something that is not listed in this guide but you cannot figure out you can head over to Discords support center [here](https://support.discord.com/hc/en-us) where they have resources to help you. (Or you can suggest to edit this guide)

4
manuscript/support.md
View File

@@ -6,9 +6,9 @@ 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][1].
All the cool kids are hanging out in the [Discord server](/discord/).
> "Eh? What's Discord? Get off my lawn, young whippersnappers!!"
> "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]..

2
mkdocs.yml
View File

@@ -33,7 +33,6 @@ nav:
- Home:
- What is this: index.md
- About: whoami.md
- Discord: discord.md
- Sponsored Projects: sponsored-projects.md
# - 'Join Us! 🤝':
# - Hello: recipes/general/start.md
@@ -171,6 +170,7 @@ nav:
- CHANGELOG: CHANGELOG.md
- Support:
- Support: support.md
- Discord: discord.md
theme:
name: 'material'