Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the docs as per new UI #292

Merged
merged 1 commit into from
Sep 29, 2023
Merged

Updated the docs as per new UI #292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions src/pages/docs/addons/what-is-an-addon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Using add-ons to extend the Testsigma Actions"
title: "Using Add-ons to Extend the Testsigma Actions"
page_title: "Using Add-ons to extend Testsigma Functionality"
metadesc: "This article discusses what are add-ons, why are they useful, and how to use them to extend functionality for unique cases in Testsigma"
order: 17.1
Expand All @@ -23,7 +23,7 @@ contextual_links:
---
## **What is an add-on?**

An add-on is a way to extend Testsigma’s built-in repository of actions with custom actions. These actions can be anything from **click first, then scroll, click again, scroll indefinitely till the bottom of the page,** and so on.
An add-on is a way to extend Testsigma’s built-in repository of actions with custom actions. These actions can be anything from **click first**, **then scroll**, **click again, scroll indefinitely till the bottom of the page**, and so on.

---
## **Why do you need add-ons?**
Expand All @@ -34,14 +34,18 @@ Testsigma automates a diverse set of actions via its simple English based action

For example, the **scroll indefinitely till the bottom of the page** action is applicable to an application that has a huge list of items where the list keeps adding individual items to a list until the user scrolls to the end. Think Pinterest, or an e-commerce website listing clothes.

If your test case involves scrolling to the bottom of the page to verify the copyright, you can create an add-on to automate it at scale using Testsigma.
If your test case involves scrolling to the bottom of the page to verify the copyright, you can create an add-on to automate it at scale using Testsigma.

---
## **How do you use add-ons?**

There are many actions that cannot be predicted until the scenario needs to be automated by someone. This is where add-ons come into play. **An add-on is a non-standard automation action that can be reused in recorded or manually-written automated tests.**

