-
Notifications
You must be signed in to change notification settings - Fork 40
docs: add getting-started guide for new users #455
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,93 @@ | ||||||||||||||||||||||||||
| # Getting Started with Plane | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| > New to Plane? This guide takes you from zero to a working project in under 10 minutes. No theory — just action. | ||||||||||||||||||||||||||
| > | ||||||||||||||||||||||||||
| > Already familiar with Plane? Head to [Core Concepts](./core-concepts.md) for feature deep-dives or [Tutorials](./tutorials/) for advanced workflows. | ||||||||||||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix docs link format and target path Line 5 uses Suggested patch-> Already familiar with Plane? Head to [Core Concepts](./core-concepts.md) for feature deep-dives or [Tutorials](./tutorials/) for advanced workflows.
+> Already familiar with Plane? Head to [Core Concepts](/introduction/core-concepts) for feature deep-dives or [Tutorials](/introduction/tutorials/overview) for advanced workflows.As per coding guidelines, “Use relative links between docs (e.g., Cycles) without .md extensions”. 🤖 Prompt for AI Agents |
||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## What is Plane? (30-second overview) | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Plane is an open source project management tool — a free alternative to Jira or Linear. Here is all the terminology you need: | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| | Term | What it means | | ||||||||||||||||||||||||||
| |---|---| | ||||||||||||||||||||||||||
| | **Workspace** | Your organisation's home on Plane — everything lives here | | ||||||||||||||||||||||||||
| | **Project** | A specific area of work — e.g. "Website Redesign" | | ||||||||||||||||||||||||||
| | **Work Item** | A single task — e.g. "Fix login bug" | | ||||||||||||||||||||||||||
| | **Cycle** | A time-boxed sprint — a fixed period to complete work | | ||||||||||||||||||||||||||
| | **Module** | A group of related work items — like an epic | | ||||||||||||||||||||||||||
| | **View** | A saved filter — see exactly what you need | | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Before You Begin | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| You will need: | ||||||||||||||||||||||||||
| - A valid email address | ||||||||||||||||||||||||||
| - A browser (Chrome, Firefox, or Edge recommended) | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Step 1 — Create your Plane account | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| 1. Go to [app.plane.so](https://app.plane.so) | ||||||||||||||||||||||||||
| 2. Click **Sign Up** and enter your email address | ||||||||||||||||||||||||||
| 3. Check your email for a verification link and click it | ||||||||||||||||||||||||||
| 4. Set your name and password | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| > **Tip:** You can also sign up using your Google or GitHub account for faster access. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Step 2 — Create your Workspace | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| 1. After signing up you will be prompted to create a workspace | ||||||||||||||||||||||||||
| 2. Enter your **Workspace Name** — use your company or team name | ||||||||||||||||||||||||||
| 3. Choose your workspace URL | ||||||||||||||||||||||||||
| 4. Select your team size | ||||||||||||||||||||||||||
| 5. Click **Create Workspace** | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| > **Tip:** Choose your workspace name carefully — it is visible to all team members you invite. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Step 3 — Invite your team | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| 1. Click **Settings** in the left sidebar | ||||||||||||||||||||||||||
| 2. Click **Members** | ||||||||||||||||||||||||||
| 3. Click **Invite Members** | ||||||||||||||||||||||||||
| 4. Enter your colleague's email address | ||||||||||||||||||||||||||
| 5. Choose their role — Member for most people, Admin for those who need full control | ||||||||||||||||||||||||||
| 6. Click **Send Invite** | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Step 4 — Create your first Project | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| 1. Click **Projects** in the left sidebar | ||||||||||||||||||||||||||
| 2. Click **Create Project** | ||||||||||||||||||||||||||
| 3. Enter your Project Name — be specific (e.g. "Product Roadmap Q2") | ||||||||||||||||||||||||||
| 4. Add a description | ||||||||||||||||||||||||||
| 5. Choose network — Secret (invited members only) or Public (all workspace members) | ||||||||||||||||||||||||||
| 6. Click **Create Project** | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Step 5 — Add your first Work Items | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| 1. Inside your project click **Issues** in the left sidebar | ||||||||||||||||||||||||||
| 2. Click **Create Issue** | ||||||||||||||||||||||||||
| 3. Write a clear title — e.g. "Design homepage mockup" not just "Design work" | ||||||||||||||||||||||||||
| 4. Set a Priority — Urgent, High, Medium, or Low | ||||||||||||||||||||||||||
| 5. Assign it to a team member | ||||||||||||||||||||||||||
| 6. Set a Due Date if needed | ||||||||||||||||||||||||||
| 7. Click **Create Issue** | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Step 6 — Plan your first Cycle | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| 1. Click **Cycles** in the left sidebar | ||||||||||||||||||||||||||
| 2. Click **Create Cycle** | ||||||||||||||||||||||||||
| 3. Give your Cycle a name — e.g. "Sprint 1 — April" | ||||||||||||||||||||||||||
| 4. Set a Start Date and End Date — 1 or 2 weeks is a good starting point | ||||||||||||||||||||||||||
| 5. Add work items from your backlog into the Cycle | ||||||||||||||||||||||||||
| 6. Click **Create** | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## What to Explore Next | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| | I want to... | Go to... | | ||||||||||||||||||||||||||
| |---|---| | ||||||||||||||||||||||||||
| | Understand all Plane features | Core Concepts | | ||||||||||||||||||||||||||
| | Learn advanced workflows | Tutorials | | ||||||||||||||||||||||||||
| | Set up Plane on my own server | Self-Host Plane | | ||||||||||||||||||||||||||
| | Connect Plane to GitHub or Slack | Integrations | | ||||||||||||||||||||||||||
|
Comment on lines
+84
to
+89
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Make “What to Explore Next” destinations clickable links Lines 86-89 are plain text labels, so the navigation table doesn’t function as navigation. Convert these cells to Markdown links. Suggested patch | I want to... | Go to... |
|---|---|
-| Understand all Plane features | Core Concepts |
-| Learn advanced workflows | Tutorials |
-| Set up Plane on my own server | Self-Host Plane |
-| Connect Plane to GitHub or Slack | Integrations |
+| Understand all Plane features | [Core Concepts](/introduction/core-concepts) |
+| Learn advanced workflows | [Tutorials](/introduction/tutorials/overview) |
+| Set up Plane on my own server | [Self-Host Plane](/self-hosting/overview) |
+| Connect Plane to GitHub or Slack | [Integrations](/integrations/overview) |As per coding guidelines, “Use relative links between docs (e.g., Cycles) without .md extensions”. 📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| *This guide was contributed by Gori Goyal as part of the Plane Community Documentation Improvement Project (April 2026).* | ||||||||||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add required front matter block
Line 1 starts with an H1, but this page is missing front matter. Please add at least
title(required) anddescription(recommended).Suggested patch
As per coding guidelines, “Each Markdown file must have a front matter block with at minimum a
titlefield, and should includedescriptionfor SEO meta and og:description”.📝 Committable suggestion
🤖 Prompt for AI Agents