Use CI to run a test build and deploy Docusaurus site to GitHub Pages

[jwflory]

Summary

Use a Continuous Integration (CI) tool (e.g. GitHub Actions or Circle CI) to deploy Docusaurus source to HTML without manual updates

Background

The docs site should use a CI tool to deploy the final HTML. This makes collaboration with others easier and simplifies the process to update docs. Removing the manual build step saves time and also allows you to validate changes made by others when they open a Pull Request.

Details

This requires using a CI tool like GitHub Actions or Circle CI to handle the deployment part. Some basic scripting is needed to set up the CI tool to build the docs site locally, and then force-push the built HTML to GitHub Pages. There is a large ecosystem of community-made GitHub Actions to search. These templates might make the work easier.

Other examples:

• VRapeutic: Website, CI pipeline, config
• qAIRa: Website, CI pipeline, config
• UNICEF Inventory: Website, CI pipeline, config
• fossrit.github.io: Website, CI pipeline, config

Outcome

• Easier to maintain the docs site
• Easy to validate if latest changes in GitHub are deployed to the public Internet
• Model best practices for future Innovation Fund teams