From 2ed8458c654dfc73fd70ecfe3e63fa24c05b400e Mon Sep 17 00:00:00 2001 From: Shreya Ranpariya Date: Thu, 10 Aug 2023 18:58:57 +0530 Subject: [PATCH 1/2] doc: collaboration doc added as per nishcit's guideline --- pages/collaboration/_meta.json | 9 +++-- pages/collaboration/creating-organization.mdx | 25 +++++++++---- pages/collaboration/creating-workspace.mdx | 36 ++++++++++--------- pages/collaboration/getting-started.mdx | 22 +++++++++--- pages/collaboration/inviting-members.mdx | 26 +++++++------- pages/collaboration/members.mdx | 16 +++++++++ pages/collaboration/switching-workspace.mdx | 1 - 7 files changed, 89 insertions(+), 46 deletions(-) create mode 100644 pages/collaboration/members.mdx delete mode 100644 pages/collaboration/switching-workspace.mdx diff --git a/pages/collaboration/_meta.json b/pages/collaboration/_meta.json index cb364c3..fc4a224 100644 --- a/pages/collaboration/_meta.json +++ b/pages/collaboration/_meta.json @@ -1,8 +1,7 @@ { "getting-started": "Getting Started", - "creating-organization": "Organization overview", - "creating-workspace": "Workspace overview", - "inviting-members": "Manging members", - "accepting-invitation": "Accepting Invitation", - "switching-workspace": "Switching Workspace" + "creating-organization": "Organization Overview", + "creating-workspace": "Workspace Overview", + "inviting-members": "Invite Members", + "members": "Members" } diff --git a/pages/collaboration/creating-organization.mdx b/pages/collaboration/creating-organization.mdx index 1dd92f0..9d745b6 100644 --- a/pages/collaboration/creating-organization.mdx +++ b/pages/collaboration/creating-organization.mdx @@ -2,16 +2,17 @@ import { Callout } from 'nextra-theme-docs' ### Organization overview -An organization in Firecamp represents a centralized place where teams can collaborate, manage APIs, and streamline their development process. The organization acts as a container for multiple workspaces, making it easy to organize and manage your API collections across team. +Managing your team's projects, APIs, and collaborations efficiently is made easy with Firecamp's robust Organization features. In this section, we'll delve into the various aspects of managing your Organization, from creating and switching Organizations to managing members and even deleting Organizations when needed. In this guide you'll learn below operation. -- #### [Creating organization](/collaboration/creating-organization#1-creating-organization-1) +- #### [Create Organization](/collaboration/creating-organization#1-creating-organization-1) - #### [Switch between organization](/collaboration/creating-organization#2-how-to-switch-between-organization) - #### 1. Creating organization + #### 1. Create Organization + Creating an Organization in Firecamp is the first step towards structured collaboration. An Organization acts as a container for all your workspaces and projects, helping you maintain a well-organized environment for your team. -1. Navigate and click ` Create ` dropdown in the upper right side. +1. Navigate and click ` Triangle ` dropdown in the upper right side. 2. Click `New organization` 3. Popup will open, enter your `organization name` and click `create` 4. Once you'll click the `create`, popup will open and ask you to switch to new organization. @@ -22,11 +23,21 @@ Firecamp create default workspace as "Main workspace" you can later update the n #### 2. Switch between organization +If you are a part of multiple Organizations, switching between them is a breeze with Firecamp. -1. Navigate and click ` Create ` dropdown in the upper right side. +1. Navigate and click ` Triangle ` dropdown in the upper right side. 2. Click `Switch organization`. -3. Pop will open that shows the list of organizations you're part of. -4. Click your required organization and it'll redirect you to selected organization. +listing all the Organizations you are a part of. Choose the one you want to switch to. + +#### 3. Delete organization + + +#### 4. Manage Organization Members +Collaboration within an Organization involves managing its members. As an admin, you can control who has access to the Organization and its Workspaces. + +1. Navigate and click ` Triangle ` dropdown in the upper right side. Click `Invite members` + +2. Click 'Invite New Members': : Invite new members by providing their email addresses. They will receive an invitation to join the Organization. Let's jump to learn how to create workspace under the organization. diff --git a/pages/collaboration/creating-workspace.mdx b/pages/collaboration/creating-workspace.mdx index b1f5d52..b36ca10 100644 --- a/pages/collaboration/creating-workspace.mdx +++ b/pages/collaboration/creating-workspace.mdx @@ -2,7 +2,7 @@ import { Callout } from 'nextra-theme-docs' ### Workspace overview -Workspaces serve as dedicated environments within an organization where teams can manage, test, and document their APIs. +Firecamp's Workspace feature empowers you to organize your Collections, APIs, and collaborations efficiently within an Organization. There are two type of workspace in Firecamp. @@ -12,35 +12,39 @@ There are two type of workspace in Firecamp. In this guide you'll learn below operation. -- #### [Creating workspace]() -- #### [Managing workspace]() -- #### [Switch between workspace]() +- #### [Create workspace]() +- #### [Switch workspace]() +- #### [Update/Delete workspace]() Create workspace first you need to select the organization under which you want to create new workspace. -#### 1. Creating workspace +#### 1. Create workspace +Creating a new Workspace in Firecamp is a straightforward process that allows you to segment your Collections and APIs effectively. -1. Navigate and click ` Create ` dropdown in the upper right side. +1. Navigate and click ` Triangle ` dropdown in the upper right side. 2. Click `New workspace` 3. Popup will open, enter your `workspace name` and click `create` 4. Once you'll click the `create`, popup will open and ask you to switch to new workspace. 5. By clicking `Yes switch to the new workspace` it'll redirect you to newly created workspace. -### 2. Managing workspaces -1. Navigate and click the setting icon bottom left corner. -2. workspace management popup will open. -3. Edit the `workspace name` and `Description` -4. Click `Update`. It'll update the default workspace name. +#### 2. Switch workspace +Firecamp's Workspace switching feature enables you to seamlessly transition between different collections and APIs within your Organization. -#### 3. Switch between workspace -1. Navigate and click ` Create ` dropdown in the upper right side. +1. Navigate and click ` Triangle ` dropdown in the upper right side. 2. Click `Switch workspace`. -3. Pop will open that shows the list of workspace. -4. Click the workspace name you want to switch to and it'll redirect you to selected workspace. +3. Pop will open and displaying all the Workspaces within your Organization. Choose the one you want to switch to.. +4. Firecamp will instantly switch your view to the selected Workspace, allowing you to continue your work. + +### 3. Update/Delete workspaces + +1. Navigate and click the setting icon bottom left corner. +2. workspace management popup will open. +3. Edit the `Workspace name` and `Description` +4. Click `Update`. It'll update the default workspace name. -Note : remove localhost from link URL. +Let's jump to learn how to Invite members to workspace. diff --git a/pages/collaboration/getting-started.mdx b/pages/collaboration/getting-started.mdx index de3b078..5f288a8 100644 --- a/pages/collaboration/getting-started.mdx +++ b/pages/collaboration/getting-started.mdx @@ -1,10 +1,22 @@ ## Getting Started -Firecamp has been designed to enhance team collaboration in API development. With Firecamp, you can bring your team together in a centralized workspace, enabling seamless real-time collaboration, efficient communication, and streamlined workflows. +Firecamp team collaboration allows you to seamlessly collaborate with your team members, ensuring efficient communication, shared resources, and streamlined workflows. -In this guide, we'll walk you through the steps to get started with Firecamp team collaboration, from creating your team and inviting members to setting up role-based access control, organizing projects and workspaces, and utilizing the various collaboration features Firecamp offers. +Prerequisites +Before you dive into team collaboration using Firecamp, there are a few prerequisites you need to fullfil. These prerequisites will ensure that you have a smooth experience and make the most of Firecamp's collaboration features. -Below are the quick points to get you started with how effectively you can work with work with your team in Firecamp. +To Achieve Maximum Collaboration, You Need to Have the Following Prerequisites + + **1. Firecamp Account:** Each team member should have their own Firecamp account. If they don't have one, they can easily sign up on the Firecamp web. + + **2. Access to Firecamp:** Ensure that you and your team members have access to the Firecamp application. This can be through the web version or the desktop application (soon to be released), depending on your preferences. + +### Organization +In Firecamp, an Organization is a container that holds all your workspaces and projects. Organizations allow you to manage different teams and projects efficiently. You can think of an Organization as the top-level grouping for your work. + +### Workspace +Within an Organization, we have the concept of a Workspace. A Workspace is a place where you collaborate on specific projects, APIs, and collections. It's a focused environment where your team can work together. Each Workspace has its own set of resources, making it easier to organize and manage your projects. + +### Invite members +Collaboration wouldn't be complete without your team members. Firecamp makes it easy to invite team members to your Organization and specific Workspaces. -### Creating organization -### Creating workspace diff --git a/pages/collaboration/inviting-members.mdx b/pages/collaboration/inviting-members.mdx index ce5aba1..9abd2a6 100644 --- a/pages/collaboration/inviting-members.mdx +++ b/pages/collaboration/inviting-members.mdx @@ -1,24 +1,26 @@ -### Team workspace overview +### Invite Members overview -Team workspaces serve as shared environments where multiple team members can collaborate on API collections. +Inviting members to your Workspace is a fundamental step in enabling collaboration within Firecamp. By adding members to your Workspace, you grant them access to your projects, APIs, and collections, allowing for streamlined teamwork. +#### 1. How to Invite Members to Join Workspace? -In this guide you'll learn below operations. -#### 1. Creating team workspace -#### 2. Inviting team members -#### 3. Managing members -#### 4. Managing workspace - -To invite team member to workspace, follow the below steps, - -1. Navigate and click ` Create ` dropdown in the upper right side. +1. Navigate and click ` Triangle ` dropdown in the upper right side. 2. Click the `Invite members` option from dropdown. 3. Invite members popup will open. 4. Enter the name and email of team member in this formate `name,email`. ie `alice, alice@xyz.com` 5. You can also select the role of member by selecting the invite member as `Collaborator` or `Admin`. To learn more about the roles from here. 6. Once you add the name and email click the `Send Invitation` button. - This will send the workspace invitation on the entered email address. + +#### 2. How to accept the Invitation? +Invited members will receive an email invitation to join the Workspace. Here's how they can accept the invitation: + +1. If the invitee already has a Firecamp account, they can sign in. If not, they'll need to sign up for a Firecamp account. +2. Click "View Invitation" in the top right triangle. +3. Join the workspace by accepting the invitation + + Soon after, they'll be directed to the Workspace where they can start collaborating with your team. + \ No newline at end of file diff --git a/pages/collaboration/members.mdx b/pages/collaboration/members.mdx new file mode 100644 index 0000000..0dd9e0b --- /dev/null +++ b/pages/collaboration/members.mdx @@ -0,0 +1,16 @@ +## Members Overview + +Collaboration within Firecamp is all about working together seamlessly on projects, APIs, and collections. Managing members at both the Organization and Workspace levels is essential for maintaining an organized and productive collaborative environment. +Members play a crucial role in your collaborative efforts. They can be part of your Organization, giving them access to various Workspaces, or they can collaborate within specific Workspaces. + +#### 1. Manage Organization Members +Managing members at the Organization level involves controlling who has access to your Organization and its Workspaces. Here's how to do it: + +How to Remove Members from Organization? +1. Navigate and click the ` Organization name ` from the activity bar. +2. Click `Org Management` + + +#### 2. Manage Workspace Members + +Managing members within a specific Workspace ensures that your collaborative efforts are well-organized and focused. Here's how to do it: diff --git a/pages/collaboration/switching-workspace.mdx b/pages/collaboration/switching-workspace.mdx deleted file mode 100644 index 84dd98d..0000000 --- a/pages/collaboration/switching-workspace.mdx +++ /dev/null @@ -1 +0,0 @@ -## Switching Workspace From 156dbaf5f7b871c060019284303c36cc0d8acab7 Mon Sep 17 00:00:00 2001 From: Shreya Ranpariya Date: Fri, 11 Aug 2023 18:25:21 +0530 Subject: [PATCH 2/2] doc: collaboration doc added as per nishcit's guideline --- pages/collaboration/accepting-invitation.mdx | 4 ---- pages/collaboration/creating-organization.mdx | 15 ++++----------- pages/collaboration/creating-workspace.mdx | 12 +++--------- pages/collaboration/inviting-members.mdx | 12 +++++------- pages/collaboration/members.mdx | 12 +++++++++--- 5 files changed, 21 insertions(+), 34 deletions(-) delete mode 100644 pages/collaboration/accepting-invitation.mdx diff --git a/pages/collaboration/accepting-invitation.mdx b/pages/collaboration/accepting-invitation.mdx deleted file mode 100644 index d13922f..0000000 --- a/pages/collaboration/accepting-invitation.mdx +++ /dev/null @@ -1,4 +0,0 @@ -### How accept invitation and start collaborate with team member - -Once,invitation has been sent to the team members next step is to accept the invitation and join the workspace. - diff --git a/pages/collaboration/creating-organization.mdx b/pages/collaboration/creating-organization.mdx index 9d745b6..44dbc77 100644 --- a/pages/collaboration/creating-organization.mdx +++ b/pages/collaboration/creating-organization.mdx @@ -4,15 +4,11 @@ import { Callout } from 'nextra-theme-docs' Managing your team's projects, APIs, and collaborations efficiently is made easy with Firecamp's robust Organization features. In this section, we'll delve into the various aspects of managing your Organization, from creating and switching Organizations to managing members and even deleting Organizations when needed. -In this guide you'll learn below operation. -- #### [Create Organization](/collaboration/creating-organization#1-creating-organization-1) -- #### [Switch between organization](/collaboration/creating-organization#2-how-to-switch-between-organization) - #### 1. Create Organization Creating an Organization in Firecamp is the first step towards structured collaboration. An Organization acts as a container for all your workspaces and projects, helping you maintain a well-organized environment for your team. -1. Navigate and click ` Triangle ` dropdown in the upper right side. +1. Navigate and click ` App menu ` dropdown in the upper right side. 2. Click `New organization` 3. Popup will open, enter your `organization name` and click `create` 4. Once you'll click the `create`, popup will open and ask you to switch to new organization. @@ -25,21 +21,18 @@ Firecamp create default workspace as "Main workspace" you can later update the n #### 2. Switch between organization If you are a part of multiple Organizations, switching between them is a breeze with Firecamp. -1. Navigate and click ` Triangle ` dropdown in the upper right side. +1. Navigate and click ` App menu ` dropdown in the upper right side. 2. Click `Switch organization`. listing all the Organizations you are a part of. Choose the one you want to switch to. -#### 3. Delete organization - -#### 4. Manage Organization Members +#### 3. Manage Organization Members Collaboration within an Organization involves managing its members. As an admin, you can control who has access to the Organization and its Workspaces. -1. Navigate and click ` Triangle ` dropdown in the upper right side. Click `Invite members` +1. Navigate and click ` App menu ` dropdown in the upper right side. Click `Invite members` 2. Click 'Invite New Members': : Invite new members by providing their email addresses. They will receive an invitation to join the Organization. Let's jump to learn how to create workspace under the organization. -Note : remove localhost from link \ No newline at end of file diff --git a/pages/collaboration/creating-workspace.mdx b/pages/collaboration/creating-workspace.mdx index b36ca10..afb0f39 100644 --- a/pages/collaboration/creating-workspace.mdx +++ b/pages/collaboration/creating-workspace.mdx @@ -10,12 +10,6 @@ There are two type of workspace in Firecamp. 2. Team workspace - -In this guide you'll learn below operation. -- #### [Create workspace]() -- #### [Switch workspace]() -- #### [Update/Delete workspace]() - Create workspace first you need to select the organization under which you want to create new workspace. @@ -23,7 +17,7 @@ Create workspace first you need to select the organization under which you want #### 1. Create workspace Creating a new Workspace in Firecamp is a straightforward process that allows you to segment your Collections and APIs effectively. -1. Navigate and click ` Triangle ` dropdown in the upper right side. +1. Navigate and click ` App menu ` dropdown in the upper right side. 2. Click `New workspace` 3. Popup will open, enter your `workspace name` and click `create` 4. Once you'll click the `create`, popup will open and ask you to switch to new workspace. @@ -34,13 +28,13 @@ Creating a new Workspace in Firecamp is a straightforward process that allows yo Firecamp's Workspace switching feature enables you to seamlessly transition between different collections and APIs within your Organization. -1. Navigate and click ` Triangle ` dropdown in the upper right side. +1. Navigate and click ` App menu ` dropdown in the upper right side. 2. Click `Switch workspace`. 3. Pop will open and displaying all the Workspaces within your Organization. Choose the one you want to switch to.. 4. Firecamp will instantly switch your view to the selected Workspace, allowing you to continue your work. -### 3. Update/Delete workspaces +### 3. Update workspaces 1. Navigate and click the setting icon bottom left corner. 2. workspace management popup will open. diff --git a/pages/collaboration/inviting-members.mdx b/pages/collaboration/inviting-members.mdx index 9abd2a6..e8aa29b 100644 --- a/pages/collaboration/inviting-members.mdx +++ b/pages/collaboration/inviting-members.mdx @@ -4,22 +4,20 @@ Inviting members to your Workspace is a fundamental step in enabling collaborati #### 1. How to Invite Members to Join Workspace? -1. Navigate and click ` Triangle ` dropdown in the upper right side. -2. Click the `Invite members` option from dropdown. +1. Navigate and click **` App Menu `** dropdown in the upper right side. +2. Click the **`Invite members`** option from dropdown. 3. Invite members popup will open. 4. Enter the name and email of team member in this formate `name,email`. ie `alice, alice@xyz.com` -5. You can also select the role of member by selecting the invite member as `Collaborator` or `Admin`. To learn more about the roles from here. -6. Once you add the name and email click the `Send Invitation` button. +5. You can also select the role of member by selecting the invite member as **`Collaborator`** or **`Admin`**. To learn more about the roles from here. +6. Once you add the name and email click the **`Send Invitation`** button. This will send the workspace invitation on the entered email address. - - #### 2. How to accept the Invitation? Invited members will receive an email invitation to join the Workspace. Here's how they can accept the invitation: 1. If the invitee already has a Firecamp account, they can sign in. If not, they'll need to sign up for a Firecamp account. -2. Click "View Invitation" in the top right triangle. +2. Click **"View Invitation"** in the top right App menu. 3. Join the workspace by accepting the invitation Soon after, they'll be directed to the Workspace where they can start collaborating with your team. diff --git a/pages/collaboration/members.mdx b/pages/collaboration/members.mdx index 0dd9e0b..fda78e0 100644 --- a/pages/collaboration/members.mdx +++ b/pages/collaboration/members.mdx @@ -4,13 +4,19 @@ Collaboration within Firecamp is all about working together seamlessly on projec Members play a crucial role in your collaborative efforts. They can be part of your Organization, giving them access to various Workspaces, or they can collaborate within specific Workspaces. #### 1. Manage Organization Members + Managing members at the Organization level involves controlling who has access to your Organization and its Workspaces. Here's how to do it: -How to Remove Members from Organization? +1.1 How to Remove Members from Organization? 1. Navigate and click the ` Organization name ` from the activity bar. -2. Click `Org Management` +2. Click `Org Management`. #### 2. Manage Workspace Members +Managing members within a specific Workspace ensures that your collaborative efforts are well-organized and focused + +**2.1 How to remove members from the Workspace?** + Navigate and click the setting icon bottom left corner. +2. workspace management popup will open. Click the **`Members`** tab. +3. Click `Delete - icon` and it will remove particular member from the workspace. -Managing members within a specific Workspace ensures that your collaborative efforts are well-organized and focused. Here's how to do it: