Skip to content

Commit

Permalink
ran through grammerly and formatting changes (#34)
Browse files Browse the repository at this point in the history
  • Loading branch information
Rahulkhinchi03 authored Jan 21, 2025
1 parent 722bca1 commit 030125b
Show file tree
Hide file tree
Showing 6 changed files with 54 additions and 64 deletions.
69 changes: 37 additions & 32 deletions src/content/docs/features/api-catalog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@
title: "API Catalog in Treblle"
---

The API Catalog in Treblle 3.0 is a centralized repository where you can publish and manage your API documentation. It allows teams to collaborate effectively by sharing API details without granting full access to the API itself.
The API Catalog is a centralized repository where you can publish and manage your API documentation. It allows teams to collaborate effectively by sharing API details without granting full access to the API itself.

This is particularly useful if you want someone in your team to interact only with the API documentation rather than the API endpoints directly.

---

#### Key Permissions

It's important to note that **only the owner of an API** has the authority to publish it to the API Catalog. This ensures that API visibility and sharing are carefully controlled, providing a secure and managed environment for catalog updates.
:::note
Only the API's owner has the authority to publish it to the API Catalog has the authority to publish it to the API Catalog. This ensures that API visibility and sharing are carefully controlled, providing a secure and managed environment for catalog updates.
:::

## Steps to add an API to the Catalog

##### 1. Navigate to API Settings
##### 1. Go to API Settings

- Go to your dashboard and select the API you want to add to the catalog.
- Select the API to add to the catalog.
- On the left-hand menu, click **API Settings**.

<img
Expand All @@ -42,47 +42,48 @@ Fill out the required details for your API:

- **API Category**: Select a category (e.g., Payment APIs, Authentication APIs).
- **API Tags**: Add descriptive tags (e.g., OAuth, REST, v2).
- **API Description**: Provide a concise description of the API's purpose and functionality.
- **API Description**: Describe the API's purpose and functionality.

<img
src="/platform/api-catalog/api-information.png"
width="400"
style={{ borderRadius: "8px" }}
/>
<img
src="/platform/api-catalog/api-information.png"
width="400"
style={{ borderRadius: "8px" }}
/>

Example:
The Payment API supports multiple payment methods, including credit cards, PayPal, and digital wallets.
Example:
The Payment API supports multiple payment methods, including credit cards, PayPal, and digital wallets.

<img
src="/platform/api-catalog/publish-example.png"
width="400"
style={{ borderRadius: "8px" }}
/>
<img
src="/platform/api-catalog/publish-example.png"
width="400"
style={{ borderRadius: "8px" }}
/>

- Click **Publish** to make the API live in the catalog.
Click **Publish** to make the API live in the catalog.

## Steps to view the API Catalog

##### 1. Access the API Catalog

- From the dashboard, click **API Catalog** in the left-hand menu.
Click **API Catalog** from the dashboard in the left-hand menu.

<img
src="/platform/api-catalog/api-catalog-option.png"
width="200"
style={{ borderRadius: "8px" }}
/>
<img
src="/platform/api-catalog/api-catalog-option.png"
width="200"
style={{ borderRadius: "8px" }}
/>

##### 2. Explore Published APIs

View the list of published APIs.

<img
src="/platform/api-catalog/api-catalog-dashboard.png"
width="800"
style={{ borderRadius: "8px" }}
/>

- View the list of published APIs.
- Use sorting options like:
Use sorting options like:

- Popular
- Grade
Expand All @@ -95,15 +96,15 @@ The Payment API supports multiple payment methods, including credit cards, PayPa
style={{ borderRadius: "8px" }}
/>

- Filter APIs by SDK or environment for easier navigation.
Filter APIs by SDK or environment for easier navigation.

## Steps to interact with an API

##### 1. API Details

Click on a published API to view detailed information:

- **API Score**: Quality assessment based on design, performance, and security.
- **API Score**: A quality assessment based on design, performance, and security.
- **Followers**: Number of users following the API.
- **Tags and Category**: Metadata for discovery.
- **Description**: Overview of the API's purpose and functionality.
Expand All @@ -114,9 +115,13 @@ Click on a published API to view detailed information:
style={{ borderRadius: "8px" }}
/>

**Tip:** You can interact with your API documentation more effectively using <a href="https://treblle.com/product/alfred" target="_blank" rel="noopener noreferrer"> Alfred</a>, the AI assistant.
:::tip
You can interact with your API documentation more effectively using <a href="https://treblle.com/product/alfred" target="_blank" rel="noopener noreferrer"> Alfred</a>, the AI assistant.
:::

Alfred helps you navigate and understand your API docs, making it particularly useful for new team members.

Alfred helps you navigate and understand your API docs, making it particularly useful for new team members. Learn more about what's new in <a href="https://blog.treblle.com/whats-new-treblle-3-0-api-catalog/" target="_blank" rel="noopener noreferrer">API catalog in Treblle 3.0</a>.
Learn more about what's new in <a href="https://blog.treblle.com/whats-new-treblle-3-0-api-catalog/" target="_blank" rel="noopener noreferrer">API catalog in Treblle 3.0 Blog</a>.

##### 2. Additional Information

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/features/api-compliance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "API Compliance in Treblle"
---

The API Compliance feature in Treblle 3.0 helps you ensure your API adheres to regulatory requirements such as <a href="https://gdpr-info.eu/" target="_blank" rel="noopener noreferrer"> GDPR</a>, <a href="https://doca.gov.in/ccpa/" target="_blank" rel="noopener noreferrer"> CCPA</a>, and <a href="https://www.pcisecuritystandards.org/" target="_blank" rel="noopener noreferrer"> PCI DSS</a> by identifying sensitive data within API requests and responses.
The API Compliance feature helps you ensure your API adheres to regulatory requirements such as <a href="https://gdpr-info.eu/" target="_blank" rel="noopener noreferrer"> GDPR</a>, <a href="https://doca.gov.in/ccpa/" target="_blank" rel="noopener noreferrer"> CCPA</a>, and <a href="https://www.pcisecuritystandards.org/" target="_blank" rel="noopener noreferrer"> PCI DSS</a> by identifying sensitive data within API requests and responses.

## Steps to Use API Compliance

Expand Down Expand Up @@ -48,7 +48,7 @@ The API Compliance feature in Treblle 3.0 helps you ensure your API adheres to r

##### 4. Use the Graph View

- In the **Graph View**, monitor your API’s compliance trend to spot patterns or improvements.
- Monitor your API’s compliance trend in the Graph View to spot patterns or improvements.

<img
src="/platform/api-compliance/graph-view.png"
Expand Down
18 changes: 7 additions & 11 deletions src/content/docs/features/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Authentication in Treblle"
description: "Learn about authentication methods and security features in Treblle"
---

With Treblle, we offer authentication features like Single Sign-On (SSO), Multi-Factor Authentication (MFA), and Social Sign-On to secure your workspace effectively.
Treblle's Authentication feature provides options like Single Sign-On (SSO), Multi-Factor Authentication (MFA), and Social Sign-On to secure your workspace effectively.

## Single Sign-On (SSO)

Expand All @@ -13,7 +13,7 @@ Single Sign-On (SSO) allows users to log in once and gain access to multiple app

1. **Go to Authentication Settings**

- As a workspace owner, go to your workspace settings and locate the **Authentication** section.
- As a workspace owner, locate the Authentication section to your workspace settings.

<img
src="/platform/authentication/sso-empty.png"
Expand Down Expand Up @@ -75,7 +75,7 @@ Single Sign-On (SSO) allows users to log in once and gain access to multiple app
5. **Log In with SSO**

- Go to the Treblle <a href="https://identity.treblle.com/login" target="_blank" rel="noopener noreferrer">Treblle Sign-In</a> page.
- Click **Sign in with SSO**, enter your organization's identifier, and log in.
- Sign in with SSO, enter your organizations identifier, and log in.

<img
src="/platform/authentication/sso-sign-in.png"
Expand All @@ -87,13 +87,13 @@ Single Sign-On (SSO) allows users to log in once and gain access to multiple app

Once SSO is enabled, users can log in using their organization's identity provider. If a user switches between an SSO-protected workspace and a standard workspace, Treblle will prompt for extra authentication to maintain security.

### Social Sign-On for Flexibility
### Social Sign-On

For teams or contractors, Social Sign-On offers a fast and convenient way to access workspaces by linking Google or GitHub accounts.
Social Sign-On offers teams or contractors a fast and convenient way to access workspaces by linking Google or GitHub accounts.

## Multi-Factor Authentication (MFA)

- The <a href="https://en.wikipedia.org/wiki/Multi-factor_authentication" target="_blank" rel="noopener noreferrer"> MFA </a> adds an additional layer of security by requiring two or more verification steps during login. Typically, it combines something you know (like a password) and something you have (like a mobile app code).
- The <a href="https://en.wikipedia.org/wiki/Multi-factor_authentication" target="_blank" rel="noopener noreferrer"> MFA </a> adds a layer of security of security by requiring two or more verification steps during login. Typically, it combines something you know (like a password) and something you have (like a mobile app code).

### Enabling MFA

Expand Down Expand Up @@ -124,14 +124,10 @@ For teams or contractors, Social Sign-On offers a fast and convenient way to acc
## Social Sign-On

- The <a href="https://en.wikipedia.org/wiki/Social_login" target="_blank" rel="noopener noreferrer"> Social Sign-On </a> lets users log in with existing accounts such as Google or GitHub.
- This feature is particularly useful for teams that prefer using familiar credentials instead of creating new ones.
- This feature is handy for teams that prefer using familiar credentials instead of creating new ones.

<img
src="/platform/authentication/social-sign-on.png"
width="300"
style={{ borderRadius: "8px" }}
/>

## Summary

Treblle's authentication features are designed to balance security and usability, providing multiple options to secure your workspace while maintaining a smooth user experience.
17 changes: 3 additions & 14 deletions src/content/docs/features/custom-alert.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,7 @@
title: Custom Alerts in Treblle
---

Custom Alerts in Treblle 3.0 allow you to stay informed about critical API events without sifting through endless logs. This feature lets you configure specific triggers, ensuring timely notifications for error spikes, performance issues, or unusual activities.

In this docs, we’ll cover:

- Setting up Custom Alerts.
- Configuring saved searches.
- Choosing notification channels.
- Examples of Custom Alerts.

---
Custom Alerts allow you to stay informed about critical API events without sifting through logs. This feature lets you configure specific triggers, ensuring timely notifications for error spikes, performance issues, or unusual activities.

## Prerequisites

Expand All @@ -21,11 +12,9 @@ Before you begin, ensure you have:
- Access to your project in the Treblle dashboard.
- Permissions to create and manage alerts.

---

## Setting Up Custom Alerts

### Steps to create a Saved Search
### Steps to Create a Saved Search

Saved searches allow you to define filters for specific API events.

Expand Down Expand Up @@ -132,7 +121,7 @@ For example, filter all `POST` requests to `/auth/register`.

##### 4. **Assign recipients:**

- You have the option to add up to five team members who should receive the alerts.
- You can add up to five team members who should receive the alerts.

<img
src="/platform/custom-alert/scenario-2.png"
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/guides/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ description: Learn how to integrate Treblle into your API in minutes.

import { Steps } from '@astrojs/starlight/components';

Treblle helps you build, improve and observe your APIs with ease. Let's get you set up in just a few minutes.
Treblle helps you build, improve, and observe your APIs with ease. Let's get you set up in just a few minutes.

<Steps>

1. **Create a Treblle Account**

First, [sign up for a free Treblle account](https://identity.treblle.com/register). This gives you access to the Treblle dashboard where you'll be able to observe your APIs.
First, [sign up for a free Treblle account](https://identity.treblle.com/register). This will give you access to the Treblle dashboard, where you can observe your APIs.

2. **Create Your First Project**

Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Treblle
description: Treblle helps engineering and product teams build, ship and understand their REST APIs in one single place.
description: Treblle helps engineering and product teams build, ship and understand their REST APIs in one place.
template: splash
image: /homepage.png
hero:
tagline: API Intelligence Platform, helping engineering and product teams build, ship, and understand their REST APIs in one single place.
tagline: API Intelligence Platform, helping engineering and product teams build, ship, and understand their REST APIs in one place.
image:
file: ../../assets/alfred.gif
actions:
Expand Down Expand Up @@ -46,7 +46,7 @@ import { Steps } from '@astrojs/starlight/components';

## How to use Treblle?

Treblle comes as an easy-to-use SDK that helps your Engineering and Product teams create and manage REST APIs quickly, and more effectively. We support over 15 different languages and frameworks, and add more all the time. If you don't see your language supported: get in touch with us!
Treblle is an easy-to-use SDK that helps your Engineering and Product teams create and manage REST APIs quickly and effectively. We support over 15 different languages and frameworks and always add more. If you dont see your language supported,[contact us](https://discord.gg/NJWYYmMvuE)!

<Steps>

Expand Down

1 comment on commit 030125b

@vercel
Copy link

@vercel vercel bot commented on 030125b Jan 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.