Update Syniti Replicate Documentation

Overview

This product is called Syniti Data Replication in the desktop version prior to 10. The cloud version is called Syniti Replicate. The desktop versions after 10 are also called Syniti Replicate.

The tickets to track updates to the desktop version of Syniti Data Replication (product name prior to 10) and Syniti Replicate (product name 10 and later) are tracked on the DBM board in Jira. Many of these tickets are difficult to understand, highly technical and many do not require documentation. Ask developers about documentation content at the time of release for the desktop version.

Tickets to track updates to Syniti Replicate (cloud) are tracked on the KYB board. For Syniti Replicate (cloud), the help is in the form for page level help and field level help only. We do not yet have online help that is specific to the Syniti Replicate product in the cloud.

The documentation updates for Syniti Replicate (cloud) follow the same steps as Add In-line and Page Level Help.

Documentation updates in the Users Guide (online help) for Syniti Data Replication/Syniti Replicate when a new desktop version is released:

  • Update What’s New with their content.

  • Update use cases as developers point out where changes are need
  • Update the version number on these pages:

    • Quick Start Guide

    • Whats New in Release

    • Upgrading to the latest version

With each desktop release of Syniti Data Replication/Syniti Replicate, there are also 43 Configuration Guides in Word that must be updated and made into pdfs.

When updating these guides:

  1. Change the version number in the Word doc and create a new PDF

  2. Remove the second page, the version history.

  3. Do not add security to the pdf. Users must be able to copy the code from it.

NOTE: There is also API help, but this is generated when the product itslef is built. Even though the API Help is stored in the repo, it is not produced by the Documentation team. Devs have to forward. The latest vesion of the API help was produced in 2021.

Update User's Guide and API Help

NOTE: To update the User Guide and API Help, you need a login to AWS. Contact Syniti Support for help getting a login. They will send you a detailed set of steps to log in to AWS and your specific links.

To update the User’s Guide/API Help on a new release:

  1. PM/Development informs the Doc team of what changes impact documentation.

  2. Pull down the latest release branch in git

  3. Create the new release branch using the naming convention /release/###, for example /release/9.8.2.

  4. Make changes to Flare and build the project (HTML5 output).

  5. Access the Output folder, and rename the HTML5 folder to UsersGuide. If a folder already exists with that name, delete it.
  6. Push the new release branch up to the db-moto-docs repo.

  7. To upload the help files, log in to AWS using the two-factor authentication.

    NOTE: Contact the IT Help Desk for a login to AWS. You will be given instructions and links unique to your login credentials that are used to upload the files to the server.

  8. Navigate to the two specific links provided by support.

  9. Create the new folder for the new release (for example 1010).

  10. Open the folder and upload the new version, which is the entire UsersGuide folder. If you are updating, remove the UsersGuide folder that's there before uploading. This process may take a few minutes. If you get a message that a file isn’t uploading successfully, there may have been a hiccup in the connection. Delete what has been uploaded and try uploading the folder again.

  11. Upload the API Help folder to this same folder. The API Help is stored in the folder in the root of the project.
  12. View the link to help in production to verify the changes are there. https://sdrhelp.syniti.com/1010/UsersGuide/Quick_Start.htm

Update the Configuration Guides

For each release of the desktop version, development provides details on what changes need to be made. At the very least, the version number on all the files needs to be updated and new PDFs generated and uploaded.

To update the Configuration Guides:

Navigate to [file path].https://drive.google.com/drive/folders/0B7bmwABAYi-wNUJPcHJmV0ttWDQ?resourcekey=0-Hb6QALRZ5wnSTVdluvukKQ&usp=share_link

  1. Download the most recent version of the Configuration Guides.

  2. Rename the folder and all the Word documents to include the new version number.

    NOTE: You don’t have to update the Version History table

  3. Open each Word doc and update the version number on the title page.

  4. Make any other changes that were provided by Development.

  5. Generate a PDF for each file. Delete the Version History page from the PDF.

  6. Upload the final PDFs to the Google drive.

  7. Replace the PDFs on their respective articles on the Syniti Support site.

File Locations

Document

Format

Sources

Published Location

User’s Guide

HTML5

Flare project stored in git under dbmoto-docs.

Hosted server for HTML5 - UsersGuide folder

User’s Guide Top Page

This is the page that displays when a user enters a wrong URL.

HTML5

All_SDR_Guides

Directory stored in git under dbmoto-docs

Hosted server for HTML5 - root folder

API Help

HTML5

Generated during product build. Stored in git under dbmoto-docs

Hosted Server - APIHelp folder

Setup Guides

PDF

Word files for completed versions in Product Documentation folder on google drive

The most recent folder for Word sources is https://drive.google.com/drive/folders/1d09ONvTXXOhMaN-uqj2wfpoe4dyEnR-C?usp=sharing

The most recent folder for PDF deliverables is:

https://drive.google.com/drive/folders/1S2mwY87IoU0Z_Ds08yyOosuleqj6gL31?usp=sharing

 Google drive (PDF for use by support)Help Center