Merge pull request #957 from testsigmahq/dev

Updated existing docs

Author: bharathk08

.github/workflows/staging-cd.yml

@@ -3,6 +3,10 @@ on:
   push:
     branches:
       - 'dev'
+permissions:
+  id-token: write
+  contents: read
+
 jobs:
   StagingDeploy:
     runs-on: ubuntu-latest
@@ -26,6 +30,8 @@ jobs:
         run: |
           rm -rf .env
           touch .env
+          echo AWS_ROLE_ARN=${{ secrets.WEBSITE_AWS_GITHUB_OIDC_ROLE_ARN }} >> .env
+          echo AWS_DEFAULT_REGION=us-east-1 >> .env
           echo BUCKET_NAME=${{ secrets.WEBSITE_STAGING_BUCKET_NAME }} >> .env
           echo HOST_NAME=${{ secrets.WEBSITE_STAGING_HOST_NAME }} >> .env
           echo ASSET_HOST=${{ secrets.WEBSITE_STAGING_ASSET_HOST }} >> .env
@@ -40,6 +46,15 @@ jobs:
           echo TYPESENSE_API_KEY=${{ secrets.WEBSITE_STAGING_TYPESENSE_API_KEY }} >> .env
           echo TYPESENSE_SEARCH_API_KEY=${{ secrets.WEBSITE_STAGING_TYPESENSE_SEARCH_API_KEY }} >> .env
           cat .env
+          
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-to-assume: ${{ secrets.WEBSITE_AWS_GITHUB_OIDC_ROLE_ARN }}
+          role-session-name: GitHub_to_AWS_via_FederatedOIDC
+          aws-region: 'us-east-1'
+          audience: sts.amazonaws.com
+          
       - name: Set environment
         run: |
           sed -i 's/localhost/website.testsigma.com/g' src/environment.ts
@@ -48,10 +63,6 @@ jobs:
         run: |
           PREFIX_PATHS=true npm run build && npm run deploy
         env:
-          AWS_ACCESS_KEY_ID: ${{ secrets.WEBSITE_STAGING_AWS_ACCESS_KEY_ID }}
-          AWS_SECRET_ACCESS_KEY: ${{ secrets.WEBSITE_STAGING_AWS_SECRET_ACCESS_KEY }}
-          AWS_DEFAULT_REGION: 'us-east-1'
-          AWS_DEFAULT_OUTPUT: json
           TYPESENSE_HOST: ${{ secrets.WEBSITE_STAGING_TYPESENSE_HOST }}
           TYPESENSE_PORT: ${{ secrets.WEBSITE_STAGING_TYPESENSE_PORT }}
           TYPESENSE_PROTOCOL: ${{ secrets.WEBSITE_STAGING_TYPESENSE_PROTOCOL }}

src/pages/docs/FAQs/web-apps/viewing-full-testplan-execution-video.md

@@ -37,16 +37,21 @@ When you enable the **Reset session for every test case** option in **Parallel S
 ## **Disabling the Reset Session in Parallel Settings**
 
 1. On the **Create** or **Edit Test Plan** page, go to the **Add Test Suites & Link Machine Profiles** tab.
+![Create or Edit](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/faq/update_single_video_1.png)
 
 2. If the test machine is already linked, click the **Settings** icon under the **Test Machine** tab. Click the **Link to Test Machine** icon to add a new machine profile. 
+![Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/faq/update_single_video_2.png)
 
 3. In the **Edit Test Machine or Device Profile** overlay, locate the checkbox labelled **Reset session for every test case**.
+![Reset](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/faq/update_single_video_3.png)
 
-4. Uncheck this box to disable the reset session for all test cases. 
+4. Unselect this checkbox to disable the reset session for all test cases. 
+![Unselect](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/faq/update_single_video_4.png)
 
-5. Click **Create** or **Update Profile** to save your changes. ![disable reset session for test machine](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/disabling_reset_session_for_machine.gif)
+5. Click **Create** or **Update Profile** to save your changes. 
+![disable reset session for test machine](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/faq/update_single_video_5.png)
 
 6. You can now watch the complete video for each test suite under **Run Results > Test Suite > Watch Video**.
-   ![Watch Video](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/WatchVideo_TestSuiteLevel.png)
+![Watch Video](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/faq/update_single_video_6.png)
 
 ---

src/pages/docs/addons/create-a-post-plan-hook-add-on.md

@@ -61,7 +61,7 @@ zip -r addonName.zip . -x ".
 
 Navigate to the add-ons page, select the dropdown for your add-on, and click **Upload Code** option to upload the zipped file.
 
