How to contribute#
Depending on what you would like to do there are different ways to get involved. Please check out the options below! If you can’t find what you are looking for then send us an email and we will help! You can also come to our open community co-working calls if you would like to chat to us about an idea you have had.
Suggesting new or improved Data Hazards#
In the first instance please start a Discussion with your idea in the ‘Ideas’ category. We can then chat openly on GitHub about the suggestion, and this gives other people the opportunity to weigh-in on any changes we are considering. Once changes have been agreed then you can follow the process below for making changes to the website.
If you would rather you can also email us to discuss.
Making changes to the website content#
This website is based on a tool called Sphinx, which allows us to create all our content in Markdown and render it as a website.
To find the documentation you want to change or add then follow the file path that is indicated by the website link from the
site folder in the repo.
To add the changes to the main repository then:
Fork this repository to your own GitHub account.
Check that you are happy with the changes by building the site locally.
Before submitting your changes, please add a note to the Change Log that describes the change you made.
Then, once you’ve made your changes, submit a pull request: we’ll review it as quick as we can 😄.
If you are fixing an issue then please comment on it before you start working so that we don’t repeat your work!
Build the site locally#
In order to build the site locally, you’ll need to run the following from your root directory:
sphinx-build site/ site/_build/
These require some Python packages to run.
You may want to set up a virtual environment first, so that you don’t install these packages system-wide.
Then you can install the packages using
pip install -r requirements.txt
We try to keep all our slides for Data Hazards on our website.
The current process is:
(Optional) create slides in powerpoint, upload to Google drive (which will convert it to Google slides) + check formatting (alternatively, create in Google slides)
Create a new markdown web page.
Publish google slides
File -> Publish to the web -> Embed -> Small
Copy and paste to new markdown web page.
Make viewable with link
Share -> Anyone on the internet with this link can view
Add link to markdown web page.
Recommendations for a process to create html slides that works with myst markdown extremely welcome!