CMS Sync Procedure

TODO - Finish overview

The CMS Sync procedure reconciles any changes made by the end user clients with the server GitHub repository. If this is not done, any server updates made by the developer will erase/remove end user changes. As such, it's important to do these syncs before working on areas in the feed and periodically.

cms-sync-1 command

TODO - Finish section

Before starting this procedure, make sure that your git status is clear and/or all changes are pushed up to the shared repo. In addition, inform any other developers you may be sharing access with to not push changes or merge anything with the main branch during this time.

Begin by running the following command:

./foreground.sh kipo 00100 cms-sync-1

and replace kipo with the name of your deployment.

There will be a few warning prompts reminding you of the steps you should take before starting; enter y at the prompts to continue.

TODO add text of prompts

After this procedure is done, run a git status check to review files that will be merged for any excessively large files/potential issues. (See Troubleshooting for more info)

cms-sync-2 command

TODO - Finish section

At this point, your local files will be synced up with the changes the end user has made, so save the files and push up to the repo branch you're working with.

Then, run the following command:

./foreground.sh kipo 00100 cms-sync-2

Again, enter y at the prompts to continue:

TODO add text of prompts

After this procedure is complete, the sync procedure is done and you can alert your dev team that the branches are available to receive commits again.

Troubleshooting

TODO