docs: added workspace, quickstart documentation

makeplane · vamsi · Jan 10, 2023 · Dec 27, 2022 · Dec 27, 2022 · Dec 27, 2022
commit 81ce49edc7e6e219252ff460fba2cf42ea1d7eaf
diff --git a/apps/docs/src/components/Navigation.jsx b/apps/docs/src/components/Navigation.jsx
@@ -188,27 +188,21 @@ export const navigation = [
     title: 'Guides',
     links: [
       { title: 'Introduction', href: '/' },
-      { title: 'Get Started', href: '/get-started' },
+      { title: 'Quick Start', href: '/quick-start' },
       { title: 'Self Hosting', href: '/self-hosting' },
-      { title: 'Plane Basics', href: '/plane-basics' },
-      // { title: 'Quickstart', href: '/quickstart' },
-      // { title: 'SDKs', href: '/sdks' },
-      // { title: 'Authentication', href: '/authentication' },
-      // { title: 'Pagination', href: '/pagination' },
-      // { title: 'Errors', href: '/errors' },
-      // { title: 'Webhooks', href: '/webhooks' },
+      { title: 'Architecture', href: '/architecture' },
+    ],
+  },
+  {
+    title: 'Plane App',
+    links: [
+      { title: 'Workspace', href: '/workspace' },
+      { title: 'Project', href: '/project' },
+      { title: 'Issues', href: '/issues' },
+      { title: 'Cycles', href: '/cycles' },
+      { title: 'Modules', href: '/modules' },
     ],
   },
