update inventory, credential, template, cicd logs

Signed-off-by: Sanjula Ganepola <[email protected]>

Author: SanjulaGanepola

docs/guides/cicd/Configure_Log_Level.md

@@ -1,3 +1,16 @@
-IBM i CI/CD supports configuring log levels and viewing GUI logs.
-* [Configure Log Level](Configure_Log_Level.md)
-* [View Logs](View_Logs.md) 
+# Manage Logs
+
+## Configure Log Level
+IBM i CI/CD GUI supports configuring the log level. The default log level is INFO, but that sets it to a different level is supported.
+
+The log levels supported for GUI are **OFF**, **SEVERE**, **WARNING**, **INFO**, **FINEST**, **ALL**.  
+
+![CICD_Configure_Log_Level](../../images/guides/CICD_Configure_Log_Level.png)
+
+## View Logs
+IBM i CI/CD GUI supports viewing and downloading GUI logs.
+
+* View logs - Double-click the log file or click the **View** button to open the log file.  
+* Download logs - Click the **Download** button to download the log file to the local file system.
+
+![CICDViewGUILog](../../images/guides/CICDViewGuiLogs.png)

docs/guides/cicd/Manage_Logs.md

@@ -1,20 +1,20 @@
 # Manage Credentials  
-The Credential works for managing the credential info used for Merlin. It will save the credential info, including username, password, ssh key, API token, etc. The detailed credential info will be changed according to the credential type. Now Merlin supports four types of credentials same as the inventory host types.  
-Go to Merlin GUI, **Connections -> Credentials**, user will turn to the Credentials page.  
+The Credentials manage the credential info used for Merlin. It will save the credential info including `username`, `password`, `ssh key`, `API token`, etc. The detailed credential info will be changed according to the credential type. Merlin supports four types of credentials which are the same as the inventory host types.
+
+Go to Merlin GUI and select **Connections -> Credentials** to go to the Credentials page.  
 
 <img src="../../images/guides/Credentials.png" width = "800" height = "500" alt="Credential" align=center />
 
-For the Admin side,  all credentials will be shown, for the user side, all the own Credentials will be shown, it includes Name, Type, Description, Owner, Created Time, and Updated Time.  
-- **Add Credential**  
-Click the Add button, Add the credential name, and select the credential type, the detailed credential info will be shown. According to the credential type, the credential info is difference.   
-For credential of IBM i as an example, user must enter the username and password of IBM i server, or the +Add button will be disabled.  Optionally, ssh key information can be specified.  If specified, the ssh key will be used instead of the password to connect to the IBM i during the IDE developer build process.   
- Note: if using ssh key, additional configuration is performed during connection to the IBM i before the build starts.
+An admin will see all credentials, but a user will only see credentials which they own. It will display the `Name`, `Type`, `Description`, `Owner`, `Created Time`, and `Updated Time`. 
+
+- **Add Credential** - Click the `+ Add` button and enter the `Name` and `Type`. After the type is selected, the required fields will updated. For example, if `IBM i` is the selected type, users must enter the `username` and `password` of the IBM i server or the `+ Add` button will be disabled.  Optionally, ssh key information can be specified. If specified, the ssh key will be used instead of the password to connect to the IBM i during the IDE developer build process. Specify all the necessary fields and click the `+ Add` button so then the new credential record will be imported to the Credentials table.
+
+  **Note**: If using ssh key, additional configuration is performed during connection to the IBM i before the build starts.  
+
+  <img src="../../images/guides/AddCredentials.png" width = "600" height = "300" alt="Add Credential" align=center />
+
+- **Delete Credentials** - The `Delete` button is disabled by default. Selecting items in the credential table will highlight them and also enable the `Delete` button. Click the `Delete` button and click `Yes` to the confirmation to delete all selected items.
 
-<img src="../../images/guides/AddCredentials.png" width = "600" height = "300" alt="Add Credential" align=center />
+- **Edit Credential** - The `Edit` button is disabled by default. Selecting one item in the credential table will highlight it and also enable the `Edit` button. Click the `Edit` button to see the credential info. All fields may edited except the `owner`.
 
-- **Delete Credentials**  
-The delete button is disabled by default. Select items in the credentials table, and the selected item will change to highlight and the delete button change to available status.  Click the delete button and click yes to confirm that will delete the selected items.
-- **Edit Credential**  
-The Edit button is disabled by default.  Select one item in the credential table, the selected item will change to highlight and the Edit button change to available status, click the Edit button, the credential info will be shown.  All fields can be edited except the owner.    
-- **Refresh Credentials**  
-Click the refresh button, the Merlin GUI will get a refresh so that to get the latest credentials information.
+- **Refresh Credentials** - Click the `Refresh` button for the Merlin GUI to retrieve the latest credential info.

docs/guides/cicd/View_Logs.md

