Merge pull request #27 from dxc-technology/sca01

Updated various sequences

Author: tom-halpin

CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to the Sequences As Code (SaC) project will be documented in
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.0.2] - 2020-08-23
+## [1.0.3] - 2020-08-24
 
 - Updated some sequence diagrams
 

images/sachelp.createnewinstance.svg

@@ -6,21 +6,34 @@ title
 
 end title
 
-start
-:Start;
-:Complete the prerequisites;
-note left
+actor Developer
+participant "Start" as A #lightGreen
+participant "Create New Repository" as B #white
+participant "Seed" as C #white
+participant "Fork" as D #white
+participant "Clone" as E #white
+participant "Update Package.json" as F #white
+participant "Replace SaC links" as G #white
+participant "Install Dependencies" as H #white
+participant "Add Missions & Sequences" as I #white
+participant "Test" as J #white
+participant "Commit" as K #white
+participant "Deploy" as L #white
+participant "Browse" as M #orange
+
+Developer -> A: Complete the prerequisites;
+note right
  Prerequisites listed in a dedicated sequence diagram under the help menu.
 end note
-:Create and configure a new git repository;
+Developer -> B: Create and configure a new git repository;
 note right
   Protect the master branch
   Enable branch protection rules
   Require reviews on PRs
   etc. etc.
 end note
