TheOdinProject / top-meta

TOP hub for ongoing support and improvement of the curriculum by the maintainers
31 stars 10 forks source link

Restructure TOP-meta repo #281

Open ManonLef opened 1 year ago

ManonLef commented 1 year ago

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

FAQ

Roles

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

Bot updates

Repo Structure

JustWaveThings commented 1 year ago

Sorry, finger slipped on a checkbox... Don't want anyone searching for ninja edits...

BlizZard-bot commented 1 year ago

Love the idea! I don't see any reasons not to do so and it's definitely best to avoid having multiple copies of the same files across different repos.

ChargrilledChook commented 1 year ago

I'm a fan of the concept broadly, top meta seems like a fine place to put it, but maybe there are other options. Perhaps a community repo if it's distinct enough from meta. Either way deciding on a specific source of truth is more important than where to put it

Regarding having things be in the main app repo, I would strongly prefer it not to be the source of truth for these kind of community based things. I would also support moving those things out of the app repo where it makes sense / isn't directly relevant to the app

Will attempt to give more detailed feedback on specifics when I get a chance

KevinMulhern commented 1 year ago

Thanks for putting this together @ManonLef, sounds like a great idea to me.

rlmoser99 commented 1 year ago

In general everything sounds like a good idea. I like the idea of a community repo. The only concern that I have is the rules in theodinproject repo is not a markdown file, so I am not sure we can do the same update command that we have with the faq.

ManonLef commented 1 year ago

@rlmoser99 that’s the only file receiving special treatment in this plan because of that. Even though it’s a community document, it’s the only one having a dedicated webpage as well.

I thought moving that to another repo while also keeping it on the website might not be straightforward. Glad you’re all positive about the idea and willing to think about the above issue.

wise-king-sullyman commented 1 year ago

Sounds like a great idea to me as well 🔥 I feel like this repo makes sense for it, but also wouldn't be opposed to a community specific repo for these kinds of things.

ManonLef commented 1 year ago

I really like the idea of a community repo as well

ManonLef commented 1 year ago

I will take this on once I have a little more time. Probably when I'm out of the final CS project :)