@@ -1,30 +1,24 @@
 # Manage Inventory
-The inventory works for managing the systems information used for Merlin. It will save the general system information including hostname, type, and description and some other information. Merlin supports four types of hosts, IBM i, Power VC, IBM Cloud, and Jenkins.  
+The Inventory manages the systems information used for Merlin. It will save the general system information including hostname, type, description and some other information. The detailed inventory info will be changed according to the inventory type. Merlin supports four types of hosts: `IBM i`, `IBM PowerVC`, `IBM Cloud`, and `Jenkins`.  
+
 Go to Merlin GUI and select **Connections -> Inventory** to go to the Inventory page.    
 
 <img src="../../images/guides/Addinventory0.png" width = "800" height = "500" alt="Inventory" align=center />  
 
-All the Inventories which the user created or has permission to will be shown. It includes Name, Hostname, Type, Description, Owner, Provision, Created Time, and Updated Time. The Provision item is a tag that specifies the IBM i server deployed by the Power VC template.  
-- **Add Inventory**   
-Click Add button, enter the Name, Type and Hostname.  After the type is selected, the required info will update.  If one of requirements are not meet,  the +Add button will stay disabled.  
-
-<img src="../../images/guides/Addinventory.png" width = "400" height = "250" alt="Add Inventory" align=center />    
+All the inventories which the user created or has permission to will be shown. It will display the `Name`, `Hostname`, `Type`, `Description`, `Owner`, `Provision`, `Created Time`, and `Updated Time`. The `Provision` item is a tag that specifies the IBM i server deployed by the Power VC template.  
 
-Specify all necessary fields and click +Add button, then the new inventory record will be imported.   
-For the security connections, Merlin supports Test TLS function, that allow customer to accept the remote CA. Such as Power VC Inventory.
+- **Add Inventory** - Click the `+ Add` button and enter the `Name`, `Type` and `Hostname`.  After the type is selected, the required fields will updated. If one of requirements are not meet,  the `+ Add` button will stay disabled. Specify all the necessary fields and click the `+ Add` button so then the new inventory record will be imported to the Inventory table.
 
-<img src="../../images/guides/Pvcinventory.png" width = "400" height = "300" alt="Add power vc inventory" align=center />  
+  <img src="../../images/guides/Addinventory.png" width = "400" height = "250" alt="Add Inventory" align=center />    
 
-Specify the Hostname and Port, the Test TLS button will be enabled, and it will catch the Power VC CA.  In the detailed certificate windows, click the Accept button.  Then this CA be added to Merlin trust store.
+  For the security connections, Merlin supports the `Test TLS` function which allows customers to accept the remote CA such as for a Power VC Inventory. After specifying the `Hostname` and `Port`, the `Test TLS` button will be enabled and it will catch the Power VC CA. In the detailed certificate windows, click the `Accept` button. Then this CA be added to the Merlin trust store.
 
-**Note:** Please avoid to use those specific characters .,:;/\"*?<>|=+&%'`@" in Name field. The Hostname supports IP, Hostname, and URL.  
+  <img src="../../images/guides/Pvcinventory.png" width = "400" height = "300" alt="Add power vc inventory" align=center />  
 
-- **Delete Inventory**  
-The delete button is disabled by default.  Select items in the inventory table, and the selected items will change to highlight and the delete button change to available status.  Click the delete button, and click yes for the confirmation that will delete all selected items.
+**Note:** For the `Name` field, please avoid the use of the special characters .,:;/\"*?<>|=+&%'\`@". The `Hostname` field supports `IP`, `Hostname`, and `URL`.  
 
-- **Edit Inventory**  
-The Edit button is disabled by default.  Select one item in the inventory table, and the selected item will change to highlight and the Edit button change to available status. Click the Edit button, the inventory info will be shown, all fields are able to be edited except the owner.
-- **Refresh Inventory**   
-Click the refresh button, the Merlin GUI will get a refresh so that to get the latest inventory info.
+- **Delete Inventory** - The `Delete` button is disabled by default. Selecting items in the inventory table will highlight them and also enable the `Delete` button. Click the `Delete` button and click `Yes` to the confirmation to delete all selected items.
 
+- **Edit Inventory**  - The `Edit` button is disabled by default. Selecting one item in the inventory table will highlight it and also enable the `Edit` button. Click the `Edit` button to see the inventory info. All fields may edited except the `owner`.
 
+- **Refresh Inventory** - Click the `Refresh` button for the Merlin GUI to retrieve the latest inventory info.

docs/guides/platform/ManageCredential.md

@@ -1,30 +1,26 @@
 # Manage Templates
