Grav OER Content Space with Git Sync is designed to share and collaboratively edit Markdown-based Open Educational Resources.
Why use the Grav OER Content Space Project?
- To quickly leverage a modern flat-file CMS (i.e. Grav) for the creation and presentation of OER content
- To make OER content future-ready by keeping it always directly accessible (vs. within a specific platform)
- To provide direct access to OER content for site visitors (in Markdown or HTML format) to facilitate easier reuse
- To support collaboration and version control of OER content with the Git service (e.g. GitHub) of your choice
- To quickly and easily update OER content online or locally using the tools of your choice
- To provide a mobile and multi-device friendly visual presentation of your OER content
- To easily customize the presentation of your OER content using a visual theme builder (i.e. Gantry 5)
The Grav OER Content Space, along with my other Grav open education projects Course Hub and ePortfolio Blog, are also documented at learn.hibbittsdesign.org.
Example OER Content Space workflow
Step-by-Step Video (no audio)
The following install and configuration process usually takes under 5 minutes.
Grav OER Content Space with Git Sync - Install and Configure on Reclaim Hosting
1. Getting Ready
1.1 If you do not already have a Git service account (i.e. GitHub, GitLab, BitBucket, etc.) then sign up for one
1.2 Download OER Content Space skeleton package
1.3 Log into your Reclaim Hosting cPanel and go to the File Manager area
2. Installing the OER Content Space
2.1 Tap "Upload"
2.2 Tap "Select File"
2.3 Choose the downloaded OER Content Space ZIP file
2.4 Return to file listing view
2.5 Right-tap on OER Content Space ZIP file and choose "Extract"
2.6 Tap "Extract File(s)" button
2.7 Tap "Close" button
2.8 Note (and ideally copy to your clipboard) the folder name for use in the URL to your site
2.9 Visit the URL of your OER Content Space site and complete Admin config form
2.10 Tap on the arrow-circle button to preview site
3. Configure Git Sync Plugin
3.1 Tap the "Setup Git Sync Plugin (Step 1 of 2)" link
3.2 Tap the "Next" button
3.3 Choose Git service and enter your username and password for it
If you do not yet use a Git service, such as GitHub or GitLab, signup for one and then return to this step.
3.4 Scroll down (if needed) and the tap the "Next" button
3.5 Before continuing, you will need to create a repository on your Git service.
If you have already created a Git repository (with at least one commit, for example a ReadMe file) you may skip to step 3.10
3.6 Create a new repository in your choosen Git service (GitHub example shown)
3.7 Enter repository name
3.8 Choose to include a ReadMe file
3.9 Copy the HTTPS URL of the repository to your clipboard
3.10 Paste the Git repository HTTPS URL into the "Git Repository" field and tap "Test Connection"
3.11 Tap the "Next" button
3.12 Select the displayed Webhook URL and copy it to your clipboard
3.13 Add the Webhook to your Git repository settings, in GitHub tap "Settings"
3.14 Tap "Webhooks"
3.15 Tap "Add Webhook"
3.16 Paste the copied OER Content Space Webhook URL into the "Payload URL" field
Note: if you change the folder name or location of your Grav OER Content Space site you will also need to update the "Payload URL" field.
3.17 Scroll down, and tap "Add Webhook"
3.18 Once the new Webhook is displayed, return to your Grav OER Content Space site
3.19 Tap the "Save" button
3.20 Tap on the arrow-circle button to once again preview the site
4. Configure Edit/View Page in Git Particle
4.1 Tap on the "Setup Edit Page in Git Link (Step 2 of 2)" link
4.2 Tap on the cogs gear icon in the "Edit/View Page in Git" particle within the "Navigation" area
4.3 You will next need the URL to where your "pages" folder is stored within your Git repository, so return to your previously created Git repository
4.4 Open the "pages" folder within your Git repository
4.5 While viewing your "pages" folder, copy the entire URL from your Browser
4.6 Paste the URL of your Git repository, but remove '/pages/' and any other text after that
4.7 Tap the "Apply and Save" button
4.8 Tap on the arrow-circle button to once again preview the site
4.9 For your final test, tap the "Edit Page in GitHub" link
4.10 The OER Content Space site homepage, displayed in GitHub
5. Congratulations! You now have your OER Content Space with Git Sync installed and configured.