-:Seed the repository with the current release of SaC, which is available at [[https://github.com/dxc-technology/Sequences-as-Code{Right click to open in a new window or a new tab} SaC repository]];
-note left
+Developer -> C: Seed the repository with the current release of SaC, which is available at [[https://github.com/dxc-technology/Sequences-as-Code{Right click to open in a new window or a new tab} SaC repository]];
+note right
   [[https://github.com/dxc-technology/Sequences-as-Code{Right click to open in a new window or a new tab} SaC repositories]] default pipeline includes
   - markdown spelling checks
   - dockerfile, json and js linting
@@ -30,30 +43,32 @@ note left
   - SVG diagrams generated from the sequence UML files and are committed to repository
   - code to deploy your site to the repositories GitHub pages site when the Master branch is updated.
 end note
-:Fork your newly created repository [[https://github.com/your_organization/your_repository{Right click to open in a new window or a new tab} Your repository]];
-:Clone your fork on your local machine;
-:Update the homepage value in the package.json file with the (case sensitive) address of your new repository;
+Developer -> D: Fork your newly created repository [[https://github.com/your_organization/your_repository{Right click to open in a new window or a new tab} Your repository]];
+Developer -> E: Clone your fork on your local machine
+Developer -> F: Update the homepage value in the package.json file with the (case sensitive) address of your new repository
 note right
   The base url for generated site needs to be set correctly for your missions and sequences to render.
 end note
-:Find and replace all references to the [[https://github.com/dxc-technology/Sequences-as-Code{Right click to open in a new window or a new tab} SaC repository]] with the address of your instace of the repository;
-note left
+Developer -> G: Find and replace all references to the [[https://github.com/dxc-technology/Sequences-as-Code{Right click to open in a new window or a new tab} SaC repository]] with the address of your instance of the repository;
+note right
   You can ignore the references in the sample uml and svg files as you presumably will be replacing those files.
 end note
-:Open a terminal session, go to your local folder and run <i>npm install</i>;
+Developer -> H: Open a terminal session, go to your local folder and run <i>npm install</i>;
 note right
   This is to install the dependencies in the local node_modules folder
 end note
-:Add missions and sequences;
+Developer -> I: Add missions and sequences
+note right
 :Remove the sample mission and sequence, entitled Your mission, created when you created the instance of the [[https://github.com/dxc-technology/Sequences-as-Code{Right click to open in a new window or a new tab} SaC repository]];
-note left
   Delete the entry for yourmission from missions.json.
   Delete the associated images/yourmission.svg and uml/yourmission.uml files from the sequences/yourmission folder.
 end note
-:Run unit tests;
-:Update any unit tests that need to be updated;
-:Commit your changes;
-:Deploy;
-:Verify your site is up and running. It should be available at [[https://github.com/pages/your_organization/your_repository{Right click to open in a new window or a new tab} Your repositories GitHub pages site]];;
-stop
+Developer -> J: Run unit tests
+note right
+  Remember to update any unit tests that need to be updated;
+end note
+Developer -> K: Commit your changes
+Developer -> L: Deploy
+Developer -> M: Verify your site is up and running. It should be available at [[https://github.com/pages/your_organization/your_repository{Right click to open in a new window or a new tab} Your repositories GitHub pages site]];
+
 @enduml

images/sachelp.updateinstance.svg

@@ -6,41 +6,63 @@ title
 
 end title
 
-start
-:Start;
-:Open a terminal session;
-:Go to your cloned copy of your dedicated instance of SaC;
-note left
- Clone will be of [[https://github.com/your_organization/your_repository{Right click to open in a new window or a new tab} Your repository]]
+actor Developer
+participant "Start" as A #lightGreen
+participant "Go to Clone" as B #white
+participant "Backup Clone" as C #white
+participant "Get Latest Release" as D #white
+participant "Apply Release" as E #white
+participant "Update package.json" as F #white
+participant "Replace SaC links" as G #white
+participant "Install Dependencies" as H #white
+participant "Reapply Missions & Sequences" as I #white
+participant "Remove Sample Mission" as J #white
+participant "Test" as K #white
+participant "Commit" as L #white
+participant "Deploy" as M #white
+participant "Browse" as N #orange
+
+Developer -> A: Open a terminal session
+Developer -> B: Go to your cloned copy of your dedicated instance of SaC
+note right
+   Clone will be of [[https://github.com/your_organization/your_repository{Right click to open in a new window or a new tab} Your repository]]
 end note
-:Back up your cloned files;
-:Get the updated version of SaC from the [[https://github.com/dxc-technology/Sequences-as-Code/releases{Right click to open in a new window or a new tab} Releases tab]] of the SaC repository;
-:Update the homepage value in the package.json file with the (case sensitive) address of your repository;
+Developer -> C: Back up your cloned files
+Developer -> D: Get the updated version of SaC from the [[https://github.com/dxc-technology/Sequences-as-Code/releases{Right click to open in a new window or a new tab} Releases tab]] of the SaC repository
+Developer -> E: Apply the latest version
+Developer -> F: Update the homepage value in the package.json file with the (case sensitive) address of your new repository
 note right
   The base url for generated site needs to be set correctly for your missions and sequences to render.
 end note
-:Find and replace all references to the [[https://github.com/dxc-technology/Sequences-as-Code{Right click to open in a new window or a new tab} SaC repository]] with the address of your instance of the repository;
-note left
+Developer -> G: Find and replace all references to the [[https://github.com/dxc-technology/Sequences-as-Code{Right click to open in a new window or a new tab} SaC repository]] with the address of your instance of the repository
+note right
   You can ignore the references in the sample uml and svg files as you presumably will be replacing those files.
 end note
-:Open a terminal session, go to your local folder and run <i>npm install</i>;
+Developer -> H: Open a terminal session, go to your local folder and run <i>npm install</i>
 note right
   This is to install any new or updated dependencies in the local node_modules folder
 end note
-:Reapply your missions and sequences;
+Developer -> I: Remove the sample mission and sequence, entitled Your mission, provided with the new release of the [[https://github.com/dxc-technology/Sequences-as-Code{Right click to open in a new window or a new tab} SaC repository]]
+note right
+  Delete the entry for yourmission from missions.json.
+  Delete the associated images/yourmission.svg and uml/yourmission.uml files from the sequences/yourmission folder.
+end note
+Developer -> J: Reapply your missions and sequences
 note right
   Re configure your missions and sequences in missions.json.
   Re add your sequence uml and svg files to the appropriate sequences sub-folder.
 end note
-:Remove the sample mission and sequence, entitled Your mission, provided with the new release of the [[https://github.com/dxc-technology/Sequences-as-Code{Right click to open in a new window or a new tab} SaC repository]];
-note left
-  Delete the entry for yourmission from missions.json.
-  Delete the associated images/yourmission.svg and uml/yourmission.uml files from the sequences/yourmission folder.
+Developer -> K: Run unit tests
+note right
+  Remember to update any unit tests that need to be updated
+end note
+Developer -> L: Commit your changes
+Developer -> M: Deploy
+Developer -> N: Verify your site is up and running. It should be available at [[https://github.com/pages/your_organization/your_repository{Right click to open in a new window or a new tab} Your repositories GitHub pages site]]
+note right
+  Remember to update any unit tests that need to be updated
 end note
-:Run unit tests;
-:Update any unit tests that need to be updated;
-:Commit your changes;
-:Deploy;
-:Verify your site is up and running. It should be available at [[https://github.com/pages/your_organization/your_repository{Right click to open in a new window or a new tab} Your repositories GitHub pages site]];;
-stop
+Developer -> L: Commit your changes
+Developer -> M: Deploy
+Developer -> N: Verify your site is up and running. It should be available at [[https://github.com/pages/your_organization/your_repository{Right click to open in a new window or a new tab} Your repositories GitHub pages site]]
 @enduml