Be signed into your github account
Click into packages/webapp/src/containers/ConsentForm/VersionsConsent
To update integration ensure you are on develop branch
To update production ensure you are on master branch
This is the folder that is holding the different consent form files
To replace a file, first make sure its a .docx file and is named correctly so that it can replace the older versions of the same name
So currently either ‘OwnerConsentForm.docx’ or ‘WorkerConsentForm.docx’
The contents of each word file must begin with Version <Version Number>:, e.g. Version 1.0:
The app determines the document version by reading the string between positions of the first occurance of a space character and a colon. It does not matter how long the version number string is.
When a user(not new) chooses a farm upon login, the version number in the document is compared with the number recorded in the database. Users will be redirected to /consent page if the numbers do not agree. Once agreed, the new version number is updated on the database.
Once you are ready to upload files to this folder, click on top right ‘add file’ button, then ‘upload file’
Select the replacement consent form file from your computer. Once you have done this, at the bottom of the screen you can write any message desired or not and click commit
Ways to check successful update:
In the versions folder, see that no new file was added, it was merely replacing the old file (if the name was the same this would be the case)
Can also wait for the build and double check the live version ~ 15 minutesin different languages
Click on the consent file you want to edit in the language you want to edit it options are:
en/Owner.Consent.md (english)
en/Worker.Consent.md (english)
es/Owner.Consent.md (spanish)
es/Worker.Consent.md (spanish)
pt/Owner.Consent.md (portuguese)
pt/Worker.Consent.md (portugese)
To modify the file, click on the pencil icon on the top right corner of the page
If you find you are having issues editing the file or don’t know how to, checkout the EDITING_TERMS
file.
Once you have finished making your modifications, scroll to the bottom of the page and click
Create a new branch for this commit and start a pull request. Learn more about pull requests.
After that click “Propose Changes”
...
Github will create a new branch with your changes, and you’ll be prompted to Open a pull request (as shown below):
...
Add a note describing your changes to the privacy policy and click “Create pull request” at the bottom right.
Now, you need to wait for your Pull Request to be approved by a member of the team. After that is done, you will see that file updated on the repository, or you will be able to check it out on the environment you modified it.