-![Upload code](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/add_on_edit.png)
+![Upload code](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/addons/update_post_plan_hook_1.png)
 
 Other available options:<br>
     - **Manage Tags**: Add more tags and labels for categorising them. We can customise the action code.<br>
@@ -72,13 +72,13 @@ Other available options:<br>
 
 Once the code is uploaded, the add-on options dropdown will show an additional option, Publish
 
-![Publish addon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/publish_addon.png)
+![Publish addon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/addons/update_post_plan_hook_2.png)
 
 If you select to publish your add-on, select one of the following on the Publish Add-on window:
     - **Public**: Choose this option if you want to make the add-on available to the testsigma community.
     - **Private**: Choose this option if you want to make the add-on available only to users in your organization.
 
-![publish addon in private or public](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/publsh_add_on_pp.png)
+![publish addon in private or public](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/addons/update_post_plan_hook_3.png)
 
 Once requested for publishing, an automatic security check is done internally. Upon the successful completion of the security check, the add-on is published. In case of a security check failure, an email notification would be sent to the user.
 
@@ -89,6 +89,6 @@ Once requested for publishing, an automatic security check is done internally. U
 
 To try out the add-on you just created, create a new or open an existing test plan and add a test suite and test machine. Navigate to the **Test Plan Settings** tab and click the right arrow before **Hooks** to unhide the feature. Select the add-on and enter the inputs in the custom field.
 
-![Hook enable in testplan](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/hookinput_testplan.png)
+![Hook enable in testplan](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/addons/update_post_plan_hook_4.png)
 
 ---

src/pages/docs/addons/install-community-addon.md

@@ -29,7 +29,8 @@ Community Addon in Testsigma extend the functionality of your test cases by allo
 1. Click on the **Addons** icon from the left navigation bar.
 2. On the **Addon Marketplace** Page, you will find a list of all available addons in the **Community** tab. You can either browse through the list or use the search function to find a specific addon by name or description.
 3. Click **Install** button you wish to install addon.
-4. The addon will be installed and available for use in your test cases after refreshing the page. ![installing community addon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/install_addon_marketplace.png)
+4. The addon will be installed and available for use in your test cases after refreshing the page. 
+![installing community addon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/addons/update_comaddon_1.png)
 
 ---
 
@@ -38,9 +39,11 @@ Community Addon in Testsigma extend the functionality of your test cases by allo
 Once you've installed an addon, you can use it in your test cases:
 
 1. Go to the **Addon** page from the Dashboard and switch to the **Installed Addon** tab.
-2. Click on the installed addon to view its details. A popup will display the addon's available actions. ![view details for installed addon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/view_installed_community_addon.png)
+2. Click on the installed addon to view its details. A popup will display the addon's available actions.
+![view details for installed addon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/addons/update_comaddon_2.png)
 3. When authoring a test case, start typing the action related to the installed addon in the test step.
-4. The action will appear in the suggestions list, and you can select it to include in your test step. ![use installed addon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/using_installed_addon.png)
+4. The action will appear in the suggestions list, and you can select it to include in your test step. 
+![use installed addon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/addons/update_comaddon_3.png)
 
 [[info | NOTE:]]
 | - **Refresh the Page**: After installing an addon, always refresh the page to ensure the actions become available in your test cases.

src/pages/docs/api/environments.md

@@ -47,7 +47,7 @@ This endpoint retrieves details for a specific Environment.
 |**Response Body (Sample)**| <pre>{<br>    "id": 10,<br>    "name": "Test environment1",<br>    "description": "Test Environment",<br>    "createdById": 2,<br>    "updatedById": 2,<br>    "createdDate": 1732176819137,<br>    "updatedDate": 1732176819137,<br>    "createdAtEpoch": 1732176819137,<br>    "updatedAtEpoch": 1732176819137,<br>    "variables": [<br>        {<br>            "id": 8,<br>            "key": "Url",<br>            "value": "https://google.com",<br>            "isEncrypted": false,<br>            "projectId": 9,<br>            "isDefault": null,<br>            "createdDate": 1732176819179,<br>            "updatedDate": 1732176819179,<br>            "createdAtEpoch": 1732176819179,<br>            "updatedAtEpoch": 1732176819179<br>        }<br>    ]<br>} </pre> |
 
 The **<ENV\_ID>** can be found in the URL of the Environment details page. Refer to the screenshot below:
-![Env ID](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Env_ID.png)
+![Env ID](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/rest_api/update_manage_environments_1.png)
 
 [[info | **NOTE**:]]
 | To retrieve all environments, use this endpoint with the same method. <br>

src/pages/docs/atto/generative-ai/integrations/xray.md

