diff --git a/astro.config.mjs b/astro.config.mjs index 37dd11c..300674b 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -96,6 +96,9 @@ export default defineConfig({ }, { label: 'Requests', link: '/treblle/requests/' + }, { + label: 'Workspace', + link: '/treblle/workspace/' }] }, { label: 'Integrations', diff --git a/public/platform/workspace/add-api-1.png b/public/platform/workspace/add-api-1.png new file mode 100644 index 0000000..69edd40 Binary files /dev/null and b/public/platform/workspace/add-api-1.png differ diff --git a/public/platform/workspace/add-api.png b/public/platform/workspace/add-api.png new file mode 100644 index 0000000..4c265b8 Binary files /dev/null and b/public/platform/workspace/add-api.png differ diff --git a/public/platform/workspace/api-catalog.png b/public/platform/workspace/api-catalog.png new file mode 100644 index 0000000..279c885 Binary files /dev/null and b/public/platform/workspace/api-catalog.png differ diff --git a/public/platform/workspace/configure.png b/public/platform/workspace/configure.png new file mode 100644 index 0000000..a58d395 Binary files /dev/null and b/public/platform/workspace/configure.png differ diff --git a/public/platform/workspace/create-or-join.png b/public/platform/workspace/create-or-join.png new file mode 100644 index 0000000..b7a3bd8 Binary files /dev/null and b/public/platform/workspace/create-or-join.png differ diff --git a/public/platform/workspace/dashboard.png b/public/platform/workspace/dashboard.png new file mode 100644 index 0000000..70b9022 Binary files /dev/null and b/public/platform/workspace/dashboard.png differ diff --git a/public/platform/workspace/email.png b/public/platform/workspace/email.png new file mode 100644 index 0000000..036efa9 Binary files /dev/null and b/public/platform/workspace/email.png differ diff --git a/public/platform/workspace/join-2.png b/public/platform/workspace/join-2.png new file mode 100644 index 0000000..42b3035 Binary files /dev/null and b/public/platform/workspace/join-2.png differ diff --git a/public/platform/workspace/landscape.png b/public/platform/workspace/landscape.png new file mode 100644 index 0000000..7532cfb Binary files /dev/null and b/public/platform/workspace/landscape.png differ diff --git a/public/platform/workspace/more-options.png b/public/platform/workspace/more-options.png new file mode 100644 index 0000000..d35904d Binary files /dev/null and b/public/platform/workspace/more-options.png differ diff --git a/public/platform/workspace/new-workspace.png b/public/platform/workspace/new-workspace.png new file mode 100644 index 0000000..1298d78 Binary files /dev/null and b/public/platform/workspace/new-workspace.png differ diff --git a/public/platform/workspace/notification.png b/public/platform/workspace/notification.png new file mode 100644 index 0000000..8c21b9d Binary files /dev/null and b/public/platform/workspace/notification.png differ diff --git a/public/platform/workspace/people-section.png b/public/platform/workspace/people-section.png new file mode 100644 index 0000000..4053c14 Binary files /dev/null and b/public/platform/workspace/people-section.png differ diff --git a/public/platform/workspace/treblle-workspace.png b/public/platform/workspace/treblle-workspace.png new file mode 100644 index 0000000..6d33baf Binary files /dev/null and b/public/platform/workspace/treblle-workspace.png differ diff --git a/public/platform/workspace/workspace.png b/public/platform/workspace/workspace.png new file mode 100644 index 0000000..68ca350 Binary files /dev/null and b/public/platform/workspace/workspace.png differ diff --git a/src/content/docs/treblle/workspace.mdx b/src/content/docs/treblle/workspace.mdx new file mode 100644 index 0000000..5c91c72 --- /dev/null +++ b/src/content/docs/treblle/workspace.mdx @@ -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 account. +2. **Access the Workspace Dropdown**: Use the Workspace dropdown at the top of the interface. + + + +3. **Choose an Option**: + + + +#### 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. + + + +Team members can accept invitations sent by the Workspace Owner. + + + +#### Create a New Workspace + +Provide a name and configure initial settings. + + + +You can also invite members after creating the Workspace. + + + +Here’s an example of a new Workspace: + + + +#### 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. + + + +### Adding APIs to a Workspace + +1. Access the Workspace Dashboard + +Choose one of two options to add an API: + + + +2. Add API Details + +Select Add API and complete the required fields, such as API name and description. + + + +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. + + + +#### 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. + + + +#### 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. + + + +**Notifications:** Receive in-app alerts about API comments or updates. + + + +#### 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.