The "behind the scenes" of the ClimateTown Knowledge Hub (your "one stop shop" for important climate resources in the fight against climate change!).
All contributions welcome! Everything from:
- suggestions
- fixing typos
- writing content
- helping with website development
- discussing content on the hub (check out the channels on Discord for this!)
The following sections go through how you can make different contributions. These will require you having a GitHub account. If you have any questions about contributing, feel free to ask in the Discord.
Every page on the website has an "Edit this page" button. Clicking this will direct you to the exact file in the repo where the content is stored, so you have make the appropriate change to the page. Super easy!
Have an idea for the knowledge hub? Maybe its a topic you'd like, or a website feature. Make your suggestion by creating an issue, and following the steps provided there. The issue will act as a space for the topic to be discussed.
Want to make your own post? Great! Before launching on your writing spree, we recommend to first create an issue for the post. This allows us to discuss the addition to make sure its a good fit for the Knowledge Hub (and so others can also get involved if they want to!).
Posts are written in markdown (learn to write Markdown) in the content folder of the repo. Feel free to copy one of the existing posts to act as a starting point. The website theme used for the knowledge hub also has additional features such as highlighted note blocks (read the documentation).
If you're confident with Git, you can create a pull request once the post is written. If you're new to GitHub, you can use the issue you created to collaborate with a technical person to get your post added to the Hub.
Assuming you know Git/GitHub
Discussion regarding development is done in the issues. Here you're welcome to comment on existing issues and assign them to yourself, or create new issues if you have ideas on how the knowledge hub can be changed.
The site is built on Hugo using the Hugo Learn Theme.
First, install Hugo. Then clone this repo (or a fork of it) with the --recurse-submodules flag to ensure the theme is also downloaded:
git clone --recurse-submodules https://github.com/ClimateTown/knowledge-hub.gitcd into this folder, and run:
hugo server -w
Now you have a server running on localhost:1313 that will automatically update when you make changes to the files. Note that if you make changes to css or the config.toml file, you'll need to restart the server.
Read up on how Hugo works in the documentation. The directory structure of the repo follows a standard project directory structure
- Hugo for the static site generator
- Hugo Learn Theme
- Twemoji for emoji support