You can use the pre-existing add-ons and share your own with the rest of the test automation community through the [Add-ons Community Marketplace](https://testsigma.com/docs/addons/community-marketplace/). You can also keep a private repository of add-ons that is only accessible to you. This is handy if your add-on has proprietary code for your specific applications.
## **How do you use add-ons?**
You can use the pre-existing add-ons available in **Community**.
![Addons](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/addonsPagecas.png)

If you are creating your own add-on, you can share it with the rest of the test automation community through the Add-ons Community Marketplace. You can also keep a private repository of add-ons that is only accessible to you. This is handy if your add-on has proprietary code for your specific applications.

Here's a quick GIF demonstrating how to install an addon in Testsigma.
![Network Throttling Addon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/ntaddonGIF.gif)

![Add-ons Marketplace in Testsigma](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/addon.gif)
---
66 changes: 36 additions & 30 deletions src/pages/docs/integrations/product-management/linear.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,52 +20,58 @@ contextual_links:
---
---

With Testsigma and Linear integration, you can push bugs directly from Testsigma to your Linear project, capture screenshots, annotate bugs, and share them with your teammates and colleagues.
In this document, we will discuss how to establish Integration with Linear from your Testsigma account and how to create the first bug from Testsigma which can flow into Linear.
You can integrate Testsigma with Linear to push bugs directly to Linear’s project. You can also capture screenshots, annotate bugs, and share them with your team. In this document, we will discuss how to integrate Linear with Testsigma and also how to create the first bug from Testsigma which can flow into Linear.

---

##**Prerequisites**

To integrate Linear with Testsigma, you need the following information from your Linear Account (Check how to get the API key here: https://linear.app/docs/api-and-webhooks)

- API Key

You should also be familiar with [Test Plan Runs](https://testsigma.com/docs/runs/test-plan-executions/).
## **Prerequisites**
To integrate Youtrack with Testsigma, you need the following:
- Linear API Key (For more information, refer to https://linear.app/docs/api-and-webhooks)
- You should also be familiar with [Test Plan Runs](https://testsigma.com/docs/runs/test-plan-executions/).

---

##**Integrating Linear with Testsigma**
## **Steps to Integrate Testsigma with Linear**
1. Navigate to **Settings > Integrations**.
![Integrations](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lrintset.png)

1. Once the above details are obtained, navigate to the Plugins page through Dashboard > Settings > Plugins and select Linear under the Bug Reporting Tab.
2. Click on the Disabled Icon on Linear. Linear Details overlay opens up.
3. Enter the details as mentioned in Prerequisites. After entering the details, click on the Create button to add the Integration.

---
2. Enable toggle on **Linear** widget.
![Linear](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lrtoggle.png)

##**Creating a bug**
3. On the **Linear Details** prompt, enter **API Key**.
![API Key](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lrapikey.png)

We can create a bug within Testsigma from the run results page for a particular Test Plan with the following steps:
4. Click on **Save & Enable**.
![Save](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lrsae.png)

1. Navigate to the run results test case level page where you want to add a bug.
2. Click on the Report Bug button(bug icon on the top right corner) to open the Bug Reporting overlay.
Here’s a quick GIF demonstrating how to integrate Testsigma with Linear.
![Integrate Linear](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/linearenable.gif)

![report bug on a test case execution result page](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/integrations/product-management/linear/run-test-case-report-bug-linear.png)

3. Choose Linear and enter the detailed information of your bug.

![report a bug on linear tool](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/integrations/product-management/linear/choose-linear-enter-bug-details.png)

[[info | NOTE:]]
|Only the bug reporting tools that have been enabled via the plugins page (add link) will be displayed here.
---

## **Creating a Bug**
1. Navigate to **Run Results > Test Case Result**, where you want to add a bug.
![Test Case details](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lrtcdetails.png)

If you want to link to an existing issue on Linear, click on the Link to Issue button, search for an existing issue in the search field and click on Link Issue to add a link to an existing Issue on Linear. Otherwise, enter the bug details in the form as required.
2. Click on **Report Bug**.
![Report Bug](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lrrbug.png)

4. Click on Create to create the Bug.
3. On **Report** overlay, click on **Linear** icon.
![Report Bug Overlay](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lricon.png)

When the bug is created, some additional details regarding the Test Result such as the Test Execution Video and Step Screenshots are added to the Issue on Linear automatically by Testsigma. This helps the developer who checks the issue in Linear to understand the issue/bug better with more context.
4. On the **Create New Issue** prompt,
- Select the **Team & Project**.
![Team & Project](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lrtpro.png)
- Enter **Title & Description**.
![Title & Descroption](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lrtad.png)

5. Click on **Create Ticket**.
![Create Ticket](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/lecticket.png)

[[info | **NOTE**:]]
| If you want to link to an existing issue on Linear, click on the Link to Issue, search for an existing issue in the search field and click on Link Issue to add a link to an existing Issue.

Here’s a GIF demonstrating how to report bugs from Testsigma.
![Linear Bug](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/linearbug.gif)

---
95 changes: 47 additions & 48 deletions src/pages/docs/projects/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,90 +26,89 @@ contextual_links:

---

Testsigma offers the ability to create multiple projects and applications, allowing for logical separation between them. Each Testsigma Project comprises different types of Applications, similar to a real-life Project. For example, a Testsigma Project would be an e-commerce product with various application channels such as a Web app, Mobile web app, Android, iOS, or a public REST API.
Testsigma offers the ability to create multiple projects and applications, allowing for logical separation between them. Each Testsigma Project comprises different types of applications, similar to a real-life Project.

Testsigma provides four sample projects with various test cases for Web, Mobile web, Android, and iOS application types within the Testsigma account. These sample projects can be used and modified to initiate test automation quickly.

This document will walk you through **creating**, **editing**, **switching**, and **deleting projects** in Testsigma.
This document will walk you through **creating**, **editing**, **switching**, and **deleting** projects in Testsigma.

---

## **Creating a Project**
1. Navigate to **Create New** and click on **Project** from the dropdown menu.
![Projects](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/prnavcl.png)

To create a new project in Testsigma, follow these steps:
2. Enter the **Project Name** and **Description** (Optional).
![Project Name & Description](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/prnad.png)

1. To create a new Project:
[[info | **NOTE**:]]
| Custom fields you create for your projects under **Settings > Custom Fields > Projects** will appear here.

a. Click **Create New** in the top-right corner of the screen, and then select **Project** from the drop-down menu. ![Highlighted are the methods to create Projects](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/createnew_dashboard_ts.png)
3. If your project involves multiple applications, check **Allow adding multiple applications in this project** checbox. To add an application, click **Add Application**, select the **Application Type** from the drop-down menu, and give it a **Name**. By default, the project is set up for a single application.
![New project](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/prnpamv.png)

b. Alternatively, click **Project Switcher** in the top-left corner of the screen to open the Project Switcher overlay, and then click **Create New**. ![Project switcher on Dashboard](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/createnew_switcher_ts.png)
4. Also, if you want multiple versions for each application, check **Allow multiple versions for applications** checbox.
![Multiple Versions](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/pramversions.png)

2. Enter the **Project Name** and **Description (Optional)**. ![Create Project Form](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/projectname_ts.png)
5. Click on **Create**.
![Create](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/prcreate.png)

[[info | NOTE:]]
| Custom fields you create for your projects under **Settings** > **Custom Fields** > **Projects** will appear here.


3. If your project involves **multiple applications**, you should enable the **toggle** feature. To add an application, click **Add New Application**, select the **application type** from the drop-down menu, and give it a **name**. You can **delete** it later. By default, the project is set up for a **single application**; you can select the **project type** from the drop-down menu. ![Select Multiple Applications option on Creating Project](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/enabletoggle_multipleapp.png)

4. Also, if you want multiple versions for each application, you should enable the **toggle** feature and add the Application Version. ![Application Version](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/enabletoggle_appversion.png)

[[info | NOTE:]]
| You can also add these settings later by editing the Project as well.

5. Click **Create** in the top-right corner of the screen. ![Create a Project](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/create_project_ts.png)

6. Your Project is created, and you will be taken to the Test Cases page directly. You can start automating your Test Cases from here. ![Test Cases page after creating project](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/newproject_tc_ts.png)

[[info | NOTE:]]
| Refer to [Assign Projects](https://testsigma.com/docs/collaboration/assign-projects/) if you want to assign users and manage project roles before proceeding.

Here is a quick GIF demonstrating the above workflow: ![Creating a Project](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/creatingaproject.gif)
Here is a quick GIF demonstrating how to create a Project.
![Create Project](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/createproject.gif)

---

## **Editing a Project**
1. Navigate to **Project > Project Settings**.
![Project Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/prnavprtprs.png)

To edit an existing project in Testsigma, follow these steps:
2. This will open the **Edit Project** prompt.
![Edit Project](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/preditprompt.png)

1. Select the **Project** you want to edit from the Project Switcher, then navigate to the **Project Settings** page. ![Project Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/projectedit_ts.png)
3. You can update **Project Details**, **Multiple Applications** and **Versions** from here. Also, you can add **Project Members**, **Test Case Types**, and **Requirement Types** on the same prompt.
![Update Details](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/prdetailsall.png)

2. Click **Edit** on the top-right corner of the screen to open the **Edit Project** page; you can enable/disable the **toggle** to **Multiple Applications** or **Versions** from here. Click **Update** to save changes. ![Edit Project page from Project Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/editproject_update_ts.png)
4. Click on **Update** to save the changes.
![Update](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/pruclick.png)

3. **Adding**, **editing**, and **deleting** **Applications** & **Versions** can be done under **Project Settings** > **Applications**. ![Editing Application and Versions](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/editapplication_ts.png)
**Adding**, **Editing**, and **Deleting** Applications & Versions can be done under **Project Settings > Applications**.

Here is a quick GIF demonstrating the above workflow: ![Editing a Project](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/editingaproject.gif)
Here is a quick GIF demonstrating how to edit a Project.
![Edit Project](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/editproject.gif)

---

## **Switching Projects**
1. Click on the current **Project** from **Dashboard**.
![Project](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/prswitch.png)

To switch between different projects in Testsigma, follow these steps:
2. Select **Project**, **Application**, and **Version** from respective dropdowns and click on **Go to project**.
![Switch Dropdowns](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/prspgtp.png)

1. Click the drop-down arrow next to the current project name in the top-left corner
2. Click on the drop-down menu to select the **Project** (**Application**, **Version**, if enabled) you wish to switch to from the list of projects you can access. Then, click **Go** to switch projects.
3. Once you select a project, Testsigma will take you to the dashboard of the selected project.
3. You’ll be redirected to the dashboard of the selected project.

Here is a quick GIF demonstrating the above workflow: ![Switching Projects](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/switchingproject.gif)
Here is a quick GIF demonstrating how to switch projects.
![Switch Projects](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/switchpr.gif)

---

## **Deleting a Project**
1. Navigate to **Project > Project Settings**.
![Project Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/prnavprtprs.png)

To delete a project in Testsigma, follow these steps:
2. Click on **Delete**.
![Delete](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/prdelete.png)

1. Select the **Project** you want to delete from the Project Switcher, then navigate to the **Project Settings** page.
2. Click **Delete** on the top-right corner of the screen to delete the project.
3. On the **Delete project** prompt, enter **DELETE** and click on **Delete**.
![DELETE](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/prdelefin.png)

**Deleting a Project will lead to losing all data within the project.**

- All **Applications** & **Application Versions** within this Project.
[[info | **NOTE**:]]
| Deleting a Project will delete:
| - All Applications & Application Versions within this Project.
| - All Test cases, Elements, Test data profiles, Custom functions, Uploads, Requirements, Test suites, Test plans, Run results and Environments associated with this project.

- All **Test cases**, **Elements**, **Test data profiles**, **Custom functions**, **Uploads**, **Requirements**, **Test suites**, **Test plans**, **Run results** and **Environments** associated with this project.

**Please ensure you are okay with losing all the above data before proceeding with the Project deletion.**

3. If you still want to delete the Project, Confirm the deletion by entering **DELETE** and then clicking **I understand, delete this project**. ![Delete Project](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/deleteproject_ts.png)

---
Here is a quick GIF demonstrating how to delete a project.
![Delete](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/deletepr.gif)

---
Loading