Skip to content

Commit

Permalink
Added Workspace docs (#35)
Browse files Browse the repository at this point in the history
Co-authored-by: Pratim <[email protected]>
  • Loading branch information
Rahulkhinchi03 and timpratim authored Jan 21, 2025
1 parent 030125b commit ba9fc3c
Show file tree
Hide file tree
Showing 17 changed files with 185 additions and 0 deletions.
3 changes: 3 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ export default defineConfig({
label: 'Treblle',
collapsed: false,
items: [{
label: 'Workspace',
link: '/treblle/workspace/'
}, {
label: 'Alfred - AI Assistant',
link: '/treblle/alfred/'
}, {
Expand Down
Binary file added public/platform/workspace/add-api-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/platform/workspace/add-api.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/platform/workspace/api-catalog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/platform/workspace/configure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/platform/workspace/create-or-join.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/platform/workspace/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/platform/workspace/email.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/platform/workspace/join-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/platform/workspace/landscape.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/platform/workspace/more-options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/platform/workspace/new-workspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/platform/workspace/notification.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/platform/workspace/people-section.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/platform/workspace/treblle-workspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/platform/workspace/workspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
182 changes: 182 additions & 0 deletions src/content/docs/treblle/workspace.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
---
title: Treblle Workspace
---

Workspaces are the central organizational unit within [Treblle 3.0](https://next.treblle.com/), allowing teams to manage APIs and collaborate efficiently.

Each Workspace serves as a container for APIs, users, and settings.

## Getting Started with Workspaces

1. **Sign In or Create an Account**: Log in to your Treblle <a href="https://identity.treblle.com/login" target="_blank" rel="noopener noreferrer">account</a>.
2. **Access the Workspace Dropdown**: Use the Workspace dropdown at the top of the interface.

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

3. **Choose an Option**:

<img
src="/platform/workspace/create-or-join.png"
width="500"
style={{ borderRadius: "8px" }}
/>

#### Join a Workspace

If you are the Workspace Owner, invite team members to join:

Steps to Invite Members:
1. Go to **Workspace Settings > People**.
2. Enter the email addresses of team members.
3. Assign roles (Owner or Member).
4. Send the invitations.

<img
src="/platform/workspace/people-section.png"
width="800"
style={{ borderRadius: "8px" }}
/>

Team members can accept invitations sent by the Workspace Owner.

<img
src="/platform/workspace/join-2.png"
width="500"
style={{ borderRadius: "8px" }}
/>

#### Create a New Workspace

Provide a name and configure initial settings.

<img
src="/platform/workspace/new-workspace.png"
width="350"
style={{ borderRadius: "8px" }}
/>

You can also invite members after creating the Workspace.

<img
src="/platform/workspace/email.png"
width="350"
style={{ borderRadius: "8px" }}
/>

Here’s an example of a new Workspace:

<img
src="/platform/workspace/workspace.png"
width="800"
style={{ borderRadius: "8px" }}
/>

#### Workspace Settings

Workspace Owners can manage settings under the **Settings** tab.

Key options include:
- **Workspace Details**: Update the name and description.
- **Share Feature**: Toggle the share feature for all APIs in the Workspace.
- **Workspace Options**: Leave or delete the Workspace.

<img
src="/platform/workspace/configure.png"
width="800"
style={{ borderRadius: "8px" }}
/>

### Adding APIs to a Workspace

1. Access the Workspace Dashboard

Choose one of two options to add an API:

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

2. Add API Details

Select Add API and complete the required fields, such as API name and description.

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

3. Integrate Treblle SDK

Follow the [SDK integration](https://docs.treblle.com/integrations/) guide to start collecting data.

## Using the Workspace Dashboard

Once APIs are added, the Workspace Dashboard provides high-level insights and navigation tools for managing your APIs.

#### API Landscape Analytics

The top section displays:
- **Total APIs**: Number of APIs in the Workspace.
- **Total Requests**: Total requests across all APIs in the Workspace.
- **Issues**: Detected issues, updated every 5 minutes.

<img
src="/platform/workspace/landscape.png"
width="800"
style={{ borderRadius: "8px" }}
/>

#### Navigation Tools

- **Favorites**: Quickly access your most-used APIs.
- **Filters**: Narrow APIs by SDK or environment.
- **Search**: Locate APIs using free text.
- **Timescale**: View APIs by creation date.

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

#### Roles and Permissions

- **Owner:** Full control over Workspace and API settings.
- **Member:** Access is limited to assigned APIs and permissions.

#### More Options

**API Catalog:** Publish and manage API documentation in a centralized repository, [API Catalog](https://docs.treblle.com/features/api-catalog/).

Share API docs without granting direct access to API details.

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

**Notifications:** Receive in-app alerts about API comments or updates.

<img
src="/platform/workspace/notification.png"
width="800"
style={{ borderRadius: "8px" }}
/>

#### Support Options

- **Documentation:** Access [Treblle's guide](https://docs.treblle.com/).
- **Live Support:** Get responses within 5 minutes.
- **Community:** Join Treblle’s [Discord](https://discord.gg/NJWYYmMvuE) to connect with other users.
- **Native Apps:** Leverage tools like:
- [Aspen](https://docs.treblle.com/aspen/)- API-testing native app for macOS.
- [Alfred](https://docs.treblle.com/treblle/alfred/) - Treblle’s AI assistant.
- [API Insights](https://docs.treblle.com/treblle/api-insights/) - API governance tool.

1 comment on commit ba9fc3c

@vercel
Copy link

@vercel vercel bot commented on ba9fc3c 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.