@@ -34,21 +34,18 @@ Testsigma integrates with Xray to support test case generation from your existin
 ## **Integrating Xray with Testsigma** 
 
 1. Navigate to **Settings > Integrations**.
-   ![Integrations](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/xaryintn.png)
+![Integrations](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/atto/update_rayx_1.png)
 
 2. Enable toggle on **Xray** widget.
-   ![Xray Toggle](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/xraytgl.png)
+![Xray Toggle](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/atto/update_rayx_2.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/xraydtls.png)
+![Xray Details](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/atto/update_rayx_3.png)
 
 4. Click on **Save & Enable**.
-   ![Save & Enable](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/xraadtls.png)
+![Save & Enable](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/atto/update_rayx_4.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)
-
 ---

src/pages/docs/continuous-integration/aws-labmda.md

@@ -58,7 +58,7 @@ With AWS Lambda, you can run code for virtually any application or backend servi
 
 
 The URL details for the test plan can be taken from **REST API call to start Test Plan** section in Testsigma.
-![Get Test Plan ID](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/trineid.png)
+![Get Test Plan ID](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/continuous_integration/update_awslambda_1.png)
 
 
 6. Click on **TEST** at the top right corner to trigger the Test Plan.

src/pages/docs/continuous-integration/get-test-plan-details.md

@@ -33,15 +33,15 @@ This article discusses getting the test plan ID from a pre-existing test plan in
 
 
 1. Navigate to **Test Plans** and click on the test plan you want to get the ID for.
-![Test Plans](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tpdlsnavtps.png)
+![Test Plans](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/continuous_integration/update_test_plan_id_1.png)
 
 
 2. On the **Test Plan details** page that opens, click on the **CI/CD Integrations** tab. 
-![CI/CD Integration](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tpdtls.png)
+![CI/CD Integration](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/continuous_integration/update_test_plan_id_2.png)
 
 
 3. You will find the execution ID for the Test Plan within the **REST API call to start Test Plan** section.
-![Get Test Plan ID](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/trineid.png)
+![Get Test Plan ID](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/continuous_integration/update_test_plan_id_3.png)
 
 
 You can use this test plan ID wherever you need to call the execution of the test plan via Rest API.

src/pages/docs/continuous-integration/rest-api.md

@@ -129,14 +129,14 @@ To execute a test plan with different Environments, you need to have an Environm
 
 2. On the Environment page, the <ENVIRONMENT\_ID> in the URL `https://app.testsigma.com/ui/td/88/environments/<ENVIRONMENT_ID>/details` is the ID of the environment. 
 
-![Environments](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ttpuapienv.png)
+![Environments](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/continuous_integration/update_integ_restapi_1.png)
 
 - For Example, if the URL is `https://app.testsigma.com/ui/td/88/environments/10/details`, the **ID** is **10**. 
 
 ### **Executing Tests Plans with Different Environments**
 
 1. Navigate to **Test Plans > Test Plan > CI/CD Integrations**, and copy **CURL request** under **REST API to integrate with other tools > REST API call to start Test Plan**.
-![CURL](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ttpuapicurl.png)
+![CURL](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/continuous_integration/update_integ_restapi_2.png)
 
 2. Provide the Environment ID in the request body. 
 

src/pages/docs/desired-capabilities/biometric-authentication.md

@@ -51,34 +51,23 @@ In order to Add Biometric Authentication for Android and iOS apps, we can use th
 ## **Using Biometric Authentication Desired Capability**
 
 1. Click on **Run** from the **Test Case Details** page. 
-![Run Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/barnow.png)
+![Run Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/desired_capabilities/update_biometric_1.png)
 
 
 2. On the **Ad-Hoc Run** overlay, click on **Desired Capabilities**.
-![Ad Hoc Run](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/baahrp.png)
+![Ad Hoc Run](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/desired_capabilities/update_biometric_2.png)
 
 
 3. Enter ***testsigma.allowTouchIdEnroll*** in the **Key** field, select ***Boolean*** as the **Data type**, and set the **Value** as ***True***.
-![Capability Details](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/biadcdetails.png)
+![Capability Details](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/desired_capabilities/update_biometric_3.png)
 
 
 4. Click on **Run Now** to execute the test case. 
-![Run Now](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/barunnw.png)
+![Run Now](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/desired_capabilities/update_biometric_4.png)
 
 
 [[info | **NOTE**:]]
 | This capability is available only in Testsigma Lab and is not supported in local execution.
 
 
-
-Here’s a quick GIF demonstrating how to set the biometric authentication capability.
-
-![Biometric Authentication](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/BiometricAuth-min.gif)
-
-
-
-
----
-
-
-
+---