Welcome to the GitHub repository for OpenDataology's public website!
The website is hosted at http://www.opendataology.com:30000.
We use Hugo with the google/docsy theme for styling and site structure, and Netlify to manage the deployment of the site.
Here's a quick guide to updating the docs:
-
Fork the OpenDataology/website repository on GitHub.
-
Make your changes and send a pull request (PR).
-
If you're not yet ready for a review, add "WIP" to the PR name to indicate it's a work in progress.
-
Wait for the automated PR workflow to do some checks. When it's ready, you should see a comment like this:
deploy/netlify — Deploy preview ready! -
Click Details to the right of "Deploy preview ready" to see a preview of your updates.
-
Continue updating your doc and pushing your changes until you're happy with the content.
-
When you're ready for a review, add a comment to the PR, remove any holds or "WIP" markers, and assign a reviewer/approver. See the OpenDataology contributor guide.