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.

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 Documentation for Doc Improvement #485

Merged
merged 5 commits into from
Aug 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ jobs:
- name: Install libvips
run: sudo apt-get install libvips
- uses: actions/checkout@v2
- name: Setup Node 16
- name: Setup Node 18
uses: actions/setup-node@v2
with:
node-version: '16'
node-version: '18'
- name: Install dependencies
run: |
npm i --force --unsafe-perm
rm -rf node_modules && npm i --force --unsafe-perm
- name: Force installing sharp
run: npm install --ignore-scripts=false --verbose [email protected] --unsafe-perm --force
- name: 'Create env file'
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ jobs:
- name: Install libvips
run: sudo apt-get install libvips
- uses: actions/checkout@v2
- name: Setup Node 12
- name: Setup Node 18
uses: actions/setup-node@v2
with:
node-version: '12'
node-version: '18'
- name: Install dependencies
run: |
npm i --force --unsafe-perm
rm -rf node_modules && npm i --force --unsafe-perm
- name: Force installing sharp
run: npm install --ignore-scripts=false --verbose [email protected]
run: npm install --ignore-scripts=false --verbose [email protected] --force --unsafe-perm
- name: 'Create env file'
run: |
touch .env
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
---
title: "Connect MongoDB & PostgreSQL Databases"
metadesc: "Install an addon to connect MongoDB and PostgreSQL databases in Testsigma. Learn how to set up a database connection to MongoDB in Testsigma Application"
page_title: "Connecting MongoDB and PostgreSQL Databases Easily"
metadesc: "Install an addon to connect MongoDB and PostgreSQL databases to Testsigma. Learn how to set up a database connection to MongoDB in Testsigma Application."
noindex: false
order: 17.9
page_id: "Connect MongoDB & PostgreSQL Databases"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Connect MongoDB via addon"
url: "#connect-mongodb-via-addon"
Expand All @@ -19,17 +23,23 @@ contextual_links:

---

You must install an addon to connect MongoDB and PostgreSQL databases in Testsigma. The addon comes with predefined NLPs, which you can use to connect the databases in your test steps.
Connecting MongoDB and PostgreSQL databases to Testsigma enhances your testing capabilities by allowing seamless interaction with these databases directly within your test cases. This integration enables you to execute queries, retrieve data, and validate results efficiently, thereby improving test accuracy and coverage while reducing manual effort in managing database interactions.

---

## **Prerequisites**

