-
Notifications
You must be signed in to change notification settings - Fork 151
Content Editing Workflow
Dan O. Williams edited this page Jul 20, 2020
·
4 revisions
Any member of the team should be empowered to make small updates to the content of the main website without having to wait for a new release to be created. The changes that should still go through the normal release process deal with major content changes to the site, structural changes to the site itself, and new content that is being added to the site.
These are content updates which are simply cleaning up or clarification of the existing content.
- Flag content that needs to be updated as an issue on github - This will serve as the historical record of the problem and any comments the team has on how it should be corrected.
- Create branch to create the change - By creating a separate branch, it will allow other team member the opportunity to make sure there isn't any site breaking changes present in the content updates.
- Make the content update and flag another team member for review - A second member of the team will review the final content draft.
- Create a pull request that merges the created branch with
main
- One final review of all the changes before it's merged into the live site.
These are content update that are serious errors or might mislead our users and need to be corrected as soon as possible.
- Flag content that needs to be updated as an issue on github, label the issue with the tag "Critical" - This will serve as the historical record of the problem and any comments the team has on how it should be corrected.
- Make the content update directly on the
main
branch and try to pair with another team member so reviews can happen in real time. - Merges the content directly onto the
main
- add any comments as to what the change was, why it was made, and who was present to help review it if applicable.