Contributing

# How you can help

This website is meant to be a shared and collaborative effort. Due to this, we'd like this website to remain as simple to run as possible and the decisions made to bring it to life were for exactly this reason.
We will welcome any contributions you can make, but there are some changes that we will have to consider delicately if ever suggested.

# What is used to create this website?

We use the Zola Static Site Engine to generate the public website files you are viewing right now. This choice is purposeful for the following reasons:

1. We can use basic Web concepts and building blocks. HTML, CSS, and JavaScript. All content is written using the CommonMark markdown specification.
2. No dependencies. If we need to move the website to another host setup and configuration is as simple as setting up a webserver, getting a certificate, and cloning the public repo. In short, this website can be rebuilt in just a few moments without advanced knowledge of databases and other systems.
3. Zola makes no assumptions of the structure of the website. We are free to design and implement features that work for us, rather than conforming to the structure that some other Static Site Generators require.

Content changes can be made using the markdown files in the content directory.
The template structure is in the templates directory.
We use the Foundation CSS front-end framework for the style of this website, and additional CSS tweaks can be made using the SCSS CSS extension language. The scss files are located in the sass/css/ directory. The colour theme we have been using is Nord though this isn't set in stone.

When the site is built, it is pushed to the pages branch of public files in the Codeberg Repo. We then have a script that checks this repository every 5 minutes for changes, and pulls them down to the web server if changes have been made. At this point, the latest content should be live on the website.

We feel this set of tools gives the best balance between simplcity and features.

# Help we need

We welcome anyone that wishes to contribute. Here is a list of things that we would appreciate assistance with.

• Artwork
  • Perhaps a logo of sorts that can be displayed on the website.
• Wording
  • Spelling and Grammer corrections are welcomed!
• Translations
  • Zola supports translations, so it would be great to be able to have content written in different languages to cater for this. We may need to do some site structure magic to get this to work nicely, so let's plan something out!
• Documentation
  • We've done our best, but if something doesn't read well we welcome any adjustment.
  • Expertise documentation - The site structure allows for adding a description of the expertise tags which will be shown on their appropriate tag list page. It would be great to expand this as new tags are added.
• Anything else
  • If you have an idea please let us know!

# How?

Please visit our Codeberg Repository to clone the repo, make your changes, then create a pull request.