This Github repo is a folk of the Ultra Essentials Project developed by the DigEd (Digital Education) team at Cardiff University. The original project was developed with Xerte and published at Ultra Essentials. The aim of this folk is to see if we can use Git and Github as an alternative solution to improve the current workflow.
With that in mind, there are a few objectives I'd like to achieve:
One of the aims of this project is to introduce a new workflow that encourages collaboration, contributions, and version control for resource development and documentation. By using Git and Github, we are hoping to implement a system for team members and external contributors to suggest edits, improvements, and additions to the resources.
Contributions from within the organisation and outside the organisation are welcome. The following steps are recommended for contributing to the project.
Different ways of contributing to the project:
For more information on how to contribute to the project, please see the contribution guidelines for this project.
Though Xerte is a great tool for creating online resources, it is not ideal for creating collaborative documentations. It also creates a lot of barriers when it comes to ownership, version control, and collaboration.
Here are some of the challenges we have identified:
When we think about version control, we often think about software development. However, version control can be used for any type of project that involves multiple people working on the same files. It is a great way to keep track of changes and to collaborate with others.
Benefits of using Git and Github:
There are many resources available for learning Git and Github. Here are a few that we recommend:
You may have noticed that the project has also been published to https://dandange8005.github.io/ultra-essentials/ which is a documentation site hosted on Github. It uses a tool called MKDocs to help with generating the site from the files that are stored in markdown format.
MkDocs is a static site generator that allows you to create a website from a set of markdown files. It is a Python-based tool that is easy to use and configure. It also provides a number of themes and plugins to customise the look and feel of the website.
For more information on MkDocs, please see the user guide.
Material for MkDocs is a theme for MkDocs that is based on the Material Design guidelines. It provides a clean and modern look and feel for your documentation. It also provides a number of features such as a search bar, a table of contents, and a sidebar.
Benefits of using Material for MkDocs:
For more information on Material for MkDocs, please see the documentation.