This documentation covers using Netlify CMS to write content for the Open Practice Library. At a high level the workflow is fairly simple:
Improve This Practiceor to propose a new practice select
Add a Practicewithin the navigation sidebar.
Practiceyou want to implement or improve.
githubusername to the end of the authors list.
Save. The moderators will pick up the changes from there!
For even more details on these, see the guides below for Content Writers and Content Moderators:
If you're new to the CMS and have not created content before; there are two things you need to do before creating content
With a GitHub account created add your author information to the CMS by filling in the fields (only name and github username are mandatory). Hit save and this will create a Pull Request to add your author into the Git repository.
Before you continue, please check the Pre-Requisites above (for example, that you have a valid GitHub.com account)
We are using Netlify CMS to update this content.
GitHubusername to the list of Authors to get a writers credit.
Add media galleryto add media content that is relevant to helping others understand your practice.
Add links we loveto add articles, podcasts, videos, etc. that are also helpful to understanding and facilitating your practice.
Once you have added your content, click the blue "Save" button at the top of the screen.
Change the Status to "In Review".
This will raise a pull request on the underlying GitHub repository which can then be actioned by one of the site moderators.
If you try to publish the Practice yourself, you will see an error as it needs to be curated by a moderator.
You will receive emails once the content has been actioned.
These actions could be to add/change or content if everything is good, you will receive and email saying that the content has been merged (accepted in to the library).
You can use the first steps in the above workflow to edit content. Select the practice you wish edit. Don't forget to update the date and click "Save" once you have edited the content.
An email will be sent to the moderators who will approve the change.
As a moderator, you will receive and email to say that new content has been added.
If you require more information or would like changed to be made, write the comment in the "Leave a Comment" box.
Note: Add @username in the comment so the originator receives the email. The originators user name can be found in the "Commits" tab.
If you are happy with the content and there are no conflicts, click the "Merge pull Request" button followed by the "Confirm Merge" button. Add some additional comments if required.
stagingenvironment. To deploy the change to the main site, raise a PR from
main. On GitHub, navigate to the
stagingbranch which should be ahead of
mainand hit raise PR. Merge the change set as you did before.