Home

Climate Town Knowledge Hub Wiki

This wiki contains meta information (i.e. information regarding the hub itself).

Adding new resources

Suggesting a resource

Resources in the hub are suggested and onboarded through the use of GitHub Issue forms. These allow for easy tracking in the codebase. To add a add a new resource, you need to open the form to add a resource, fill out the form with the appropriate information, and submit the form.

Opening the form

Go to the GitHub Issues section, click "New Issue", and click on the "Resource Suggestion" form.

Fill out the form

The guidelines for adding resources are listed in the form. Some things to keep in mind are:

• For URLs, try use a durable URL. For example, try to link to the root of a website (https://someclimatewebsite.com) rather than a niche subpage (https://someclimatewebsite.com/blog/what-we-do-as-of-2022)
• For tags, try to use tags that already exist (rather than creating new tags). You can see available tags by going to https://climatetown.github.io/knowledge-hub/resources or looking at the file https://github.com/ClimateTown/knowledge-hub/blob/main/data/resource_tags.yml

For descriptions, a cheap way to currate a description is to riff off the description created by the owner of the website.

• Go to the website
• Open developper tools (Ctrl + Shift + C in Chrome), and search for the og:description tag. This tag (if specified in the site) provides the description for the site that is displayed in Discord/Facebook/Twitter embeds.

You can take this summary, and adapt it to:

• Remove bias (e.g. stuff like "We are the best...")
• Add additional context (is the person in charge of the site important in the climate movement? Is the initiative run by some coorporation whose association is important to disclose?)
• Be more specific (soometimes descriptions provided by websites don't attempt to answer the question of what they actually do)

The goal of the summary is to be informative to the users browsing the Knowledge Hub as to how they can benefit from the resource.

Resource approval process

When submitted, a resource then goes through an approval process to check the resource.

• Does the resource adhere to the guidelines laid out in the form?
• Can the title/tags/url/resource summary be improved? (e.g. is there additional context needed in the summary to disclose affiliations?)
• Is the resource itself relevant?

For major changes, discussing them with the original suggester is recommended. To actually change the title/tags/url/summary, mdoerators (and the original author) can update the body of the text for the issue.

To approve or disapprove a resource, moderators can add the approved or disapproved labels to the issue*. That's it!

When the script to onboard resources is next run, it will look at issues with the approved label, extract the relevant information, and make the appropriate edits. Once finalised, the changes are deployed and the issues corresponding to the now onboarded resource are now closed.

*when disapproved, put a message with a reason, and also "close" the issue