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/10/19 15:52] – 10.91.120.28 | userguidesanddocumentation:updatinguserguides [2021/11/23 11:34] (current) – 10.91.120.28 | ||
|---|---|---|---|
| Line 29: | Line 29: | ||
| ---- | ---- | ||
| - | ===== Updating | + | ===== Deploying For A Release |
| - | If you are on the ops team and a support request requires an update | + | * Deployments |
| + | * Once logged in, open the **Errigal Support Documentation** project. | ||
| + | * Then select **Build With Parameters** | ||
| + | * Fill in the parameters (described below) | ||
| + | * For a release you'll need to deploy: **Release-Notes, User-Guides, Supplemental-Documentation** | ||
| + | * Ensure the build runs and completes successfully i.e. all of the build steps are green on the status page. | ||
| + | * Verify | ||
| - | Here are the steps to update a user guide: | + | **Deployment Parameters:** |
| - | **1. Pull the repo and perform your updates:** | + | |
| + | * **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 | ||
| + | | ||
| - | - Pull the latest version | + | **Customer & Env Note:** ATC + EXT are the only customers currently that have their own versions |
| - | - 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 | + | |
| - | - Once your document is open, perform any necessary updates | + | |
| - | - Note: some documents | + | |
| + | ---- | ||
| - | **2. Generate the PDF versions of the user guide:** | + | ===== Updating A 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. | + | If you are on the ops team and a support request requires an update to a user guide, |
| - | - 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**. | ||
| - | You should be presented with the following set of dropdowns: | ||
| - | * GENERATE: yes | ||
| - | * DEPLOY: yes (we want to deploy so set this to yes) | ||
| - | * FORMAT: pdf (the format of documents to deploy) | ||
| - | * DOCS: User-Guides (this denotes the documents to be deployed: User Guides, Release Notes, or Supplemental Documentation to correspond with the Support page setup) | ||
| - | * CUSTOMER: NCS (customer to deploy the documents to) | ||
| - | * ENV: IRONMAN (select the correct environment) | ||
| - | * AUTHOR: ERRIGAL (Enter your own name to track the changes) | ||
| - | - Select **Build** once you're happy with the selections | ||
| - | - Make sure the process is done and no failures from Jenkins are there | ||
| - | - Navigate to the Support Page instance and verify the files were deployed correctly | ||
userguidesanddocumentation/updatinguserguides.1634655164.txt.gz · Last modified: 2021/10/19 15:52 by 10.91.120.28
Page Tools