-  // {
-  //   title: 'Resources',
-  //   links: [
-  //     { title: 'Contacts', href: '/contacts' },
-  //     { title: 'Conversations', href: '/conversations' },
-  //     { title: 'Messages', href: '/messages' },
-  //     { title: 'Groups', href: '/groups' },
-  //     { title: 'Attachments', href: '/attachments' },
-  //   ],
-  // },
 ]
 
 export function Navigation(props) {

diff --git a/apps/docs/src/components/Resources.jsx b/apps/docs/src/components/Resources.jsx
@@ -10,8 +10,8 @@ import { UsersIcon } from '@/components/icons/UsersIcon'
 
 const resources = [
   {
-    href: '/get-started',
-    name: 'Get Started',
+    href: '/quick-start',
+    name: 'Quick Start',
     description:
       'Learn how to use Plane and follow the best practices of taking-off.',
     icon: UserIcon,
@@ -26,8 +26,7 @@ const resources = [
   {
     href: '/self-host',
     name: 'Self-host Plane',
-    description:
-      'Run Plane on your computer or development machine.',
+    description: 'Run Plane on your computer or development machine.',
     icon: ChatBubbleIcon,
     pattern: {
       y: -6,
@@ -54,8 +53,7 @@ const resources = [
   {
     href: '/',
     name: 'Community',
-    description:
-      'Hang out with truly exceptional devs & designers on Discord.',
+    description: 'Hang out with truly exceptional devs & designers on Discord.',
     icon: UsersIcon,
     pattern: {
       y: 22,

diff --git a/apps/docs/src/pages/index.mdx b/apps/docs/src/pages/index.mdx
@@ -1,6 +1,7 @@
 import { Guides } from '@/components/Guides'
 import { Resources } from '@/components/Resources'
 import { HeroPattern } from '@/components/HeroPattern'
+import { Heading } from '@/components/Heading'
 
 export const description =
   'Learn everything there is to know about the Protocol API and integrate Protocol into your product.'
@@ -25,6 +26,12 @@ This is where the learning begins and the veterans return for their references.
   />
 </div>
 
+<Heading level={2} id="what-is-plane">
+  What is Plane?
+</Heading>
+
+Plane is an open-source project planning tool that is designed to help individuals and teams streamline their issues, sprints, and product roadmaps. It is easy to use and can be accessed by anyone, making it an ideal choice for a wide range of projects and organizations.
+
 <Resources />
 
 ## Contributing

diff --git a/apps/docs/src/pages/projects.mdx b/apps/docs/src/pages/projects.mdx
diff --git a/apps/docs/src/pages/get-started.mdx → apps/docs/src/pages/quick-start.mdx b/apps/docs/src/pages/get-started.mdx → apps/docs/src/pages/quick-start.mdx
@@ -2,13 +2,33 @@
 
 This section of the Plane docs helps you get comfortable with the product and find your way around more effectively.
 
-## Workspaces
+<Note>
+  If you are using the self-hosted version of Plane and want to install it on a
+  local or cloud machine, follow the instructions [here](/self-hosting).
+</Note>
+
+## Onboarding and Invitation
+
+If you have signed up for the first time, the first step in Plane is to create a new workspace. If you are a freelancer or a solo-player, you can skip the invitation part and be directly redirected to the workspace to start working on your issues. If you are part of a team, you will need to invite your team members to the workspace before you can begin.
+
+<Note>
+  During the onboarding process, the invited users will be assigned a **Viewer**
+  role by default. You can adjust the permissions of invited users for your
+  project in the workspace or project settings page based on your specific
+  requirements.
+</Note>
+
+## The Dashboard (AKA, Home)
+
+After signing up or signing in to a workspace, you will be redirected to the active project home page. This is where you will see all of the issues that are assigned and pending for you.
+
+## Creating Workspaces
 
 Think of each workspace in Plane as a home for your content. Inside, workspace, you can creare projects as an individual, or invite collaborators to share a workspace as a team - it's up to you!
 
 > When you sign up for the first time, we'll prompt you to create a new workspace. If you're invited to join, you can directly join the workspace without creating a new one.
 
-## Projects
+## Creating Projects
 
 Projects let you manage teams and tasks within your Workspace. After creating your Workspace, you will need to create a new project.
 
@@ -19,7 +39,7 @@ Projects let you manage teams and tasks within your Workspace. After creating yo
   page or by **Workspace > Member Settings** page.
 </Note>
 
-## Issues
+## Creating Issues
 
 In Plane, an issue is a task or piece of work. It could be small, like _Update the primary color to blue_, or large, like _Building GitHub integration on plane_. It all depends on how you and your team decide to break down your work into issues.
 
@@ -40,7 +60,7 @@ Inside an issue, you can add as many details as you like to get your work done.
 
 3. **Sub-issues**: You can create a `sub-issue` for an issue to either split the issue into smaller chunks, or assign parts of the issue to different people. If you find that a `sub-issue` is holding up the resolution of an issue, you can convert it to an issue so that it can be worked on separately.
 
-4. **Issue Discussion**: Think, comment or join the conversation by sharing your thoughts under Issue discussion.
+4. **Issue comments**: Think, comment or join the conversation by sharing your thoughts under Issue comments.
 
 5. **Issue activity**: Track what's happening to your issue with activities. Everything is saved, so you can look back and see what happened. Real-time coming soon!
 
@@ -52,13 +72,20 @@ You can organize project issues into views, which let you see your work through
 - You can quickly and easily organize the issues on your board by grouping them or ordering them within views.
 - You can toggle the visibility of issue sub-properties within views, at any time, based on your preferences.
 
-## Plan better with Cycles
+## Creating Cycles
 
 Cycles, (AKA Sprints) is a custom time period in which a team works to complete items on their backlog. At the end of the sprint, the team will usually have finished building and implementing a new version of their product.
 
 - You can move existing issues to a new or existing cycle, or create a new issue directly.
 - Bulk operations are supported--you can add or update multiple issues to cycles at once.
 
----
+## Creating Modules (Early Preview)
+
+Modules are smaller, focused projects that help you group and organize issues within a specific time frame. They allow you to break down your work into manageable chunks and track progress towards specific goals or objectives. You can create as many modules as you need within your workspace, and customize each one with its own set of issues, milestones, and team members.
+
+[Coming soon]
+
+- A Gantt chart is offered to help you stay on top of timelines and deliver modules more efficiently.
+- Modules allow you to add documents and links within them, providing a convenient way to share resources with others within the module.
 
 Have questions? Ask the [Plane](https://discord.com/invite/29tPNhaV) Community.
diff --git a/apps/docs/src/pages/workspace.mdx b/apps/docs/src/pages/workspace.mdx
@@ -0,0 +1,85 @@
+import { Heading } from '@/components/Heading'
+
+# Workspace setup
+
+Workspaces in Plane are where you can access all of your content, including issues, cycles, and modules. Everything is organized within a workspace. To help you understand, you can think of a workspace as similar to a server on Discord or an organization on Slack, where you can bring your entire team together to work.
+
+<Heading level={2} id="creating-a-workspace">
+  Creating workspace
+</Heading>
+
+If you are a first-time user who has signed up for Plane, you will create a new workspace for your team during the onboarding process.
+
+<Note>
+  On Plane cloud and self-hosted versions, the workspace URLs (also known as
+  slugs) must be unique. We allow users to have the same organization names, but
+  the URLs must still be unique to ensure a better experience.
+</Note>
+
+If you are a team member or contributor and are invited to a workspace, you do
+not need to have your own workspace. Instead, after accepting the invitation,
+you will be redirected directly to the workspace you were invited to.
+
+<Heading level={2} id="workspace-roles">
+  Workspace roles
+</Heading>
+
+Every user on a workspace has a specific role associated with them, which
+determines their permissions and what actions they are allowed to take within
+the workspace. This helps to ensure that users only have access to the
+resources and functions that they need in order to complete their work.
+
+These roles can be configured when inviting a user to a workspace from the
+workspace invite page, or later from the workspace settings page. _Note that
+when you invite a user during the onboarding process, they will be assigned
+the default role of 'Viewer'_.
+
+**Available roles**
+
+- **Owner** - The owner of the workspace is the supreme administrator and has all permissions set to `true` within the workspace.
+- **Administrator** - Workspace administrators have similar privileges to the owner, but they are not able to delete the workspace.
+- **Member** - Workspace members are essentially team members within the organization, and they have the ability to read, write, edit, and delete entities inside projects, cycles, and modules within the workspace. It is important to note that workspace members are not able to create new projects, cycles, or modules
+- **Guest** - External members of organizations can be invited as guests, which grants them the ability to view all content to which they have been invited. However, they do not have permissions to write, update, or delete entities inside workspace.
+
+<Note>
+  Users should first join the workspace, in ordered to be invited to public and
+  secret projects. View [projects](/projects) docs for more.
+</Note>
+
+<Heading level={2} id="workspace-inivitation">
+  Inviting user to a workspace
+</Heading>
+
+You can easily invite members of your organization with differnt roles onto a workspace.
+
+On cloud, here's how you can invite a user to your workspace,
+
+1. When you are onboarded, you will see a screen that allows you to invite your team members to the workspace. By default, we set the role to `View`` only. This is because we perform a bulk operation to get your team up and running.
+2. If you've missed step one, you can manage all your members under `/<workspace-name>/settings/members` page.
+3. To invite team members, use the Add Member option. When an invitation is sent, the invitee will receive an email to accept the invitation.
+4. To update workspace member permissions, use the collapsable menu, next to the member.
+
+<Note>
+  Self-hosted users should configure an email service in order to send
+  invitations. Follow [this](/self-hosting) document to learn how to set up
+  self-hosted instances.
+</Note>
+
+<Heading level={2} id="delete-a-workspace">
+  Delete a workspace
+</Heading>
+
+Only workspace owners have the ability to delete a workspace, which can be found in the workspace settings.
+
+<Note>
+  If a workspace is deleted, all of its content, issues, cycles, and modules
+  will also be deleted. Currently, Plane does not offer a automatic backup
+  service on cloud or self-hosted versions, but it is planned on our roadmap.
+</Note>
+
+<Heading level={2} id="delete-a-workspace">
+  Workspace plan
+</Heading>
+
+- **Cloud**: All-plans, no suggestion, no limits.
+- **Self-hosted**: No plans, No suggestion, no limits.