-The Templates work for managing the template info used for Merlin. It will save the template info, including Name, Inventory, Credential, type, owner, and description. The credential and type info will be changed according to the Inventory type. Now Merlin supports four types of templates same as the inventory host types.    
-Go to Merlin GUI, **Connections -> Templates**, user will turn to the Templates page.  
+The Templates manage the template info used for Merlin. It will save the template info including `Name`, `Inventory`, `Credential`, `type`, `owner`, and `description`. The credential and type info will be changed according to the inventory type. Merlin supports four types of templates which are the same as the inventory host types.
+
+Go to Merlin GUI and select **Connections -> Templates** to go to the Templates page.  
 
 <img src="../../images/guides/Templates.png" width = "800" height = "500" alt="Templates" align=center />  
 
-For the Admin side, all templates will be shown, but the run action only works on own templates, for the user side, all own templates will be shown, it includes Name, Inventory, Credential, Type, Owner, Created Time, and Updated Time by default. Users also could customize the columns by clicking the icon at the right top of the table.  
-- **Add Template**  
-Click the Add button, add the Template name, and select an inventory, the template type is the same type as inventory, the credential will be filter to the same type. According to the inventory type, the other required fields will be difference.   
-Use Power VC as example, user must enter the vm info which used in this template, or the +Add button will keep disabled. 
+An admin will see all templates, but the `Run` button will only work on templates which they own. A user will only see templates which they own. It will display the `Name`, `Inventory`, `Credential`, `Type`, `Owner`, `Created Time`, and `Updated Time` by default. Users can also customize the columns by clicking the icon at the top right of the table.
+
+- **Add Template** - Click the `+ Add` button and enter the `Name` and select an inventory. The `type` will be automatically populated to be the same as the inventory type. The listed credentials to select from will also be filtered to match the same type. After the type is set, the required fields will updated. For example, if `IBM PowerVC` is the set type, users must enter the vm info which is used in this template or the `+ Add` button will be disabled. Specify all the necessary fields and click the `+ Add` button so then the new template record will be imported to the Templates table.
+
+  <img src="../../images/guides/PvcTemplate.png" width = "600" height = "400" alt="Add Templates" align=center />
+
+- **Delete Templates** - The `Delete` button is disabled by default. Selecting items in the credential table will highlight them and also enable the `Delete` button. Click the `Delete` button and click `Yes` to the confirmation to delete all selected items.
 
-<img src="../../images/guides/PvcTemplate.png" width = "600" height = "400" alt="Add Templates" align=center /> 
+- **Edit Template** - The `Edit` button is disabled by default. Selecting one item in the template table will highlight it and also enable the `Edit` button. Click the `Edit` button to see the template info. All fields may edited except the `owner`.
 
-Fill all necessary fields, the +Add button will be able to click, click the +Add, the new template info will be imported to Templates table.
-- **Delete Templates**  
- The delete button is disabled by default, select items in the Templates table, the selected items will change to highlight and the delete button change to available status, click the delete button, and click yes to confirm that will delete all selected items.
-- **Edit Template**  
- The Edit button is disabled by default, select one item in the Templates table, the selected item will change to highlight and the Edit button change to available status, click the Edit button, the template info will be shown, all fields can be edited except the owner.
-- **Run Template**  
-The Run is disabled by default, select one item in the Templates table, the selected item will change to highlight, and the run button change to available status. According to the different templates type, the action will be different.  
-For the Power VC template, Merlin supports the Provision actions, that will help the user to deploy a new IBM VM, the user should make sure all the hardware configurations have been set up on the Power VC side.    
+- **Run Template** - The `Run` button is disabled by default. Selecting one item in the template table will highlight it and also enable the `Run` button. According to the different templates type, the available actions will be different. For a Power VC template, Merlin supports the Provision actions which will help the user to deploy a new IBM VM. The user should make sure all the hardware configurations have been set up on the Power VC side.    
 
-<img src="../../images/guides/PvcAction.png" width = "600" height = "200" alt="Power VC Templates Action" align=center />  
+  <img src="../../images/guides/PvcAction.png" width = "600" height = "200" alt="Power VC Templates Action" align=center />  
 
-For the IBM i server template, Merlin supports Enable Ansible environment, Validate the dependent PTFs, Install Certificate, Enable IBM i developer environment, and Enable ARCAD environment.   
+  For the IBM i server template, Merlin supports `Enable Ansible environment`, `Validate the dependent PTFs`, `Install Certificate`, `Enable IBM i developer environment`, `Enable IBM i Debug Service`, and `Enable ARCAD environment`.   
 
-<img src="../../images/guides/IAction.png" width = "600" height = "200" alt="IBM i Templates Action" align=center />  
+  <img src="../../images/guides/IAction.png" width = "600" height = "200" alt="IBM i Templates Action" align=center />  
 
-- **Refresh Templates**  
-Click the refresh button, the Merlin GUI will get a refresh so that to get the latest Templates info.
+- **Refresh Templates** - Click the `Refresh` button for the Merlin GUI to retrieve the latest template info.