-
Notifications
You must be signed in to change notification settings - Fork 2.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Extract rules to top-meta and fetch/parse them from there onto the app #4022
Comments
Isn't this covered by TheOdinProject/top-meta#281 ? |
@Asartea it's part of it. This change needs to happen for several reasons too :) |
@JoshDevHub Just to be sure regarding the acceptance criteria: The copy will become the source of truth correct? And the other file will be manually updated or removed so we don't have 2 copies to maintain? The issue we've had in the past was one of the copies being forgotten and getting outdated so I just want to be extra extra sure :D I will also assign this to you since this was already discussed on discord afaik. |
@ManonLef Yes you're correct. The intent would be that the top-meta rules will be the only rules. Future updates to the rules would go there and not on the site. I'll edit the acceptance criteria for clarity on that point. |
Voicing my support for this as a concept 🐢 |
PR to the top-meta repo with the rules in a Markdown file: TheOdinProject/top-meta#288 |
Complete the following REQUIRED checkboxes:
brief description of request
format, e.g.Add dark mode to website
The following checkbox is OPTIONAL:
1. Description of the Feature Request:
For building a new feature of for odin-bot, it'd help the developers if the community discord rules existed in a markdown file. We could duplicate the rules into a markdown file somewhere, but then there would be two sources of truth for that information. Keeping them in-sync would be a problem.
So a solution could be to extract the rules into a markdown file that lives in the top-meta repo. The Odin site can fetch and parse this in a similar fashion to how it currently works with the curriculum repo's lessons. This allows one source of truth for the rules to live on top-meta, and other tools (ie the site and the bot) can programmatically interact with that file.
2. Acceptance Criteria:
The text was updated successfully, but these errors were encountered: