Documentation Checklist for Jira

Explore our comprehensive documentation for detailed instructions, best practices, and troubleshooting tips for using our plugins. Find everything you need to get started and make the most of our features.

Please note that actions such as creating, editing, or deleting tasks will also reflect in Google Tasks. Google Drive is used exclusively for attaching files.

Our plugin integrates with Google Tasks and Google Drive to enhance functionality. Using OAuth2, the plugin allows users to create, edit, and delete Google task lists and tasks directly from Jira. We use task list IDs to synchronize tasks with Jira and access file metadata, such as file names and URLs for attachments. Both the task list IDs and file URLs are stored on Atlassian's systems. We do not store any other data from Google Tasks or Google Drive, and we do not send this data to any third parties.

Data Access and Sharing

We access Google API data only as necessary to provide the functionality of the plugin, including task list IDs and file metadata. We do not access, store, or share any other Google user data beyond what is needed for the integration. All interactions with Google APIs comply with Google’s API policies, OAuth2 standards, and Atlassian's security practices. Data is securely handled and stored on Atlassian's systems, ensuring compliance with relevant data protection and privacy regulations.

1. Install

  • Install the plugin

  • Go to the issue page

    Issue page.
  • Find the "Checklist" plugin button.

    Speech to Text plugin button.
  • Please note that the button may be in a drop-down menu

    Speech to Text plugin button in a drop-down menu.
  • Click on the button

  • The plugin should appear above the "activity" section

    Plugin.
  • If you do not see the plugin content, then click on the expand button

    Expand button.

2. Grant Permissions

  • To work with the plugin, you need to provide access to your Google Tasks and Google Drive data. To do this, please click the "Configure access" button.

    Configure access.
  • You will be redirected to a Google authorization page where you will see two screens:

    • Screen 1: Permissions Request

      • Google-Screen - Permissions Request.
      • Overview: The screen will display a message indicating that "Checklist & Attachments with Google Tasks & Drive for Jira" is requesting access to your Google account.
      • Details: The plugin requires access to your Google account to connect to Jira on id.atlassian.com. You will be redirected to an external site to configure access with Google. Carefully check the domain name to ensure you are on the correct site: https://accounts.google.com/o/oauth2/v2/auth.
      • Actions: By allowing access, the app will be able to perform the following actions on your account:
      • Read metadata from Google Drive: https://www.googleapis.com/auth/drive.metadata.readonly - See details on how we handle this data in our privacy policy.
      • Access Google Tasks: https://www.googleapis.com/auth/tasks - See details on how we handle this data in our privacy policy.
      • Access your email address: https://www.googleapis.com/auth/userinfo.email - See details on how we handle this data in our privacy policy.
      • Access your profile information: profile - See details on how we handle this data in our privacy policy.
      • Continue: Click "Continue" to proceed to the external site and provide the app with the necessary access.
    • Authorization Confirmation

      • Google-Screen - Permissions Request.
      • Overview: This screen will show the following information:
        • Google Drive Access: The app will be able to see information about your Google Drive files.
        • Google Tasks Access: The app will be able to create, edit, organize, and delete all your tasks.
      • Read and Review: Carefully read the information about the risks and [privacy policy] provided on this screen. Ensure you are comfortable with the data handling practices before proceeding.
      • Proceed: If you agree with the terms, click "Allow" to grant the requested permissions.
  • After completing the authorization process, you will be redirected back to the plugin. You should now have access to your Google Tasks and Google Drive data within the plugin.

3. Tasklist Tab

  • To start using the tasklist feature, you need to attach a tasklist to an issue.

  • Attach Tasklist: Click the "Attach Tasklist" button or navigate to the "Tasklist" tab to begin the process of attaching a tasklist to your Jira issue.

    Google tasks empty screen.
  • You should see the following screen:

    Tasklist screen.
  • Generate Title for Tasklist: You can generate a title for your tasklist by clicking the "Generate Title for Tasklist" button. This will help you name your tasklist appropriately.

  • Create New Tasklist: Click the "Create" button to create a new tasklist. Note that this will create a tasklist both in Jira and in Google Tasks.

    Tasklist screen.
  • Dropdown Menu: Click on the dropdown menu labeled "Tasklist".

  • View Tasklists: You will see a list of all your tasklists. Select the desired tasklist from the list to proceed with managing or viewing tasks.

    Tasklist screen - dropdown tasklists.
  • Attach to Tasks Tab: After selecting a tasklist, click the "Attach to Tasks Tab" button. This will attach the selected tasklist to the Tasks tab of your Jira issue, allowing you to view and manage the tasks within Jira.

    Tasklist screen - attach the tasklist.

3. Tasks Tab

  • Navigate to Tasks Tab: Click on the "Tasks" tab within your Jira issue.
  • Verify Attachment: You should see the title of the attached tasklist displayed. This confirms that the tasklist has been successfully linked to your Jira issue and is now visible in the Tasks tab. Tasks screen.
  1. Create a New Task:

    • Add Title: In the "Add a task" input field, enter a title for your new task.
    • Create Task: Click the "Create" button to add the task to your tasklist. Create new task.
  2. Update Task Details:

    • Edit Details: Click on the "details" input field of the task you want to update. Modify the text as needed to update the task details. Edit task details.
  3. Add Due Date:

    • Select Due Date: Click on the calendar icon next to the task. Choose the desired due date from the calendar to set a deadline for your task. Add due date.
  4. Add Subtask:

    • Add Subtask: Click the "..." button on the task to open the dropdown menu. Select "Add a subtask" to create and add a subtask under the main task. Add subtask.
  5. Attach File:

    • Open File Menu: Click the "..." button on the task to open the dropdown menu.
    • Select Attach File: Choose "Attach File" from the dropdown menu.
    • Attach File: Select the file you wish to attach from your device and click the "+" button to attach it. Attach file.Attached files.