User Tools
userguidesanddocumentation:updatinguserguides
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| userguidesanddocumentation:updatinguserguides [2021/11/23 11:02] – 10.91.120.28 | userguidesanddocumentation:updatinguserguides [2021/11/23 11:34] (current) – 10.91.120.28 | ||
|---|---|---|---|
| Line 37: | Line 37: | ||
| * For a release you'll need to deploy: **Release-Notes, | * For a release you'll need to deploy: **Release-Notes, | ||
| * Ensure the build runs and completes successfully i.e. all of the build steps are green on the status page. | * Ensure the build runs and completes successfully i.e. all of the build steps are green on the status page. | ||
| - | * Verify the user guides + release notes have been deployed to the correct environment. | + | * Verify the user guides + release notes have been deployed to the correct environment. For example, all NCS user guides will be generated + deployed so some may need to be removed for KLA or SCO etc. |
| **Deployment Parameters: | **Deployment Parameters: | ||
| - | * Generate - Generate documents as part of this Jenkins job - YES/NO | + | |
| - | * Deploy - Deploy documents as part of this Jenkins job? - YES/NO | + | |
| - | * Format - The format to generate - PDF/HTML - Select PDF unless specified otherwise | + | |
| - | * Docs - Type of documents to deploy - Release-Notes, | + | |
| - | * Customer - Customer version of documents to generate - ATC/ | + | |
| - | * Env - Environment to deploy to - see properties.yml in Errigal-Document-Generation repo for more details | + | |
| - | * Author - Who made the changes - can leave as ERRIGAL | + | |
| + | |||
| + | **Customer & Env Note:** ATC + EXT are the only customers currently that have their own versions of documents. All other customers (SCO, KLA, Netrio) make use of the NCS (Non-customer specific) versions of documents. This is why only ATC + EXT are listed in the customer section as this determines how the documents are generated. | ||
| ---- | ---- | ||
| Line 53: | Line 55: | ||
| ===== Updating A User Guide ===== | ===== Updating A User Guide ===== | ||
| - | If you are on the ops team and a support request requires an update to a user guide, for instance, you can now pull down a copy of the repo, perform your updates, generate | + | If you are on the ops team and a support request requires an update to a user guide, for instance, you can now pull down a copy of the repo, perform your updates, generate a PR (include Michelle as an approver). |
| - | + | ||
| - | Here are the steps to update | + | |
| - | + | ||
| - | **1. Pull the repo and perform your updates: | + | |
| - | + | ||
| - | - Pull the latest version of the document generation repo linked here: [[https:// | + | |
| - | - Create a new branch to store your changes | + | |
| - | - Install **Typora** for editing markdown and open up the folder to navigate to the user guide you need to update. | + | |
| - | - Navigate to the **inputs** directory to find the user guide to update. Inputs are divided into User Guides, Release Notes & Supplemental Documentation in line with the Support Page setup. | + | |
| - | - Once your document is open, perform any necessary updates | + | |
| - | - Note: some documents contain customer-specific embedded files, these are denoted with something like: // | + | |
| - | + | ||
| - | + | ||
| - | **2. Generate the PDF versions of the user guide:** | + | |
| - | + | ||
| - | Note: This step isn't required unless you would like an immediate copy of the guide. The Jenkins job will generate and deploy the guides so it's not necessary. | + | |
| - | + | ||
| - | - With your update complete, it's time to generate a PDF version of the user guide for each relevant customer. | + | |
| - | - To determine the relevant customers for a user guide, consult the [[https:// | + | |
| - | - Look for the user guide on the Master Sheet tab and the associated customers will be next to it. For example: the EMS UG requires copies for ATC, EXT, NCS (KLA, SCO) - in this case, KLA & SCO will receive a copy of the NCS guide but we generate them separately into each customer folder to make deployment easier. | + | |
| - | - Next, open a command prompt and navigate to the document generation directory. | + | |
| - | - From here run the necessary commands to generate the PDF version of the user guide for each relevant customer. More detail on this is found in the **Code Usage** section of the repo's Readme file. | + | |
| - | - Here's an example snippet that generates an ATC PDF version of the AmCharts document: | + | |
| - | + | ||
| - | '' | + | |
| - | + | ||
| - | + | ||
| - | **3. Push the changes and generate a pull request: | + | |
| - | + | ||
| - | - Include in the commit message the relevant Ticket ID as well as the name of the user guide being updated. | + | |
| - | - Next, create a pull request and be sure to include Michelle so she can review the changes to confirm they are in line with Errigal standards, etc. | + | |
| - | - Once the pull request has been approved and the changes have been merged into the repo, the next step is to deploy the user guide to the relevant Support Page instance. | + | |
| - | + | ||
| - | **4. Deploy the user guide update to the Support Page:** | + | |
| - | - This can be manually done via the Support Page by uploading the file etc. More detail on that process can be found here: [[development: | ||
| - | - Alternatively, | ||
| - | - The Jenkins project is called **Errigal Support Documentation**. Open the project and select the option **Build With Parameters**. | ||
| - | - Fill out the build parameter (see section above for more detail) | ||
userguidesanddocumentation/updatinguserguides.1637665356.txt.gz · Last modified: 2021/11/23 11:02 by 10.91.120.28
Page Tools
