oss-slu.github.io

This website is built using Docusaurus 2, a modern static website generator.

Making Contributions

Requirements

Docusaurus requires Node.js version 16.14 or above.

This website uses react-pdf.

How to make updates

1. Fork this repository.
2. Run npm start to start a local development server.
3. Check out the open issues or make updates as seen fit.

Making a pull-request

Follow this tutorial in the GitHub Docs to create a pull request. If fixing an open issue, please include the issue number in the title of the pull request (for example, "Fixed issue #7 -- Brief description").

Deployment

This project deploys using GitHub actions. The .github/workflows folder contains .yml files that will build and deploy the changes when a pull request is approved and merged with the main branch.

The community behind this repository

Join the Open Source with SLU Slack Workspace to get involved in the community that is associated with this organization and this website:

Join Slack Now