Before you proceed, ensure you know how to [install](https://testsigma.com/docs/addons/install-community-addon/) the community addon.

---

## **Connect MongoDB via addon**

To set up a database connection to MongoDB in Testsigma, follow these steps:

1. Click **Addons** from the left sidebar menu.
2. Search for the **MongoDB_NLPs** addon from the **New & Updated Addons** and click **Install**. ![Install MongoDB Addon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/mongodb_addon_install.png)
3. Once you install the **MongoDB_NLPs** addon, you can find the predefined NLPs in **Test Steps**. ![Use MongoDB in Test Steps](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/mongodb_teststep.png)
1. Click **Addons** from the left navigation bar.
2. Search for the **MongoDB_NLPs** addon from the **New & Updated Addons** and click **Install**. ![install mongodb addon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/settup_mongo_db.png)
3. Once you install the **MongoDB_NLPs** addon, you can find the predefined NLPs in **Test Steps**. ![use mongodb nlp](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/use_mongodb_nlp.png)
4. The parameters available with NLPs and how to use them in Test Steps are shown below.

|Parameter|Description|Example Value|
Expand All @@ -39,19 +49,15 @@ To set up a database connection to MongoDB in Testsigma, follow these steps:
|MongoDB_Connection|MongoDB connection connects to a MongoDB server or cluster|MongoClient, Mongoose|
|MongoDB_ConnectionURL|A URL-like string used to specify the address of a MongoDB server or cluster, as well as options for the connection|mongodb://localhost:27017/blog|

Here is a quick GIF demonstrating the above workflow:

![Connect MongoDB](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/mongodb.gif)

---

## **Connect PostgreSQL via addon**

To set up a database connection to PostgreSQL in Testsigma, follow these steps:

1. Click **Addons** from the left sidebar menu.
2. Search for the **PostgreSQL_Queries** addon from the **New & Updated Addons** and click **Install**. ![Install PostgreSQL Addon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/postgresql_addon_install.png)
3. Once you install the **PostgreSQL_Queries** addon, you can find the predefined NLPs in **Test Steps**. ![Use POstgreSQL in Test Steps](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/postgresql_teststep.png)
1. Click **Addons** from the left navigation bar.
2. Search for the **PostgreSQL_Queries** addon from the **New & Updated Addons** and click **Install**. ![install postgresql addon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/install_postgresql_addon.png)
3. Once you install the **PostgreSQL_Queries** addon, you can find the predefined NLPs in **Test Steps**. ![use postgresql in test steps](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/use_postgresql_nlp.png)
4. The parameters available with NLPs and how to use them in Test Steps are shown below.

|Parameter|Description|Example Value|
Expand All @@ -63,8 +69,5 @@ To set up a database connection to PostgreSQL in Testsigma, follow these steps:
|Select-Query|Executes a SELECT query and returns the result set|SELECT column\_name FROM table\_name WHERE condition;|
|Expected-Value|Compares a result with an expected value|assert result == expected\_value, f"Expected {expected\_value}, but got {result}"|

Here is a quick GIF demonstrating the above workflow:

![Connect POstgreSQL](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/overview/postgresql.gif)

---
98 changes: 50 additions & 48 deletions src/pages/docs/addons/community-marketplace.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,81 @@
---
title: "Add-ons Community Marketplace"
page_title: "Testsigma Add-ons Community Marketplace"
metadesc: "This article discusses Testsigma's marketplace for add-ons developed by users. Know how to access and use the community-powered add-ons marketplace."
title: "Addons Community Marketplace"
page_title: "Explore Addons Community Marketplace: Enhance Your Testing"
metadesc: "Discover, manage, and create add-ons to boost your testing efficiency. Browse categories, view details, and contribute to the Addons Community Marketplace."
noindex: false
order: 17.2
page_id: "Add-ons Community Marketplace"
page_id: "addons-community-marketplace-in-testsigma"
search_keyword: ""
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Available Categories"
url: "#available-categories"
name: "Accessing the Community Marketplace"
url: "#accessing-the-community-marketplace"
- type: link
name: "Searching and organizing add-ons"
url: "#searching-and-organizing-add-ons"
name: "Searching, Sorting, and Filtering Addons"
url: "#searching-sorting-and-filtering-addons"
- type: link
name: "Add-on Details"
url: "#add-on-details"
name: "Viewing Addon Details"
url: "#viewing-addon-details"
---

---

Testsigma has a marketplace for add-ons where Testsigma users publish add-ons that they’ve developed.
Testsigma provides a Community Marketplace where users can discover and publish addons to enhance their testing experience. This guide explains how to access the marketplace, search for addons, and view addon details.

If the add-ons feature is enabled in your account, you will see an add-ons icon below the Settings icon on the leftmost Navigation bar.
---

## **Accessing the Community Marketplace**

To access the Community Marketplace, click the addons icon in the navigation bar. The marketplace offers a variety of categories to help you find the addons that best meet your needs.

- **Community**: Addons published by the community and available to all users.
- **Featured**: The most popular and top-rated addons.
- **New and Updated Addons**: Recently added or updated addons.
- **Testsigma Addons**: Official addons provided by the Testsigma team.
- **Installed Addons**: Addons that are already installed and activated in your account.
- **My Addons**: Addons you have created, both public and private. ![explore addon page](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/exploring_addon_page.png)

Refer to the GIF below to find the available community add-ons.
If you don't find an addon that suits your needs, you can [create](https://testsigma.com/docs/addons/create/) a new one and publish it to the Marketplace to help other software development engineers in test (SDETs) in the QA Community.

![add-ons marketplace](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/addon.gif)
---
## **Available Categories**

Add-ons will be categorized as follows:
* **Community:** Contains add-ons published publicly by the community and available to the community.
* **Featured:** Most popular and top-rated add-ons are listed under the Featured category.
* **New and Updated add-ons:** New and recently updated add-ons are listed in this category.
* **Testsigma add-ons:** These are the add-ons provided by the Testsigma Team for the community.
## **Searching, Sorting, and Filtering Addons**

* **Installed add-ons:** These are already installed and activated in your account.
* **My add-ons:** These are add-ons created by you(Public & Private).
To find a specific addon, use the search bar located below the **New Addon** button on the marketplace page. You can organize the addon list by:
- **Package Name**
- **Creation Date**
- **Last Updated Date**

You can publish a custom add-on either as a private or public add-on. All add-ons that are created publicly are shared and available on the Testsigma Add-ons Community Marketplace.
Additionally, you can filter the addon by:

If you can’t find an add-on that suits your requirements, we encourage you to create a new one and publish it to the Marketplace to help other SDETs in the QA Community. See how you can [create an add-on](https://testsigma.com/docs/addons/create/).
- **Tag**
- **Application Type**
- **Ratings**
- **Creation Date**
- **Last Updated Date**

These features help you quickly locate the addon that best match your requirements. ![search addon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/search_addon.png)

---
## **Searching and organizing add-ons**

To find a specific add-on, you can use the search feature (just below the New add-on button) on the add-ons community page.
## **Viewing Addon Details**

You can also sort the add-ons list by package **name, created, and updated date**.
Clicking on an addon in the marketplace opens its details page, where you can find the following information:

![Dropdown showing sort options in add-ons list](https://docs.testsigma.com/images/community-marketplace/add-ons-marketplace-sort-list.png)
- **Addon Name**
- **Download Source Code**: A button to download the addon's source code.
- **Creator Name**: The name of the person who created the addon.
- **Creation Date**: When the addon was created.
- **Addon Description**: A brief description of what the addon does.
- **Addon Rating**: User ratings for the addon.
- **Number of Installs**: How many times the addon has been installed.
- **Supported Application Types**: The types of applications compatible with the addon.
- **Supported Actions**: Actions that can be performed using the addon.
- **Data Generators**: Data generation features supported by the addon. ![viewing addon details](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/viewing_addon_details.png)

You can filter the add-ons list by Tag, Application Type, Ratings, Created, and Updated Date
---

![Overlay showing Filter options in add-ons list](https://docs.testsigma.com/images/community-marketplace/add-ons-marketplace-filter-list.png)

---
## **Add-on Details**

Clicking on an add-on opens the add-on details page as shown below:

![add-on Modal showing addon details](https://docs.testsigma.com/images/community-marketplace/addon-details-modal.png)

You can find the below details on the add-on details page:
* Add-on Name
* Download the source code Button
* Creator Name
* Created Date
* Add-on Description
* Add-on Rating
* Number of Installs
* Supported Application Types
* Actions supported with the add-on
* Data Generators supported with the add-on
49 changes: 26 additions & 23 deletions src/pages/docs/addons/install-community-addon.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,49 @@
---
title: "Installing Community Add-ons"
metadesc: "Learn how to install add-ons from the Add-ons Community Marketplace | Addons from Testsigma Community Marketplace will help you boost your Test Automation"
title: "Install and Use Community Addons in Testsigma"
page_title: "Install and Use Community Add-ons | Enhance Test Automation"
metadesc: "Install and use community add-ons to extend functionality and simplify test automation. Learn how to browse, install, and apply add-ons in your test cases."
noindex: false
order: 17.3
page_id: "Installing Community Add-ons"
page_id: "Installing Community Addon"
search_keyword: ""
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Installing an Add-on"
url: "#installing-an-add-on"
name: "Installing a Community Addon"
url: "#installing-a-community-addon"
- type: link
name: "Using an installed add-on"
url: "#using-an-installed-add-on"
name: "Using an Installed Addon"
url: "#using-an-installed-addon"
---

---

Navigate to the Add-ons page via **Dashboard > Add-ons**.

* Community Tab shows all the add-ons available for installation.
* The Installed Add-ons Tab shows the currently installed add-ons.
* My Add-ons shows add-ons developed and published by you.

Before proceeding, you should be familiar with [add-ons](https://testsigma.com/docs/addons/what-is-an-addon/) and [how to create Test Steps using simple English](https://testsigma.com/docs/test-cases/step-types/natural-language/).
Community Addon in Testsigma extend the functionality of your test cases by allowing you to use pre-built actions created by the community. This guide explains how to install and use these addon in your test cases.

---
## **Installing an Add-on**

Click on the Community Tab and find the add-on you want to install. You can either browse through the list or search for an Add-on using a name or description.

Hover over one of the add-ons and click on the Install button. The selected add-on will be installed and will be available in your Test Cases after a page refresh.
## **Installing a Community Addon**

![Add-on details Popup when clicking on Add-on tile in Installed Add-ons tab](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/communityaddons.gif)
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)

---
## **Using an installed add-on**

Navigate to the Add-ons page via **Dashboard > Add-ons** and switch to the Installed Add-ons tab.
## **Using an Installed Addon**

Click on the add-on you want to use. Add-on details popup will open up. Observe the actions for the add-on in the Actions section of the popup. Once an add-on is installed, its actions will be available in your test step Suggestions while you author test cases. You can type in the action while creating a Test Step and select them from the suggestions.
Once you've installed an addon, you can use it in your test cases:

![Using custom actions in test steps](https://docs.testsigma.com/images/community-marketplace/custom-addons-in-test-steps.png)
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)
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)

[[info | NOTE:]]
| - **Refresh the Page**: After installing an addon, always refresh the page to ensure the actions become available in your test cases.
| - **Custom Actions**: Installed addon offer custom actions that you can integrate into your test steps, simplifying the test authoring process.

---
Loading
Loading