python-discord
Smarter Resources: Document new pipeline for suggesting resources.
As we complete the Smarter Resources project, we'll want to carefully document precisely how a member of the community (staff member or otherwise) can suggest a new resource to be added to our list of resources.
The following must be documented:
- How to suggest a new resource for inclusion
- How to implement a new resource. What files need to be edited, and how?
- The review process for a new resource. Who reviews and approves these suggestions?
How to suggest a new resource for inclusion
The current consensus among those who have voiced their opinion is that new resource suggestions can be submitted as issues in this repository. Beyond that, we'll need to iron out what we want people to say when they go to suggest a new resource and come up with a set of issue labels that will make the pipeline easiest to manage.
How to implement a new resource. What files need to be edited, and how?
As someone with no front-end experience, my inclination is to put resources in a yaml file and handle how resources get presented separately. I hope to recruit someone into the project who knows what the UI/UX considerations are.
The review process for a new resource. Who reviews and approves these suggestions?
I'd like to keep a registry of which staff members have certain domain knowledge and who would be willing to review or endorse suggestions. (I treat "review" and "endorse" separately because I don't expect any of our staff members to, for example, read an entire book just for this project. If the time investment to review a certain resource is too high, we can accept those that someone feels they can endorse based on prior familiarity or the resource being reputable within that domain.)
@swfarnsworth this all sounds fine.
re: yaml file for resources - this is already how it works in the dewikified site.
@swfarnsworth
Would you say this is solved? If you would, please close it.
@minalike mentions this is mostly solved, but having a link on the resources page to something setting the process in text may be a good idea.
(handcrafted in hours of work by mina)
Hi @minalike, are you still working on this, or has it been solved?
If it isn't, may I know whether the below is accurate and up-to-date as of writing?
How to suggest a new resource for inclusion
Opening an issue in meta repo with this link.
The review process for a new resource. Who reviews and approves these suggestions?
Is there any new information for this since this issue was last active?
How to implement a new resource. What files need to be edited, and how?
There are examples in pydis_site/apps/resources/resources. Some guidelines for each key would be useful, such as...
- Sticking to
color: darkrather thanblackafter we have a dark theme - Adding goodreads link for books
- Using title icons or image
Hi @hedyhli, all of that looks good to me! I've unassigned myself from the issue, feel free to take over.
A little update on this issue:
-
[x] How to suggest a new resource for inclusion (done in #1226)
-
[x] How to implement a new resource. What files need to be edited, and how? (done in #1226)
-
[ ] The review process for a new resource. Who reviews and approves these suggestions? @swfarnsworth has mentioned they'll work on this once they've wrapped up the year-end survey project.