Repository navigation
Description
This issue is for the ongoing project to migrate all the pinned messages in #discord-bots to the website under the guides.
Pins to be Migrated
If any of the pins below are checked off (checkmark next to the pin), a pull request has already been opened for that pin, and the pull request will be linked.
- Messages with Colors (Krypton) (Added Discord messages with colors guide #691)
- Discord Embed Limits (Krypton) (Added Discord embed limits guide #690)
- Custom Help Commands (Raven) (Add custom help command #698)
- VPS services (Python) (Migrate VPS services pin by Python bot to site #697)
- Replit vs Heroku (Raven) this is to be added to the above VPS page
- Discord bot token information (Tizzy) (Migrate "Keeping Discord Bot Tokens Safe" pin #701)
- Why JSON is unsuitable as a database (Xithrius) (Don't do JSON as a database, kids. #700)
- Fixing SSL Certificate Issue (Stella) (Migration of SSL verification error pin #796)
- Setting different statuses on your bot (iamericfletcher) (Migrate Setting Different Statuses to Set Your Bot Pin by Python Bot #709)
- on_command_error eating unhandled errors (Atom) (Migrate on_command_error pin #765)
Additional Topics
The following topics below are additional topics that can be added to the site, regarding discord bots.
- Tutorial on subclassing Bot (Subclassing bot #702) (Waiting for author)
- Tutorial on subclassing Context (Subclassing context.md #703) (Needs review)
- DevOps guide for Discord Bots (Created a guide on how to run a bot with Docker and setup GitHub Actions for CI #746) (Waiting for author)
- Hikari guide (Add a basic guide for Hikari in the Guides. #738) (Closed due to lack of review)
- Application Commands Guide (Added discord-app-commands.md #733) (Waiting for author)
Tags
Per request, we also want to scope the addition of new tags as part of this project.
These tags should follow the same traditional pattern as any other tag that we would add.
They should mostly cover common "pitfalls" or "gotchas" or any other very common topic that would benefit from a tag, as everything else (like a getting started guide)
is covered both in discord.py's documentation and our own site resources. Below are a few to start off with:
- Message content intent (Message content intent tag bot#2566)
- Bot not responding to commands (briefly mention the above message content tag, but primarily explain
@bot.eventandon_message) (on-message-event tag bot#2567) - Short tag linking to #discord-bot-hosting (Add tag for Discord bot hosting bot#2472)
If anybody has any more ideas, please feel free to leave them in the comments below.
If you'd like to work on any of then, mention @Robin5605 with which one you want to take on.
Helping with the migration of pin(s)
If anyone wants to help migrate a pin, you would want to create a markdown file here within pydis_site/apps/content/resources/guides/python-guides, with a structure along the lines of:
---
title: Guide Title
description: Guide Description
---
# Pin content goes herePlease read this guide on how to contribute a page.
Activity
sue-m-oh commentedon Nov 21, 2022
Hi @Robin5605
Can you please look into combining these duplicate files? They share duplicate content.
Robin5605 commentedon Nov 21, 2022
#799
Robin5605 commentedon Dec 26, 2022
Hello! So the main goal of the project is complete. All the pins linked here have been migrated to site. The only ones left are the "additional topics" (#702 and #703).
Can we consider this project to be complete, or do we want to include the additional topics section as part of the project as well?
Thanks!
Robin5605 commentedon Feb 6, 2023
Updated original comment with the new "Tags" section which has been scoped as part of this project
salty-tree commentedon Feb 9, 2023
Can I make a page on using cogs/extensions?
jchristgit commentedon Mar 10, 2023
Let's keep it open until we have those two PRs merged. I think we should have that done soon 🙂
jchristgit commentedon Mar 10, 2023
@n0Oo0Oo0b Personally I'm not opposed to it but I believe it would be better to discuss in a new issue, as this one is mainly related to migrating existing content. Could you open one?
Xithrius commentedon Jun 10, 2023
Two previously mentioned PRs have been merged, along with everything else listed in the main comment of this issue.