From c6dc9fffba509f1ea9c47e39bf3fec2425f4e97b Mon Sep 17 00:00:00 2001 From: danciaclara Date: Fri, 15 Nov 2024 16:52:34 +0530 Subject: [PATCH 1/7] Add Jira importer --- docs/plane-importers/jira-imp.mdx | 97 ++++++++++++++++++++++++++----- 1 file changed, 83 insertions(+), 14 deletions(-) diff --git a/docs/plane-importers/jira-imp.mdx b/docs/plane-importers/jira-imp.mdx index de632b6..cbec95e 100644 --- a/docs/plane-importers/jira-imp.mdx +++ b/docs/plane-importers/jira-imp.mdx @@ -1,21 +1,90 @@ --- title: Jira -hide_title: true --- -import Tags from '@site/src/components/Tags'; - -
-

Import your Jira data to Plane

- -
+# Import your Jira data to Plane Integrate seamlessly with Jira and import issues into your Plane projects. -:::info -The Jira importer is currently available under a feature flag. Contact our support team if you’d like to try it out. -::: +## Overview + +With the Jira importer, you can easily import issues, states, labels, priorities and user data from Jira to Plane and continue managing your existing projects. + +## Import from Jira +> **Role**: Workspace Admins + +To import Jira issues to a Plane project, follow these steps: +1. Click the **∨** icon next to your workspace name on the sidebar and select **Workspace Settings**. +2. Select **Imports** on the right pane. +3. Click the **Import** button on Jira. + ![Import from Jira](https://media.docs.plane.so/importers/jira/import-from-jira.webp) +4. On the **Jira to Plane Migration Assistant** screen, enter the **Personal Access Token**, **User email** and the **Jira domain** to allow Plane access to your Atlassian account. +5. Click the **Connect Jira** button. + ![Connect Jira](https://media.docs.plane.so/importers/jira/connect-jira.webp) +6. **Configure Plane**: + Select the Plane project to which you want to import your Jira data. Click **Next**. + ![Configure Plane](https://media.docs.plane.so/importers/jira/configure-plane.webp) +8. **Configure Jira**: + 1. Select the workspace and the project from where you want to import data in the **Select Jira workspace** and **Select Jira Project** lists. + 2. For **How do you want to record issue types in Plane?**, choose an option to define how issue types in Jira should be imported to your Plane project. + - **Create as a label** - Imports issue types in Jira as [Labels](https://docs.plane.so/core-concepts/projects/run-project#manage-labels) in Plane. + - **Add [ issue_type ] in the title** - Prefixes the issue type to the Issue title in Plane. + *Example*: **[TASK] Blitz with dev team** where **TASK** is an issue type in Jira. + ![Configure Jira](https://media.docs.plane.so/importers/jira/configure-jira.webp) +10. **Import users**: + You can choose one of the following options: + - **Upload CSV**: Click the **Upload CSV** button to import the users to your Plane project. Refer to [Export users from a site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/) to download the CSV file from Jira. *(recommended)* + - **Skip user import** - You can select the **Skip Importing User data** checkbox and manually add users after the import process. + :::warning + If you skip user import, issues and comments added by any user will display the name of the user who performed the migration. The Assignees field will be empty. + ::: + ![Import users](https://media.docs.plane.so/importers/jira/import-users.webp) +10. **Map states**: + 1. Map the **Jira status** to their equivalent **Plane states**. + 2. Select the **Auto create and map the remaining Jira states** checkbox to automatically create and map the missing states from Jira in Plane. + ![Map states](https://media.docs.plane.so/importers/jira/map-states.webp) +11. **Map priorities**: + Map the **Jira priorities** to their equivalent **Plane priorities**. If a match doesn't exist, select **None** in the **Plane priorities** list. + ![Map priorities](https://media.docs.plane.so/importers/jira/map-priorities.webp) +12. **Summary**: + Review the mappings and make any changes, if required by clicking on the **Go Back** button. Click **Confirm** to start migration. + ![Review mappings](https://media.docs.plane.so/importers/jira/review-mappings.webp) +13. The data migration begins and takes a few minutes to complete depending on the number of issues in your Jira workspace. + ![Migration complete](https://media.docs.plane.so/importers/jira/import-complete.webp) +14. Navigate to **Issues** in your project on the sidebar to verify that the data import is successful. + ![Verify import](https://media.docs.plane.so/importers/jira/verify-import.webp) + +## Sync Jira to Plane + +After the import process, if the Jira project has a new or updated issue, you can easily migrate these changes to Plane. Follow the steps below to sync the changes: + +1. Go to the workspace option in Plane. Click **Workspace settings**. +2. Select **Imports** on the right pane. +3. Click the **Re run** button on the project you want to sync. + ![Sync Jira](https://media.docs.plane.so/importers/jira/rerun-import.webp) + +## Imported entities + +The following entities are imported during migration from Jira to Plane: + +| Jira | Plane | Notes| +|--------------| ------------------- |---- | +| Labels | Labels | | +| Status | States | | +| Issue priorities | Priorities | | +| Users | Users | | +| Issues | Issues | | +| Relations | Parent | Includes only parent-child relationships | +| Issue comments | Issue comments |Includes username and timestamp. If you skip user import during migration, comments added by any user will display the name of the user who performed the migration.| +| Issue attachments | Issue attachments | | +| Reporter | Created by | | +| Created | Created at | | +| Assignee | Assignees | If you skip user import during migration, this field will be blank.| +| Issue types | Labels \| Prefix in Issue title | | +| Images in the Issue description | Images in the Issue description | | +| Summary | Issue title | | +| Start date | Start date | | +| Due date | Due date | | +| Linked Issues | Links | Includes backlinks to the original issue in Jira.| +| Sprint | Cycles | Includes the issues, start and end date. | +| Components | Modules | Includes the issues. | \ No newline at end of file From f1bf67bc63aec21e9d546bb1fe495dc1af0d823f Mon Sep 17 00:00:00 2001 From: danciaclara Date: Thu, 28 Nov 2024 21:29:24 +0530 Subject: [PATCH 2/7] minor edits --- docs/plane-importers/jira-imp.mdx | 71 ++++++++++++++++++------------- 1 file changed, 42 insertions(+), 29 deletions(-) diff --git a/docs/plane-importers/jira-imp.mdx b/docs/plane-importers/jira-imp.mdx index cbec95e..1267749 100644 --- a/docs/plane-importers/jira-imp.mdx +++ b/docs/plane-importers/jira-imp.mdx @@ -4,10 +4,6 @@ title: Jira # Import your Jira data to Plane -Integrate seamlessly with Jira and import issues into your Plane projects. - -## Overview - With the Jira importer, you can easily import issues, states, labels, priorities and user data from Jira to Plane and continue managing your existing projects. ## Import from Jira @@ -15,54 +11,61 @@ With the Jira importer, you can easily import issues, states, labels, priorities To import Jira issues to a Plane project, follow these steps: 1. Click the **∨** icon next to your workspace name on the sidebar and select **Workspace Settings**. + 2. Select **Imports** on the right pane. -3. Click the **Import** button on Jira. + +3. Click the **Import** button in the Jira section. ![Import from Jira](https://media.docs.plane.so/importers/jira/import-from-jira.webp) -4. On the **Jira to Plane Migration Assistant** screen, enter the **Personal Access Token**, **User email** and the **Jira domain** to allow Plane access to your Atlassian account. -5. Click the **Connect Jira** button. + +4. In the **Jira to Plane Migration Assistant** screen, enter your **Personal Access Token**, **User email** and the **Jira domain** to allow Plane access to your Atlassian account. + +5. Click the **Connect Jira** button to link the accounts. ![Connect Jira](https://media.docs.plane.so/importers/jira/connect-jira.webp) + 6. **Configure Plane**: - Select the Plane project to which you want to import your Jira data. Click **Next**. - ![Configure Plane](https://media.docs.plane.so/importers/jira/configure-plane.webp) + Select the Plane project where you want to import your Jira data and and click **Next**. + ![Configure Plane](https://media.docs.plane.so/importers/jira/configure-plane.webp) + 8. **Configure Jira**: - 1. Select the workspace and the project from where you want to import data in the **Select Jira workspace** and **Select Jira Project** lists. - 2. For **How do you want to record issue types in Plane?**, choose an option to define how issue types in Jira should be imported to your Plane project. - - **Create as a label** - Imports issue types in Jira as [Labels](https://docs.plane.so/core-concepts/projects/run-project#manage-labels) in Plane. - - **Add [ issue_type ] in the title** - Prefixes the issue type to the Issue title in Plane. - *Example*: **[TASK] Blitz with dev team** where **TASK** is an issue type in Jira. - ![Configure Jira](https://media.docs.plane.so/importers/jira/configure-jira.webp) + 1. Select the workspace and project in Jira from where you want to import data. + 2. Under **How do you want to record issue types in Plane?**, choose an option to define how issue types in Jira should be imported to your Plane project. + - **Create as a label** + Import Jira issue types as [Labels](https://docs.plane.so/core-concepts/projects/run-project#manage-labels) in Plane. + - **Add [ issue_type ] in the title** + Prefix the Jira issue type in the Plane issue title. + *Example*: **[TASK] Blitz with dev team** where **TASK** is the Jira issue type. + ![Configure Jira](https://media.docs.plane.so/importers/jira/configure-jira.webp) + 10. **Import users**: - You can choose one of the following options: - - **Upload CSV**: Click the **Upload CSV** button to import the users to your Plane project. Refer to [Export users from a site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/) to download the CSV file from Jira. *(recommended)* - - **Skip user import** - You can select the **Skip Importing User data** checkbox and manually add users after the import process. + Choose one of the following: + - **Upload CSV** + Click the **Upload CSV** button to import users to your Plane project. Refer to [Export users from a site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/) to download the CSV file from Jira. *(recommended)* + - **Skip user import** + You can select the **Skip Importing User data** checkbox and manually add users later. :::warning - If you skip user import, issues and comments added by any user will display the name of the user who performed the migration. The Assignees field will be empty. + If you skip user import, issues and comments will show the name of the person who performed the migration, and the Assignees field will be empty. ::: ![Import users](https://media.docs.plane.so/importers/jira/import-users.webp) + 10. **Map states**: 1. Map the **Jira status** to their equivalent **Plane states**. 2. Select the **Auto create and map the remaining Jira states** checkbox to automatically create and map the missing states from Jira in Plane. ![Map states](https://media.docs.plane.so/importers/jira/map-states.webp) + 11. **Map priorities**: Map the **Jira priorities** to their equivalent **Plane priorities**. If a match doesn't exist, select **None** in the **Plane priorities** list. ![Map priorities](https://media.docs.plane.so/importers/jira/map-priorities.webp) + 12. **Summary**: Review the mappings and make any changes, if required by clicking on the **Go Back** button. Click **Confirm** to start migration. ![Review mappings](https://media.docs.plane.so/importers/jira/review-mappings.webp) + 13. The data migration begins and takes a few minutes to complete depending on the number of issues in your Jira workspace. ![Migration complete](https://media.docs.plane.so/importers/jira/import-complete.webp) + 14. Navigate to **Issues** in your project on the sidebar to verify that the data import is successful. ![Verify import](https://media.docs.plane.so/importers/jira/verify-import.webp) -## Sync Jira to Plane - -After the import process, if the Jira project has a new or updated issue, you can easily migrate these changes to Plane. Follow the steps below to sync the changes: - -1. Go to the workspace option in Plane. Click **Workspace settings**. -2. Select **Imports** on the right pane. -3. Click the **Re run** button on the project you want to sync. - ![Sync Jira](https://media.docs.plane.so/importers/jira/rerun-import.webp) - ## Imported entities The following entities are imported during migration from Jira to Plane: @@ -87,4 +90,14 @@ The following entities are imported during migration from Jira to Plane: | Due date | Due date | | | Linked Issues | Links | Includes backlinks to the original issue in Jira.| | Sprint | Cycles | Includes the issues, start and end date. | -| Components | Modules | Includes the issues. | \ No newline at end of file +| Components | Modules | Includes the issues. | + +## Sync Jira to Plane + +After the import process, if the Jira project has a new or updated issue, you can easily migrate these changes to Plane. Follow the steps below to sync the changes: + +1. Go to the workspace option in Plane. Click **Workspace settings**. +2. Select **Imports** on the right pane. +3. Click the **Re run** button on the project you want to sync. + ![Sync Jira](https://media.docs.plane.so/importers/jira/rerun-import.webp) + From 9cb55a1f8196bdba804abc1431877d851bbfe7a6 Mon Sep 17 00:00:00 2001 From: danciaclara Date: Wed, 4 Dec 2024 15:34:52 +0530 Subject: [PATCH 3/7] added overview page --- docs/plane-importers/jira-imp.mdx | 30 +++++++++++++++--------------- docs/plane-importers/overview.mdx | 28 ++++++++++++++++++++++++++++ sidebars.ts | 1 + 3 files changed, 44 insertions(+), 15 deletions(-) create mode 100644 docs/plane-importers/overview.mdx diff --git a/docs/plane-importers/jira-imp.mdx b/docs/plane-importers/jira-imp.mdx index 1267749..a9915ed 100644 --- a/docs/plane-importers/jira-imp.mdx +++ b/docs/plane-importers/jira-imp.mdx @@ -7,7 +7,7 @@ title: Jira With the Jira importer, you can easily import issues, states, labels, priorities and user data from Jira to Plane and continue managing your existing projects. ## Import from Jira -> **Role**: Workspace Admins +> **Role**: Workspace admins To import Jira issues to a Plane project, follow these steps: 1. Click the **∨** icon next to your workspace name on the sidebar and select **Workspace Settings**. @@ -27,7 +27,7 @@ To import Jira issues to a Plane project, follow these steps: ![Configure Plane](https://media.docs.plane.so/importers/jira/configure-plane.webp) 8. **Configure Jira**: - 1. Select the workspace and project in Jira from where you want to import data. + 1. Choose the workspace and project in Jira from where you want to import data. 2. Under **How do you want to record issue types in Plane?**, choose an option to define how issue types in Jira should be imported to your Plane project. - **Create as a label** Import Jira issue types as [Labels](https://docs.plane.so/core-concepts/projects/run-project#manage-labels) in Plane. @@ -48,27 +48,27 @@ To import Jira issues to a Plane project, follow these steps: ![Import users](https://media.docs.plane.so/importers/jira/import-users.webp) 10. **Map states**: - 1. Map the **Jira status** to their equivalent **Plane states**. - 2. Select the **Auto create and map the remaining Jira states** checkbox to automatically create and map the missing states from Jira in Plane. + 1. Map **Jira status** to their equivalent **Plane states**. + 2. Select the **Auto create and map the remaining Jira states** checkbox to automatically create and map any missing states. ![Map states](https://media.docs.plane.so/importers/jira/map-states.webp) 11. **Map priorities**: - Map the **Jira priorities** to their equivalent **Plane priorities**. If a match doesn't exist, select **None** in the **Plane priorities** list. + Map the **Jira priorities** to the corresponding **Plane priorities**. If there's no match, select **None** in the **Plane priorities** list. ![Map priorities](https://media.docs.plane.so/importers/jira/map-priorities.webp) 12. **Summary**: - Review the mappings and make any changes, if required by clicking on the **Go Back** button. Click **Confirm** to start migration. + Review the mappings and make any changes if needed. Click **Go Back** to adjust, or click **Confirm** to start the migration. ![Review mappings](https://media.docs.plane.so/importers/jira/review-mappings.webp) 13. The data migration begins and takes a few minutes to complete depending on the number of issues in your Jira workspace. ![Migration complete](https://media.docs.plane.so/importers/jira/import-complete.webp) -14. Navigate to **Issues** in your project on the sidebar to verify that the data import is successful. +14. Once it's done, go to **Issues** in your Plane project to confirm that the data import is successful. ![Verify import](https://media.docs.plane.so/importers/jira/verify-import.webp) ## Imported entities -The following entities are imported during migration from Jira to Plane: +Here’s a quick look at what gets imported during the migration from Jira to Plane: | Jira | Plane | Notes| |--------------| ------------------- |---- | @@ -78,26 +78,26 @@ The following entities are imported during migration from Jira to Plane: | Users | Users | | | Issues | Issues | | | Relations | Parent | Includes only parent-child relationships | -| Issue comments | Issue comments |Includes username and timestamp. If you skip user import during migration, comments added by any user will display the name of the user who performed the migration.| +| Issue comments | Issue comments |Includes username and timestamp. If you skip user import during migration, comments will show the name of the user who performed the migration.| | Issue attachments | Issue attachments | | | Reporter | Created by | | | Created | Created at | | -| Assignee | Assignees | If you skip user import during migration, this field will be blank.| +| Assignee | Assignees | If you skip user import during migration, this will be blank.| | Issue types | Labels \| Prefix in Issue title | | | Images in the Issue description | Images in the Issue description | | | Summary | Issue title | | | Start date | Start date | | | Due date | Due date | | -| Linked Issues | Links | Includes backlinks to the original issue in Jira.| +| Linked Issues | Links | Includes backlinks to the original Jira issue.| | Sprint | Cycles | Includes the issues, start and end date. | | Components | Modules | Includes the issues. | ## Sync Jira to Plane -After the import process, if the Jira project has a new or updated issue, you can easily migrate these changes to Plane. Follow the steps below to sync the changes: +After the import, if there are any new or updated issues in Jira, you can easily sync these changes to Plane: -1. Go to the workspace option in Plane. Click **Workspace settings**. +1. Go to **Workspace settings**. 2. Select **Imports** on the right pane. -3. Click the **Re run** button on the project you want to sync. - ![Sync Jira](https://media.docs.plane.so/importers/jira/rerun-import.webp) +3. Click the **Re run** button next to the project you want to sync. + ![Sync Jira](https://media.docs.plane.so/importers/jira/rerun-import.webp) diff --git a/docs/plane-importers/overview.mdx b/docs/plane-importers/overview.mdx new file mode 100644 index 0000000..8f17c65 --- /dev/null +++ b/docs/plane-importers/overview.mdx @@ -0,0 +1,28 @@ +--- +title: Overview +--- + +import {CardGroup,Card} from '@site/src/components'; + +Plane's importers simplify the process of migrating project data from other tools. Instead of manually recreating your project structure and history, you can transfer existing issues, workflows, and project details directly into Plane. + +Switching tools shouldn’t mean starting over. With Plane importers, you can effortlessly migrate your data, preserving your team’s progress and ensuring a smooth transition. + + + + + Integrate Plane with Github to automatically capture issues from github. We will expand this to support sync of PRs with Plane issues. + + + + Integrate Plane with Github to automatically capture issues from github. We will expand this to support sync of PRs with Plane issues. + + + Integrate Plane with Github to automatically capture issues from github. We will expand this to support sync of PRs with Plane issues. + + + + Integrate Plane with Slack to forward issue updates from plane to github. We will expand this to support creating issues from slack soon. + + + diff --git a/sidebars.ts b/sidebars.ts index 8078edc..dcae6d6 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -131,6 +131,7 @@ const sidebars: SidebarsConfig = { collapsed: false, label: 'Importers', items: [ + 'plane-importers/overview', 'plane-importers/github-imp', 'plane-importers/jira-imp', ], From 5d6fd719ae2171208fcb2c688b47ca70d026714e Mon Sep 17 00:00:00 2001 From: danciaclara Date: Wed, 4 Dec 2024 16:25:47 +0530 Subject: [PATCH 4/7] Added importer cards --- docs/plane-importers/overview.mdx | 12 +++++------- sidebars.ts | 1 - 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/plane-importers/overview.mdx b/docs/plane-importers/overview.mdx index 8f17c65..49cba1a 100644 --- a/docs/plane-importers/overview.mdx +++ b/docs/plane-importers/overview.mdx @@ -10,19 +10,17 @@ Switching tools shouldn’t mean starting over. With Plane importers, you can ef - - Integrate Plane with Github to automatically capture issues from github. We will expand this to support sync of PRs with Plane issues. - - - + } href="/plane-integrations/asana-importer"> Integrate Plane with Github to automatically capture issues from github. We will expand this to support sync of PRs with Plane issues. + Integrate Plane with Github to automatically capture issues from github. We will expand this to support sync of PRs with Plane issues. - - + + } href="/plane-integrations/slack-importer"> Integrate Plane with Slack to forward issue updates from plane to github. We will expand this to support creating issues from slack soon. + diff --git a/sidebars.ts b/sidebars.ts index dcae6d6..5027fed 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -132,7 +132,6 @@ const sidebars: SidebarsConfig = { label: 'Importers', items: [ 'plane-importers/overview', - 'plane-importers/github-imp', 'plane-importers/jira-imp', ], }, From 74cd4f8a0b26a7965aef6e23511ebbbb957e67ea Mon Sep 17 00:00:00 2001 From: danciaclara Date: Mon, 9 Dec 2024 15:02:54 +0530 Subject: [PATCH 5/7] minor fixes --- docs/plane-importers/jira-imp.mdx | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/plane-importers/jira-imp.mdx b/docs/plane-importers/jira-imp.mdx index a9915ed..055d792 100644 --- a/docs/plane-importers/jira-imp.mdx +++ b/docs/plane-importers/jira-imp.mdx @@ -17,12 +17,15 @@ To import Jira issues to a Plane project, follow these steps: 3. Click the **Import** button in the Jira section. ![Import from Jira](https://media.docs.plane.so/importers/jira/import-from-jira.webp) -4. In the **Jira to Plane Migration Assistant** screen, enter your **Personal Access Token**, **User email** and the **Jira domain** to allow Plane access to your Atlassian account. +4. In the **Jira to Plane Migration Assistant** screen, enter your **Personal Access Token**, **User email** and the **Jira domain** to allow Plane access to your Atlassian account. 5. Click the **Connect Jira** button to link the accounts. ![Connect Jira](https://media.docs.plane.so/importers/jira/connect-jira.webp) -6. **Configure Plane**: +6. Click the **Import** button under the **Imports** section. + ![Connect Jira](https://media.docs.plane.so/importers/jira/connect-jira.webp) + +7. **Configure Plane**: Select the Plane project where you want to import your Jira data and and click **Next**. ![Configure Plane](https://media.docs.plane.so/importers/jira/configure-plane.webp) From 77d6ca25c776286adb1e11a6266b3b800630724a Mon Sep 17 00:00:00 2001 From: danciaclara Date: Tue, 10 Dec 2024 17:42:08 +0530 Subject: [PATCH 6/7] Added images --- docs/plane-importers/jira-imp.mdx | 58 ++++++++++++++----------------- 1 file changed, 26 insertions(+), 32 deletions(-) diff --git a/docs/plane-importers/jira-imp.mdx b/docs/plane-importers/jira-imp.mdx index 055d792..3dc89d2 100644 --- a/docs/plane-importers/jira-imp.mdx +++ b/docs/plane-importers/jira-imp.mdx @@ -12,34 +12,29 @@ With the Jira importer, you can easily import issues, states, labels, priorities To import Jira issues to a Plane project, follow these steps: 1. Click the **∨** icon next to your workspace name on the sidebar and select **Workspace Settings**. -2. Select **Imports** on the right pane. - -3. Click the **Import** button in the Jira section. - ![Import from Jira](https://media.docs.plane.so/importers/jira/import-from-jira.webp) +2. Select **Imports** on the right pane and click the **Import** button in the Jira section. + ![Import from Jira](https://media.docs.plane.so/importers/jira/import-jira.webp#center) 4. In the **Jira to Plane Migration Assistant** screen, enter your **Personal Access Token**, **User email** and the **Jira domain** to allow Plane access to your Atlassian account. 5. Click the **Connect Jira** button to link the accounts. - ![Connect Jira](https://media.docs.plane.so/importers/jira/connect-jira.webp) -6. Click the **Import** button under the **Imports** section. - ![Connect Jira](https://media.docs.plane.so/importers/jira/connect-jira.webp) +6. Click the **Import** button. + ![Connect Jira](https://media.docs.plane.so/importers/jira/import-jira-data.webp#center) -7. **Configure Plane**: +7. **Configure Plane** Select the Plane project where you want to import your Jira data and and click **Next**. - ![Configure Plane](https://media.docs.plane.so/importers/jira/configure-plane.webp) - -8. **Configure Jira**: - 1. Choose the workspace and project in Jira from where you want to import data. - 2. Under **How do you want to record issue types in Plane?**, choose an option to define how issue types in Jira should be imported to your Plane project. - - **Create as a label** - Import Jira issue types as [Labels](https://docs.plane.so/core-concepts/projects/run-project#manage-labels) in Plane. - - **Add [ issue_type ] in the title** - Prefix the Jira issue type in the Plane issue title. - *Example*: **[TASK] Blitz with dev team** where **TASK** is the Jira issue type. - ![Configure Jira](https://media.docs.plane.so/importers/jira/configure-jira.webp) - -10. **Import users**: + ![Configure Plane](https://media.docs.plane.so/importers/jira/configure-plane.webp#center) + +8. **Configure Jira** + Choose the workspace and project in Jira from where you want to import data. + ![Configure Jira](https://media.docs.plane.so/importers/jira/configure-jira.webp#center) + + :::info[Issue types] + If you're on a paid plan (Pro or higher), issue types in Jira will be imported as issue types in Plane. On the free plan, issue types from Jira won't be imported. + ::: + +10. **Import users** Choose one of the following: - **Upload CSV** Click the **Upload CSV** button to import users to your Plane project. Refer to [Export users from a site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/) to download the CSV file from Jira. *(recommended)* @@ -48,26 +43,25 @@ To import Jira issues to a Plane project, follow these steps: :::warning If you skip user import, issues and comments will show the name of the person who performed the migration, and the Assignees field will be empty. ::: - ![Import users](https://media.docs.plane.so/importers/jira/import-users.webp) + ![Import users](https://media.docs.plane.so/importers/jira/import-users.webp#center) -10. **Map states**: +10. **Map states** 1. Map **Jira status** to their equivalent **Plane states**. 2. Select the **Auto create and map the remaining Jira states** checkbox to automatically create and map any missing states. - ![Map states](https://media.docs.plane.so/importers/jira/map-states.webp) + ![Map states](https://media.docs.plane.so/importers/jira/map-states.webp#center) -11. **Map priorities**: +11. **Map priorities** Map the **Jira priorities** to the corresponding **Plane priorities**. If there's no match, select **None** in the **Plane priorities** list. - ![Map priorities](https://media.docs.plane.so/importers/jira/map-priorities.webp) + ![Map priorities](https://media.docs.plane.so/importers/jira/map-priorities.webp#center) -12. **Summary**: - Review the mappings and make any changes if needed. Click **Go Back** to adjust, or click **Confirm** to start the migration. - ![Review mappings](https://media.docs.plane.so/importers/jira/review-mappings.webp) +12. **Summary** + Review the mappings and make any changes if needed. Click **Back** to adjust, or click **Confirm** to start the migration. + ![Review mappings](https://media.docs.plane.so/importers/jira/import-summary.webp#center) 13. The data migration begins and takes a few minutes to complete depending on the number of issues in your Jira workspace. - ![Migration complete](https://media.docs.plane.so/importers/jira/import-complete.webp) + ![Migration complete](https://media.docs.plane.so/importers/jira/import-complete.webp#center) 14. Once it's done, go to **Issues** in your Plane project to confirm that the data import is successful. - ![Verify import](https://media.docs.plane.so/importers/jira/verify-import.webp) ## Imported entities @@ -102,5 +96,5 @@ After the import, if there are any new or updated issues in Jira, you can easily 1. Go to **Workspace settings**. 2. Select **Imports** on the right pane. 3. Click the **Re run** button next to the project you want to sync. - ![Sync Jira](https://media.docs.plane.so/importers/jira/rerun-import.webp) + ![Sync Jira](https://media.docs.plane.so/importers/jira/sync-jira.webp#center) From 079b7edbd290378504a2b5c5267e85b0b9f15b79 Mon Sep 17 00:00:00 2001 From: danciaclara Date: Wed, 29 Jan 2025 18:23:22 +0530 Subject: [PATCH 7/7] final --- docs/importers/jira-imp.mdx | 100 ++++++++++++++++++++++++++++++++++-- sidebars.ts | 3 +- 2 files changed, 98 insertions(+), 5 deletions(-) diff --git a/docs/importers/jira-imp.mdx b/docs/importers/jira-imp.mdx index dbebb25..3dc89d2 100644 --- a/docs/importers/jira-imp.mdx +++ b/docs/importers/jira-imp.mdx @@ -1,6 +1,100 @@ --- -title: Jira Importer -sidebarTitle: Jira +title: Jira --- -Coming very soon. + +# Import your Jira data to Plane + +With the Jira importer, you can easily import issues, states, labels, priorities and user data from Jira to Plane and continue managing your existing projects. + +## Import from Jira +> **Role**: Workspace admins + +To import Jira issues to a Plane project, follow these steps: +1. Click the **∨** icon next to your workspace name on the sidebar and select **Workspace Settings**. + +2. Select **Imports** on the right pane and click the **Import** button in the Jira section. + ![Import from Jira](https://media.docs.plane.so/importers/jira/import-jira.webp#center) + +4. In the **Jira to Plane Migration Assistant** screen, enter your **Personal Access Token**, **User email** and the **Jira domain** to allow Plane access to your Atlassian account. + +5. Click the **Connect Jira** button to link the accounts. + +6. Click the **Import** button. + ![Connect Jira](https://media.docs.plane.so/importers/jira/import-jira-data.webp#center) + +7. **Configure Plane** + Select the Plane project where you want to import your Jira data and and click **Next**. + ![Configure Plane](https://media.docs.plane.so/importers/jira/configure-plane.webp#center) + +8. **Configure Jira** + Choose the workspace and project in Jira from where you want to import data. + ![Configure Jira](https://media.docs.plane.so/importers/jira/configure-jira.webp#center) + + :::info[Issue types] + If you're on a paid plan (Pro or higher), issue types in Jira will be imported as issue types in Plane. On the free plan, issue types from Jira won't be imported. + ::: + +10. **Import users** + Choose one of the following: + - **Upload CSV** + Click the **Upload CSV** button to import users to your Plane project. Refer to [Export users from a site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/) to download the CSV file from Jira. *(recommended)* + - **Skip user import** + You can select the **Skip Importing User data** checkbox and manually add users later. + :::warning + If you skip user import, issues and comments will show the name of the person who performed the migration, and the Assignees field will be empty. + ::: + ![Import users](https://media.docs.plane.so/importers/jira/import-users.webp#center) + +10. **Map states** + 1. Map **Jira status** to their equivalent **Plane states**. + 2. Select the **Auto create and map the remaining Jira states** checkbox to automatically create and map any missing states. + ![Map states](https://media.docs.plane.so/importers/jira/map-states.webp#center) + +11. **Map priorities** + Map the **Jira priorities** to the corresponding **Plane priorities**. If there's no match, select **None** in the **Plane priorities** list. + ![Map priorities](https://media.docs.plane.so/importers/jira/map-priorities.webp#center) + +12. **Summary** + Review the mappings and make any changes if needed. Click **Back** to adjust, or click **Confirm** to start the migration. + ![Review mappings](https://media.docs.plane.so/importers/jira/import-summary.webp#center) + +13. The data migration begins and takes a few minutes to complete depending on the number of issues in your Jira workspace. + ![Migration complete](https://media.docs.plane.so/importers/jira/import-complete.webp#center) + +14. Once it's done, go to **Issues** in your Plane project to confirm that the data import is successful. + +## Imported entities + +Here’s a quick look at what gets imported during the migration from Jira to Plane: + +| Jira | Plane | Notes| +|--------------| ------------------- |---- | +| Labels | Labels | | +| Status | States | | +| Issue priorities | Priorities | | +| Users | Users | | +| Issues | Issues | | +| Relations | Parent | Includes only parent-child relationships | +| Issue comments | Issue comments |Includes username and timestamp. If you skip user import during migration, comments will show the name of the user who performed the migration.| +| Issue attachments | Issue attachments | | +| Reporter | Created by | | +| Created | Created at | | +| Assignee | Assignees | If you skip user import during migration, this will be blank.| +| Issue types | Labels \| Prefix in Issue title | | +| Images in the Issue description | Images in the Issue description | | +| Summary | Issue title | | +| Start date | Start date | | +| Due date | Due date | | +| Linked Issues | Links | Includes backlinks to the original Jira issue.| +| Sprint | Cycles | Includes the issues, start and end date. | +| Components | Modules | Includes the issues. | + +## Sync Jira to Plane + +After the import, if there are any new or updated issues in Jira, you can easily sync these changes to Plane: + +1. Go to **Workspace settings**. +2. Select **Imports** on the right pane. +3. Click the **Re run** button next to the project you want to sync. + ![Sync Jira](https://media.docs.plane.so/importers/jira/sync-jira.webp#center) diff --git a/sidebars.ts b/sidebars.ts index b2c5c84..13aec4e 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -147,8 +147,7 @@ const sidebars: SidebarsConfig = { collapsed: true, label: 'Importers', items: [ - 'plane-importers/overview', - 'plane-importers/jira-imp', + 'importers/jira-imp', ], }, {