Updated the docs as per new UI (#281)

Co-authored-by: Pratheep Velicherla <[email protected]>
testsigmahq · Sep 22, 2023 · d1edd10 · d1edd10
1 parent 8c35296
commit d1edd10
Show file tree

Hide file tree

Showing 9 changed files with 219 additions and 249 deletions.
diff --git a/src/pages/docs/agent/setup-on-windows-mac-linux.md b/src/pages/docs/agent/setup-on-windows-mac-linux.md
diff --git a/src/pages/docs/continuous-integration/bitbucket-ci.md b/src/pages/docs/continuous-integration/bitbucket-ci.md
@@ -3,8 +3,17 @@ title: " Integrate Testsigma with Bitbucket CI"
 metadesc: "How to integrate Testsigma with Bitbucket CI"
 noindex: false
 order: 12.22
-page_id: " Integrate Testsigma with Bitbucket CI"
+page_id: "Integrate Testsigma with Bitbucket CI"
 warning: false
+contextual_links:
+- type: section
+  name: "Contents"
+- type: link
+  name: "Prerequisites:"
+  url: "#prerequisites"
+- type: link
+  name: "Steps to Integrate Bitbucket with Testsigma"
+  url: "#steps-to-integrate-bitbucket-with-testsigma"
 ---
 ---
 
@@ -53,4 +62,4 @@ pipelines:
 6. Once the job is completed you can see the execution report as an XML report based on the path you have shared on the shell script.
 ![Report](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/buildbb.png)
 
----
+---
diff --git a/src/pages/docs/integrations/bug-reporting/xray.md b/src/pages/docs/integrations/bug-reporting/xray.md
@@ -1,5 +1,5 @@
 ---
-title: "Xray Integration"
+title: "Xray Integration with Testsigma"
 page_title: "Xray Integration with Testsigma"
 metadesc: "Xray is a Test Management tool that gives the structure to organize, plan, and report the progress of testing. Learn how to integrate Xray with Testsigma"
 noindex: false
@@ -9,138 +9,106 @@ warning: false
 contextual_links:
 - type: section
   name: "Contents"
-- type: link
-  name: "Introduction"
-  url: "#introduction"
 - type: link
   name: "Prerequisites"
   url: "#prerequisites"
 - type: link
-  name: "Table of Contents"
-  url: "#table-of-contents"
-- type: link
-  name: "Introduction"
-  url: "#introduction"
-- type: link
-  name: "Pre-requisites"
-  url: "#pre-requisites"
-- type: link
-  name: "Steps to integrate Xray with Testsigma"
+  name: "Steps to Integrate Xray with Testsigma"
   url: "#steps-to-integrate-xray-with-testsigma"
 - type: link
-  name: "Steps to link an Xray test to a Testsigma test case"
-  url: "#steps-to-link-an-xray-test-to-a-testsigma-test-case"
+  name: "Steps to Link an Xray Test Case to a Testsigma Test Case"
+  url: "#steps-to-link-an-xray-test-case-to-a-testsigma-test-case"
 - type: link
   name: "Steps to link an Xray test set to a Testsigma test suite"
   url: "#steps-to-link-an-xray-test-set-to-a-testsigma-test-suite"
 - type: link
   name: "Steps to link an Xray test plan to a Testsigma test plan"
   url: "#steps-to-link-an-xray-test-plan-to-a-testsigma-test-plan"
-- type: link
-  name: "Steps to execute Xray linked tests in Testsigma"
-  url: "#steps-to-execute-xray-linked-tests-in-testsigma"
 ---
 
 ---
-## **Table of Contents**
 
-[Introduction](https://testsigma.com/docs/integrations/bug-reporting/xray/#introduction)<br>
-[Pre-requisites](#pre-requisites)<br>
-[Steps to integrate Xray with Testsigma](https://testsigma.com/docs/integrations/bug-reporting/xray/#steps-to-integrate-xray-with-testsigma)<br>
-[Steps to link an Xray test to a Testsigma test case](https://testsigma.com/docs/integrations/bug-reporting/xray/#steps-to-link-an-xray-test-to-a-testsigma-test-case)<br>
-[Steps to link an Xray test set to a Testsigma test suite](https://testsigma.com/docs/integrations/bug-reporting/xray/#steps-to-link-an-xray-test-set-to-a-testsigma-test-suite)<br>
-[Steps to link an Xray test plan to a Testsigma test plan](https://testsigma.com/docs/integrations/bug-reporting/xray/#steps-to-link-an-xray-test-plan-to-a-testsigma-test-plan)<br>
-[Steps to execute Xray linked tests in Testsigma](https://testsigma.com/docs/integrations/bug-reporting/xray/#steps-to-execute-xray-linked-tests-in-testsigma)<br>
+Xray is a test management tool that provides the structure to organize, plan, and report with accuracy on the progress of testing as well as the readiness to deploy. This article discusses Xray integration with Testsigma.
 
----
-
-
-## **Introduction**
-
-Xray for Jira is a Test Management tool that provides the structure to organize, plan, and report with accuracy on the progress of testing as well as the readiness to deploy.
-
-In this document, we will see how Testsigma integration  with Xray works.
+With Xray integration, you can link:
+- An Xray test case to a Testsigma test case.
+- An Xray test set to a Testsigma test suite.
+- An Xray test plan to a Testsigma test plan.
 
 ---
 
-## **Pre-requisites**
-
-For a full functioning JIRA and Xray integration, you will need:
-1. A working JIRA integration. To know how to set this up, check the document here: https://testsigma.com/docs/integrations/bug-reporting/jira/
-2. A working Xray Integration, for which you will need
-  i.  JIRA Account URL: The URL for your your JIRA account.
-  ii. Client ID
-  iii.Client Secret
-To know how to get your Xray Client ID and the Client Secret, check the document here: https://docs.getxray.app/display/XRAYCLOUD/Global+Settings%3A+API+Keys 
-
-
-[[info | NOTE:]]
-|The link between XRay and Testsigma entities like test cases, test suites and test plans will only be verified if the URLs for JIRA and X-ray are the same. 
+## **Prerequisites**
+- A working JIRA integration. For more information, refer to [jira bug reporting](https://testsigma.com/docs/integrations/bug-reporting/jira/).
+- A working Xray integration. 
+    - JIRA Account URL
+    - Client ID
+    - Client Secret 
+
+*For more information, refer to [global settings](https://docs.getxray.app/display/XRAYCLOUD/Global+Settings%3A+API+Keys).*
 
 ---
 
-## **Steps to integrate Xray with Testsigma**  
-
-1. Navigate to the Plugins page through Dashboard > Settings > Plugins and select Xray under the Bug Reporting Tab.
-2. Click on the Disabled Icon on Jira. Jira Details overlay opens up as shown below:
-
-![xray details](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/integrations/bug-reporting/xray/xray-details.png)
+## **Steps to Integrate Xray with Testsigma** 
+1. Navigate to **Settings > Integrations**.
+![Integrations](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ytintegrations.png)
 
-3. Enter the details as mentioned in Prerequisites -”JIRA Account URL”, “Client ID” and “Client Secret”. 
-4. If you want to add attachments[logs, screenshots and videos of execution] to the test executions then please check the checkbox “Add attachments to test execution”.
-5. Click on the “Create” button to finally enable the integration.
-
-The Testsigma and Xray integration works on below principles.
-
-1. An x-ray test case can be linked to a Testsigma test case.
-2. One x-ray test case can be linked to multiple Testsigma test cases. 
-3. An x-ray test set can be linked to a Testsigma test suite.
-4. An x-ray test plan can be linked to a Testsigma test plan.
-
-Lets go through all the 3 types of links one-by-one below.
+2. Enable toggle on **Xray** widget.
+![Xray Toggle](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/xraytoggle.png)
+
+3. On the **Xray Details** prompt, enter **Jira Account URL**, **Client Id** and **Client Secret**.
+![Xray Details](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/xraydetails.png)
+
+4. Click on **Save & Enable**.
+![Save & Enable](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/detailsxray.png)
+
+[[info | **NOTE**:]]
+| If you want to add attachments like logs, screenshots, and videos of execution for the test executions, please check the **Add Attachments to Test**.
+
+Here's a quick GIF demonstrating how to integrate Xray with Testsigma. 
+![Xray Integration](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/xrayint.gif)
 
 ---
-
-## **Steps to link an Xray test to a Testsigma test case**
 
-1. Get the ID of an already created test from Xray. For example, if my test URL on Xray is: https://testserver.atlassian.net/browse/TEST-75 then the ID would be: TEST-75
-2. In Testsigma, go to the test-case details page corresponding to the test case you want to link with. On the top right side of the page, you will see a text box with label “Xray TestID” as also shown in the screenshot below: 
-
-![xray test id](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/integrations/bug-reporting/xray/xray-test-id.png)
+## **Steps to Link an Xray Test Case to a Testsigma Test Case**
+1. Get the ID of an already created test from Xray. For example, if my test url on Xray is https://testserver.atlassian.net/browse/test75, then the ID would be: ***test75***
+
+2. Navigate to the test case details page corresponding to the test case you want to link with.
+![Test Case Details](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/xraytcsbox.png)
+
+3. Enter **Xray ID** and click on click on the link button. 
+![Xray Link](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/xrayidlink.png)
 
-3. To link this xray test to the Testsigma test case, click on the link button beside the id.
-
 ---
-
-## **Steps to link an Xray test set to a Testsigma test suite**
 
-1. Get the ID of an already created test set from Xray. For example, if my test set URL on Xray is: https://testserver.atlassian.net/browse/TEST-85  then the ID would be: TEST-75
-2. In Testsigma, go to the test-suite details page corresponding to the test suite you want to link with. On the top right side of the page, you will see a text box with label “Xray Test Set ID” as also shown in the screenshot below:
+## **Steps to Link an Xray Test Set to a Testsigma Test Suite**
+1. Get the ID of an already created test set from Xray. For example, if my test set url on Xray is https://testserver.atlassian.net/browse/ts85, then the ID would be: ***ts85***
 
-![xray test suite id](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/integrations/bug-reporting/xray/xray-testsuite-id.png)
+2. Navigate to the test suite details page corresponding to the test suite you want to link with.
+![Test Suites](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/testsuitenav.png)
 
-3. To link this xray test set to the Testsigma test suite, click on the link button beside the id.
+3. Enter **Xray ID** and click on click on the link button. 
+![Link](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tslink.png)
+
+[[info | **NOTE**:]]
+| For the test execution of all the test cases inside the test suite, the test cases should also be linked to appropriate test cases on Xray.
 
-[[info | NOTE:]]
-|For the test execution of all the test cases inside the test suite to be updated in Xray, the test cases should be linked to appropriate test cases on Xray too.
-
 ---
-
-## **Steps to link an Xray test plan to a Testsigma test plan**
-
-1. Get the ID of an already created test plan from Xray. For example, if my test plan URL on Xray is: https://testserver.atlassian.net/browse/TEST-95  then the ID would be: TEST-95
-2. In Testsigma, go to the test-plan details page corresponding to the test suite you want to link with. On the top right side of the page, you will see a text box with label “Xray Test Plan ID” as also shown in the screenshot below:
 
-![xray test plan id](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/integrations/bug-reporting/xray/xray-testplan-id.png)
+## **Steps to Link an Xray Test Plan to a Testsigma Test Plan**
+1. Get the ID of an already created test plan from Xray. For example, if my test plan URL on Xray is: https://testserver.atlassian.net/browse/tp95, then the ID would be: ***tp95***
 
-3. To link this xray test plan to the Testsigma test plan, click on the link button beside the id, also highlighted in above screenshot.
+2. Navigate to the test plan details page corresponding to the test plan you want to link with.
+![Test Plans](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tpnav.png)
+
+3. Enter **Xray ID** and click on click on the link button.
+![Test Plan Xray ID](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tplink.png)
+
+[[info | **NOTE**:]]
+| When you execute a Test Plan in Testsigma, the execution status will be updated for the linked test sets in Xray. 
 
-
 ---
-
-## **Steps to execute Xray linked tests in Testsigma**
-
-1. Go to a linked test plan and execute it. To know how to execute a test plan, check the document here: https://testsigma.com/docs/runs/test-plan-executions/
-2. When you initiate a Test Plan execution in Testsigma, the test execution status will be updated for the linked test sets in Xray.
+
+Here's a quick GIF demonstrating how to link Xray IDs with Test Cases, Test Suites & Test Plans with Testsigma.
+![Xray Links](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tcstsstpsxray.gif)
 
 ---
diff --git a/src/pages/docs/integrations/bug-reporting/youtrack.md b/src/pages/docs/integrations/bug-reporting/youtrack.md
@@ -87,4 +87,5 @@ Once the above details are obtained, navigate to the Plugins page through **Dash
 
 Here's a quick GIF demonstrating how to integrate Youtrack and add a bug to Youtrack from Testsigma. 
 ![YouTrtack](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/youtrackint.gif)
+
 ---
diff --git a/src/pages/docs/integrations/product-management/clickup.md b/src/pages/docs/integrations/product-management/clickup.md
@@ -4,16 +4,15 @@ metadecs: "How to integrate Testsigma with Clickup for real-time bug reporting d
 order: 16.55
 page_id: "Clickup"
 warning: false
-
 contextual_links:
 - type: section
   name: "Contents"
 - type: link
-  name: "Prerequisites:"
+  name: "Prerequisites"
   url: "#prerequisites"
 - type: link
-  name: "Integrating Clickup with Testsigma"
-  url: "#integrating-clickup-with-testsigma"
+  name: "Steps to Integrate Clickup with Testsigma"
+  url: "#steps-to-integrate-clickup-with-testsigma"
 - type: link
   name: "Creating a bug"
   url: "#creating-a-bug"
@@ -67,4 +66,4 @@ To integrate Clickup with Testsigma, you need the following:
 Here's a quick GIF demonstrating how to integrate Clickup and add a bug to Clickup from Testsigma. 
 ![Clickup Integration](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/clickupgif.gif)
 
----
+---
diff --git a/src/pages/docs/runs/env-config/configure-bypass-ssl.md b/src/pages/docs/runs/env-config/configure-bypass-ssl.md
@@ -1,26 +1,37 @@
 ---
-title: "How to bypass the missing SSL certificate error?"
+title: "Bypass the Missing SSL Certificate Error?"
 page_title: "Bypass the missing SSL certificate error"
 metadesc: "How to bypass the missing SSL certificate error while automating browser tests using Testsigma"
 noindex: false
 order: 9.83
 page_id: "How to bypass the missing SSL certificate error?"
 warning: false
+contextual_links:
+- type: section
+  name: "Contents"
+- type: link
+  name: "Prerequisites"
+  url: "#prerequisites"
+- type: link
+  name: "Applying Desired Capabilities"
+  url: "#applying-desired-capabilities"
+- type: link
+  name: "Bypassing Manually"
+  url: "#bypassing-manually"  
 ---
 
 ---
-During the active development of a website, the dev environment might not always have an SSL certificate. It is okay to ignore this error and bypass the issue temporarily during Test Execution since the Application is not used in Production and the Application data is not relevant.
 
-We assume that you are already familiar with the usage of Desired Capabilities in Testsigma. If not, see [Desired Capabilities - Overview](https://testsigma.com/docs/desired-capabilities/overview/)
-Bypassing an SSL certificate can be done in two ways in Testsigma:
+During the active development of a website, the dev environment might not always have an SSL certificate. It is okay to ignore this error and bypass the issue temporarily during test execution since the application is not used in production and the application data is not relevant.
 
-1. Applying Desired Capabilities
-
-2. Bypassing manually
-
-&emsp;
+---
+
+## **Prerequisites**
+- You should be familiar with the usage of Desired Capabilities in Testsigma. For more information, refer to [desired capabilities](https://testsigma.com/docs/desired-capabilities/overview/).
 
-### 1. Applying Desired Capabilities
+---
+
+## **Applying Desired Capabilities**
 In this case, we can use Desired Capabilities to bypass certificate errors. Here are the few desired capabilities for the specific browsers to overcome certificate errors:
 
 |Browser|Capability Name(Key)|Format|Value|
@@ -30,24 +41,17 @@ In this case, we can use Desired Capabilities to bypass certificate errors. Here
 |**IE and Safari**|**capabilityType.ACCEPT_SSL_CERTS**|**Boolean**|**True**|
 
 The image below shows how to add desired capabilities for the Chrome browser in a Test Plan Run in Testsigma.
+![Bypass SSL Capability](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/dcbypass.png)
 
-![Test Plan Desired Bypass SSL Capability](https://docs.testsigma.com/images/configure-bypass-ssl/create-test-plan-bypass-ssl-desired-caps.png)
-
-&emsp;
-
-### 2. Bypassing Manually
-We can also bypass the certificate error by doing the below steps:
-
-1. Navigate to the SSL Issue Website.
-
-![Google Chrome Connection not private Error](https://docs.testsigma.com/images/configure-bypass-ssl/google-chrome-connection-notprivate-error-page.png)
+---
 
-2. On the error page, click on the **Advanced** button
+## **Bypassing Manually**
+1. Navigate to the SSL issue website and click on **Advanced**. 
+![Not Private Error](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ssl1.png)
 
 3. Click on **Proceed to < website-url > (unsafe)** link
+![Not Private Error Advanced](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ssl2.png)
 
-![Google Chrome Connection not private Error Advanced](https://docs.testsigma.com/images/configure-bypass-ssl/google-chrome-connection-notprivate-error-advanced-page.png)
-
-By clicking on “Proceed to self-signed.badssl.com (unsafe)” you will be directed to the original website.
+You will be directed to the original website.
 
-If the first method(desired capabilities) don’t work, we can automate the above steps using Testsigma to bypass the SSL Error page.
+---
diff --git a/src/pages/docs/test-cases/manage/import-export.md b/src/pages/docs/test-cases/manage/import-export.md
@@ -107,4 +107,4 @@ Here’s a quick GIF demonstrating how to import test cases.
 |- If you are trying to update the Test Cases using Import/Export, make sure to keep the ID and UUID column intact so that the correct Test Case gets updated while importing back. You may change the other fields as required.
 |- If you are trying to create new Test Cases in bulk, make sure to clear both the ID and UUID columns.
 
----
+---
diff --git a/src/pages/docs/test-data/types/phone-number.md b/src/pages/docs/test-data/types/phone-number.md
@@ -56,4 +56,6 @@ We will use the test data generators available in Testsigma to fetch the OTP fro
 6. Select the **PhoneNumberFunctions** in ***Function Type** dropdown menu, enter the details, and click on **Save**. 
 ![PhoneNumberFubctions](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/phdatagensave.png)
 
-We have successfully created a test case for 2FA authentication. 
+We have successfully created a test case for 2FA authentication. 
+
+---
diff --git a/src/pages/docs/test-step-recorder/install-chrome-extension.md b/src/pages/docs/test-step-recorder/install-chrome-extension.md
@@ -35,4 +35,4 @@ Here’s a quick GIF demonstrating how to add Testsigma's Chrome extension.
 
 *For more information on creating test steps using recorder, refer to [recording test steps](https://testsigma.com/docs/test-cases/create-steps-recorder/web-apps/overview/).*
 
----
+---
Original file line number	Diff line number	Diff line change
Expand Up		@@ -87,4 +87,5 @@ Once the above details are obtained, navigate to the Plugins page through **Dash

		Here's a quick GIF demonstrating how to integrate Youtrack and add a bug to Youtrack from Testsigma.
		![YouTrtack](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/youtrackint.gif)

		---
-Original file line number
+Diff line change
@@ Expand Up @@
     |- If you are trying to update the Test Cases using Import/Export, make sure to keep the ID and UUID column intact so that the correct Test Case gets updated while importing back. You may change the other fields as required.
     |- If you are trying to create new Test Cases in bulk, make sure to clear both the ID and UUID columns.
-    ---
+    ---
Original file line number	Diff line number	Diff line change
Expand Up		@@ -35,4 +35,4 @@ Here’s a quick GIF demonstrating how to add Testsigma's Chrome extension.

		For more information on creating test steps using recorder, refer to [recording test steps](https://testsigma.com/docs/test-cases/create-steps-recorder/web-apps/overview/).

		---
		---