Entota™ Help updates can be published anytime. When a ticket on the Kyber board reaches Done status, it is deployed and the related documentation should be published. Refer to [Publish Entota™ Release Notes][IGCDocProcess_publishRN].
To publish IGC™ Help:
-
You can attach a Word doc to a ticket or you can link a Google doc in an Entota™ Dev team channel for review.
-
Next, when Help updates are written and reviewed (if needed), inform the Doc Team in the appropriate Slack Channel that you are going to check out Entota™ Help.
-
Synchronize your local repo’s develop branch with the remote develop branch
Synchronize your local repo’s develop branch with the remote develop branch
-
Right-click in your local repo folder and select Git Bash Here from the dropdown menu to open the command prompt at that location.
-
If you are not currently in the develop branch, switch to the develop branch by entering the git command cd develop.
NOTE: You will know you are in the correct directory by the command prompt, ex. Documents/GitHub/igc-help (develop) - shows repo name and branch name.
NOTE: If you do not have the develop branch in your local repo fetch it by entering the git command git fetch origin develop.
-
Enter the git command git pull origin develop to synchronize your local copy of the develop branch with the remote copy.
NOTE: You MUST perform these steps before you make updates to ensure you are working in the latest copy of the develop branch.
-
Now you can open your project in Flare and make your updates and they will be saved on the correct branch.
-
When you finish your updates, save your changes, and build and publish your target(s).
NOTE: It is necessary to build the target first, then publish it so that the Help Build Date is updated.
NOTE: You will need to update the path for the build folder (your desktop output folder) and publish destinations (make sure you select the correct folder for the correct help – IGCHelp or IGCWhatsNew) to your local folders.
{width=”5.03125in”
height=”2.604854549431321in”}
IMPORTANT: The Publish checkbox must be checked for the current target only. In the screen shot below, it is selected for the HTML5 IGC target, but not the HTML5 IGC What's New target. If both checkboxes are checked for a target, the help and the what's new help systems will have the same landing page (either Welcome.html or IGC Releases.html).
{width=”5.645833333333333in” height=”3.337435476815398in”}
-
In File Explorer, verify your updates are appearing correctly in the correct publish folder (IGCHelp or IGCWhatsNew).
{width=”4.40751968503937in”
height=”2.8521741032370955in”} -
Close Flare and Help output.
Commit updates locally and push to remote
-
Return to Git Bash or open a new session.
-
Navigate to your repo, and make sure you are in the correct branch. It is in parenthesis after your prompt.
-
Enter the git command git status to see all of the changes you have made.
NOTE: All of the updated files’ paths will appear in red.
NOTE: If you do not see them, you may have forgotten to save or you are in the wrong branch.
-
Stage your updates for commit by entering the command git add .
NOTE: The file paths will change from red to green after you stage them.
-
Commit staged updates by entering the command git commit -m “commit message that informs everyone what you have done”
NOTE: Do not use special characters, like apostrophes, in message.
-
Push your updates to the remote repo by entering the command git push origin develop.
-
Go to dev site(s) and check to see that the updates have been made. http://dev.general.igchelp.com/
-
Open a PR in GitHub to merge develop with master and assign it to another tech writer. Make sure to include JIRA ticket numbers and explanations for the peer reviewer in your PR comments so they know what to review on the dev site.
-
Message peer reviewer in Slack with link to PR in GitHub .
Peer Review updates – no changes necessary
-
As a reviewer, you will be notified via Slack chat or email you have been assigned a PR and you can click a link to view the pull request. Be sure to review the PR to see what updates the writer has made so you know what to check for on the dev site.
-
Go to dev site and check to see that the updates have been made. http://dev.general.igchelp.com/
-
If everything looks fine and no further updates are necessary, go to GitHub.com.
-
Make sure the PR is to merge the develop branch into the Master branch.
-
Click the Merge Pull Request button.
-
Click the Confirm Merge button.
-
All updates should show up on the main sites here:
-
Notify the PMs in the igc-help channel that the Help updates have been published.
Peer Review updates – changes necessary
-
As a reviewer, you will be notified via Slack chat or email you have been assigned a PR and you can click a link to view the pull request. Be sure to review the PR to see what updates the writer has made so you know what to check for on the dev site.
-
Go to dev site and check to see that the updates have been made.
-
If updates need to be made, right-click in your local repo folder and select Git Bash Here from the dropdown menu to open the command prompt at that location.
-
Switch to the develop branch locally by entering the git command git checkout develop
NOTE: The name in the parenthesis after the command prompt should change to the new branch name, meaning you can now open the files in Flare and see the changes.
-
Synchronize your local develop branch with the remote by entering the git command git pull origin develop.
NOTE: This step will pull down the updates made by the previous author.
-
Open Flare and make updates.
-
When you finish your updates, save your changes, and build and publish your target(s).
NOTE: It is necessary to build the target first, then publish it so that the Help Build Date is updated.
NOTE: You will need to update the path for the build folder (your desktop output folder) and publish destinations (make sure you select the correct folder for the correct help – IGCHelp or IGCWhatsNew) to your local folders.
{width=”5.03125in”
height=”2.604854549431321in”}
IMPORTANT: The Publish checkbox must be checked for the current target only. In the screen shot below, it is selected for the HTML5 IGC target, but not the HTML5 IGC What's New target. If both checkboxes are checked for a target, the help and the what's new help systems will have the same landing page (either Welcome.html or IGC Releases.html).
-
In File Explorer, verify your updates are appearing correctly in the correct publish folder (IGCHelp or IGCWhatsNew).
{width=”4.40751968503937in”
height=”2.8521741032370955in”} -
Close Flare and Help output.
-
Return to Git Bash or open a new session.
-
Navigate to your repo, and make sure you are in the correct branch. It is in parenthesis after your prompt.
-
Enter the git command git status to see all of the changes you have made.
NOTE: All of the updated files’ paths will appear in red.
NOTE: If you do not see them, you may have forgotten to save or you are in the wrong branch.
-
Stage your updates for commit by entering the command git add .
NOTE: The file paths will change from red to green after you stage them.
-
Commit staged updates by entering the command git commit -m “commit message that informs everyone what you have done”
NOTE: Do not use special characters, like apostrophes, in message.
-
Push your updates to the remote repo by entering the command git push origin develop.
-
Go to dev site and check to see that the updates have been made.
-
If everything looks fine and no further updates are necessary, go to GitHub.com.
-
Make sure the PR is to merge the develop branch into the Master branch.
-
Click the Merge Pull Request button.
-
Click the Confirm Merge button.
-
Click the Confirm Merge button.
-
All updates should show up on the main sites here:
-
Notify the PMs in the igc-help channel that the Help updates have been published.