-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #166 from makeplane/preview
Updated Quickstart and added Core Concepts page
- Loading branch information
Showing
3 changed files
with
81 additions
and
71 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| --- | ||
| title: Core concepts | ||
| --- | ||
|
|
||
| This page will walk you through the core concepts in Plane, so you can get familiar with the basics and start navigating your workspace like a pro. | ||
|
|
||
| ## Workspaces | ||
| Think of a workspace as the central hub for everything you do on Plane. It’s the top-level space where all your projects and issues live. Workspaces are typically set up for a team, department, or company, and everyone within a workspace can collaborate on projects and access shared resources. You can also think of each workspace as a different organization or client you're working with, keeping things separate and organized. | ||
|
|
||
| Inside a workspace, you have the freedom to create projects on your own or invite collaborators to join and share it as a team—it’s entirely up to you! | ||
|
|
||
| Learn more about [Workspaces](/core-concepts/workspaces/overview). | ||
|
|
||
| ## Projects | ||
| Projects are the big, overarching containers for related tasks and issues. You might create a project for a product launch, major features, or even an ongoing initiative. Each project keeps everything in one place, making it easy to track progress and focus on specific goals. Inside a project, you’ll organize and manage issues, assign team members, set deadlines, and structure work into more manageable parts. | ||
|
|
||
| Learn more about [Projects](/core-concepts/projects/overview). | ||
|
|
||
| ## Issues | ||
| Issues are the heart of task management in Plane. Each issue represents a specific task or item of work within a project, whether that’s a bug fix, a new feature, or a to-do. You can assign issues to team members, add due dates, prioritize them, and link related issues together to give context. Issues in Plane are highly customizable, making it easy to tailor them to the needs of your team. | ||
|
|
||
| Each issue is identified by a unique, project-specific number (e.g., VIH-19), making it easy to track and reference. At a minimum, every issue needs a title and a state, but you can customize it further with additional properties and relations as needed. | ||
|
|
||
| :::tip | ||
| You can create issues by clicking on the **Add Issue** button in the right-hand corner of your project, or by using `C` shortcut. | ||
| ::: | ||
|
|
||
| Learn more about [Issues](/core-concepts/issues). | ||
|
|
||
| ## Cycles | ||
| Cycles help you organize work into time-bound periods, like sprints or phases. They’re perfect for planning work over specific intervals, letting your team know what’s coming up and what needs to be wrapped up. Cycles can contain multiple issues from different projects, making it easy to see your team’s workload at a glance and keep an eye on deadlines. | ||
|
|
||
| :::tip | ||
| Only one Cycle can be ongoing at a time to follow the principles of Agile. However, you can have your upcoming issues or draft issues already created for the next cycles. | ||
| ::: | ||
|
|
||
| - You can move existing issues into a new or ongoing cycle or create new issues directly within a cycle. | ||
| - Bulk operations are supported--you can add or update multiple issues to cycles at once. | ||
| - You can't update issues after a cycle is completed, however, the pending issues can be transferred to a new or upcoming cycle. | ||
|
|
||
| Learn more about [Cycles](/core-concepts/cycles). | ||
|
|
||
| ## Modules | ||
| Modules act like folders for organizing and grouping related content within a project. You can think of them as categories or containers where you can store issues, track specific workflows, and keep things organized. Modules make it easy to navigate large projects and keep related work together, especially when handling multiple streams of work. | ||
|
|
||
| You can create as many modules as needed within your workspace, and each module can be customized with its own set of issues, milestones, and team members. | ||
|
|
||
| Learn more about [Modules](/core-concepts/modules). | ||
|
|
||
| ## Pages | ||
| Pages are where you can jot down notes, add documentation, or outline plans—think of them as an AI-powered notepad. They’re perfect for quickly capturing ideas, taking notes during meetings, or starting your day with an organized list. Pages help you keep all your project-related information in one place, and because they’re easily accessible, you can refer to them whenever needed. | ||
|
|
||
| Use Pages to record processes, share best practices, or simply keep team notes that everyone can refer to as needed. | ||
|
|
||
| Learn more about [Pages](/core-concepts/pages/overview). | ||
|
|
||
| ---- | ||
| With these core concepts under your belt, you’re ready to start exploring Plane and putting it to work for your team. Each feature is designed to help you and your team stay organized, collaborate effectively, and deliver your projects with ease. | ||
|
|
||
| Have questions? Ask the [Plane Community](https://discord.com/invite/29tPNhaV). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,86 +1,35 @@ | ||
| --- | ||
| title: Quickstart | ||
| --- | ||
| This page helps you get comfortable with Plane and find your way around more effectively. | ||
|
|
||
| ## Signup and onboarding | ||
| # Quickstart guide | ||
|
|
||
| If you have signed up for the first time, one of the steps during onboarding is to create a new workspace. | ||
| This interactive walkthrough will help you get up and running with Plane in no time. You’ll learn how to set up your workspace, create projects, add and manage issues, organize work into cycles, and track progress—all through easy-to-follow steps. | ||
|
|
||
| - If you are part of a team, you can invite your team members to the workspace before you can begin. | ||
| - If you are using Plane for personal use, you can skip the invitation part and be directly redirected to the workspace. | ||
| ## Set up your Workspace | ||
|
|
||
| :::tip | ||
| During the onboarding process, the invited users will be assigned a **Member** 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. | ||
| ::: | ||
| When you sign up for the first time on Plane, we'll prompt you to create a new Workspace. In this guide, you'll see how to customize the Workspace and invite your team members. Your workspace is the central hub where all your projects and team collaboration will happen, so let’s make it feel like home. | ||
|
|
||
| ## The Dashboard | ||
| After signing up or signing in to a workspace, you will be redirected to the Dashboard. This is where you will see all of the issues that are assigned and pending for you. | ||
| <div style={{ position: "relative", paddingBottom: "calc(56.67989417989418% + 41px)", height: "0", width: "100%" }}> | ||
| <iframe src="https://demo.arcade.software/dbAr7rGeeZux5wELkt8l?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true" frameborder="0" loading="lazy" webkitallowfullscreen mozallowfullscreen allowfullscreen style={{ position: "absolute", top: "0", left: "0", width: "100%", height: "100%", colorScheme: "light"}} title="Set up your workspace"> | ||
| </iframe> | ||
| </div> | ||
|
|
||
| ## Creating Workspaces | ||
| Think of each workspace on Plane as a home for your content. Ideally, you can consider a workspace as a different company or organization you work with. | ||
| ## Create Projects and Issues | ||
|
|
||
| - Inside the workspace, you can create projects as an individual, or invite collaborators to share a workspace as a team - it's up to you! | ||
| Now that your workspace is ready, it’s time to create your first project. Projects keep all related tasks and issues organized in one place, making it easy to focus on specific goals. In this step, you’ll set up a project and add issues with basic properties to get your team started on their tasks. | ||
|
|
||
| :::tip | ||
| 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. | ||
| ::: | ||
| <div style={{ position: "relative", paddingBottom: "calc(56.67989417989418% + 41px)", height: "0", width: "100%" }}> | ||
| <iframe src="https://demo.arcade.software/tZYxYSxhhZqPV7dMoCFG?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true" frameborder="0" loading="lazy" webkitallowfullscreen mozallowfullscreen allowfullscreen style={{ position: "absolute", top: "0", left: "0", width: "100%", height: "100%", colorScheme: "light"}} title="Set up your workspace"> | ||
| </iframe> | ||
| </div> | ||
|
|
||
| ## Creating Projects | ||
|
|
||
| Projects let you manage teams and issues within your workspace. After creating your workspace, you will need to create a new project. | ||
| ## Create and track Cycles | ||
|
|
||
| - If you want to invite other members to a project, you'll need to first add them to a workspace and give them access directly under Project settings after they have been invited. | ||
|
|
||
| - You can manage members either by navigating to **Project > Settings > Members** or **Workspace settings > Members** . | ||
|
|
||
| In this final step, you’ll learn how to organize your work into cycles—time-bound periods for managing tasks like sprints. Cycles help you track progress, prioritize tasks, and stay on top of deadlines. Here, you’ll create cycles, add issues, and learn how to track your team’s work over time. | ||
|
|
||
| ## 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. | ||
|
|
||
| Issues are identified by a project-specific and unique number (Example, `VIH-19`), and they must be provided with a title and a state. All the other properties and relations are optional, know more about them [here](/core-concepts/issues/properties). | ||
|
|
||
| :::tip | ||
| You can create issues by clicking on the `New Issue` button in the right-hand corner of your project, or by using `C` shortcut. | ||
| ::: | ||
|
|
||
| There's a lot more about Issues, learn about them [here](/core-concepts/issues). | ||
|
|
||
| ## Creating Cycles | ||
|
|
||
| A cycle is a group of issues with a custom time period in which a team works to complete items assigned to them. Cycles are similar to sprints in the agile world. | ||
|
|
||
| :::tip | ||
| Only one Cycle can be ongoing at a time to follow the principles of AGILE. However, you can have your upcoming issues or draft issues already created for the next cycles. | ||
| ::: | ||
|
|
||
| - You can move existing issues to a new or existing cycle, or create a new issue directly inside the Cycle. | ||
|
|
||
| - Bulk operations are supported--you can add or update multiple issues to cycles at once. | ||
|
|
||
| - You can't update issues after a cycle is completed, however, the pending issues can be transferred to a new or upcoming cycle. | ||
|
|
||
|
|
||
| ## Creating Modules | ||
|
|
||
| Modules are a flexible way to organize issues in your project. They allow you to break down your work into manageable chunks and track progress toward 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. | ||
|
|
||
| - Modules allow you to add documents and links within them, providing a convenient way to share resources with others within the module. | ||
|
|
||
| ## Creating Pages | ||
|
|
||
| You can think of Pages as an AI-powered notepad. You can use Pages to quickly jot down issues when you're in a meeting or starting a day. Later, you can directly push them to the respective projects to convert them into an issue. | ||
|
|
||
| You've reached the end of this section. But there's more to it. Here are useful resources for you to deep dive into each of these components of Plane. | ||
|
|
||
| - [Workspaces](/core-concepts/workspaces/overview) | ||
| - [Projects](/core-concepts/projects/overview) | ||
| - [Issues](/core-concepts/issues) | ||
| - [Cycles](/core-concepts/cycles) | ||
| - [Modules](/core-concepts/modules) | ||
| - [Pages](/core-concepts/pages/overview) | ||
|
|
||
| Have questions? Ask the [Plane Community](https://discord.com/invite/29tPNhaV). | ||
| <div style={{ position: "relative", paddingBottom: "calc(56.67989417989418% + 41px)", height: "0", width: "100%" }}> | ||
| <iframe src="https://demo.arcade.software/KwDnMqpyMLPgWH3s0tv8?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true" frameborder="0" loading="lazy" webkitallowfullscreen mozallowfullscreen allowfullscreen style={{ position: "absolute", top: "0", left: "0", width: "100%", height: "100%", colorScheme: "light"}} title="Set up your workspace"> | ||
| </iframe> | ||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters