Skip to content

Restructure TOP-meta repo #281

@ManonLef

Description

@ManonLef

Summary

Restructure this repo and try to keep most of the top-meta discord channel content in this repo to be updated with new bot commands similar to the new /updatefaq command for Odin-Bot
I can see some conflicts with some of the content of those channels already being stored in the community guides of the curriculum

The reason I'm proposing this restructuring is because we worked on updating the FAQ roughly half a year ago and even though it was a good update, it kind of got forgotten about. Currently I personally have a hard time finding the discord specific content since they can be found both in the theodinproject repo community guides and in here. There are also some outdated or unused documents in here (matrix, roles).

I wrote the below criteria based on the idea of keeping everything that's related to discord in this repo. Perhaps a better location to keep the channel information can be found if you think it should be in theodinproject repo community guides for example. The end goal would be to have them all in one logical place, and to have only one version of a file like the faq so we avoid having 3 different version floating around.

With the current /updatefaq slash command it has become a lot less tedious to implement a change to the channel. In the past someone with access had to manually format and pass it through Dyno bot. That's now only one Odin-bot command away for the faq channel. Making quick edits to the documents can now be followed up with a bot command to refresh (or maybe even automatically in the future) and doesn't involve the more elaborate follow-up steps needed involving admins in the past.

It would be wonderful if proposing changes to and updating every meta discord channel becomes simpler (similar to faq).

Acceptance Criteria

All the points I can think of now:

Rules

  • Decide the best place for the "Rules" document since that currently resides in the theodinproject repo. We can also link to it here as we currently do with the Moderation Matrix mentioned below
  • Rename or Replace the "Moderation Matrix" document depending on the main decision above.
  • Update both dead links to the rules in the "Moderation Matrix" Document if decided the rules will remain in the main repo.
  • Create a slash command to update the rules discord channel

FAQ

  • The most current faq Document will reside in this repo
  • slash command to update faq

Roles

  • The most current roles Document will reside in this repo
  • Decide on one description of the discord roles, resulting in one document/text for the Discord channel instead of the current discord content and this document
  • Create a slash command to update the roles discord channel but keep in mind the self-assigned roles in that channel as well
  • update doc with new roles like the backer role

perhaps the self assigning of roles can also be done with the discord community features nowadays, I haven't fully checked the options

Contact Moderators

  • Add a channel explanation document for the top message on when/how the contact-moderators channel should be used (copy current channel message on this)
  • The most current Modmail guide and channel explanation will reside in this repo
  • Create a slash command to update the contact-moderators discord channel with both of the above files

Bot updates

  • Decide if the slash commands should be updated to an automatic update when a doc gets a new commit. discord idea from Xari

Repo Structure

  • Place the discord channel specific docs in their own folder
  • Decide on a staff folder for the meeting notes, onboarding, guidelines and everything staff related
  • Add the application for Professional to the Roles

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions