Skip to content
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

Enable Jira Data Center integration doc migrated #235

Merged

Conversation

Hikkigaya
Copy link
Collaborator

@Hikkigaya Hikkigaya commented Jun 16, 2024

Enable Jira Data Center integration doc migrated along with images, nav updated

Summary

Enable Jira Data Center integration doc migrated along with images, nav updated
Preview link: http://10.2.7.208/integrations/jira/enable-jira-data-center-integration

Related PRs, issues, or features (optional)

  • 234

Metadata

  • Adds new file(s)
  • Edits existing file(s)
  • Removes file(s)

PR contributor checklist

@Hikkigaya Hikkigaya linked an issue Jun 16, 2024 that may be closed by this pull request
Copy link
Collaborator

@tungmhoang tungmhoang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Hikkigaya one comment.

@tungmhoang tungmhoang marked this pull request as ready for review June 20, 2024 08:31
Copy link
Collaborator

@tungmhoang tungmhoang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Hikkigaya please input the reference to the new Jira Data Center page to integrations/jira/index.adoc.

@tungmhoang
Copy link
Collaborator

Copy link
Contributor

@erincbailey erincbailey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see my comments in new docs. Also - this feature impacts several other pages. Please review the below comments:
https://docs.kobiton.com/integrations/jira/

  • Change page title Enable Jira integration to Enable Jira Cloud integration
  • Change “session overview” to “Session Explorer” - do not put a link. It can be done from both overview and explorer right now. Plus, this will be changing with the Session Explorer redesign - so keep it simple here for now.
  • Add the new page "Enable Jira Data Center integration" with a link as the second bullet under "In this section"

Left hand Nav:

  • Change Enable Jira integration to Enable Jira Cloud integration

https://docs.kobiton.com/integrations/jira/enable-jira-integration

  • Change title to Enable Jira Cloud integration
  • Change first sentence “Learn how to enable Jira Cloud”
  • In the Note - is that Kobiton account owners or Jira account owners or both? Please clarify
  • Need new screenshot at the bottom that shows there are two options. Show Jira Cloud selected. Add verbiage about selecting the Jira Cloud tab as is done in the new Jira Data Center page.

/integrations/jira/create-a-jira-ticket

  • Change link for “Jira has been enabled for your organization to the overview since there are two options now - https://docs.kobiton.com/integrations/jira/
  • The Jira ticket button is in both Session Overview and Session Explorer. So, update the line to say: “From Session Overview or Session Explorer, select Jira ticket > Create.”
  • After “Fill out the Project, Issue Type, and Title.” add “A link to the session and other session details are prepopulated in the Description."

http://10.2.7.208/session-explorer/manage-sessions#_create_a_jira_ticket

  • Jira Ticket should be lowercase ticket
  • Link “Jira ticket” to /integrations/jira/create-a-jira-ticket

@Hikkigaya
Copy link
Collaborator Author

Hikkigaya commented Jun 21, 2024

The following have also been addressed:

Please see my comments in new docs. Also - this feature impacts several other pages. Please review the below comments:
https://docs.kobiton.com/integrations/jira/

  • Change page title Enable Jira integration to Enable Jira Cloud integration
  • Change “session overview” to “Session Explorer” - do not put a link. It can be done from both overview and explorer right now. Plus, this will be changing with the Session Explorer redesign - so keep it simple here for now.
  • Add the new page "Enable Jira Data Center integration" with a link as the second bullet under "In this section"

Left hand Nav:

  • Change Enable Jira integration to Enable Jira Cloud integration

https://docs.kobiton.com/integrations/jira/enable-jira-integration

  • Change title to Enable Jira Cloud integration
  • Change first sentence “Learn how to enable Jira Cloud”

/integrations/jira/create-a-jira-ticket

  • The Jira ticket button is in both Session Overview and Session Explorer. So, update the line to say: “From Session Overview or Session Explorer, select Jira ticket > Create.”
  • After “Fill out the Project, Issue Type, and Title.” add “A link to the session and other session details are prepopulated in the Description."

http://10.2.7.208/session-explorer/manage-sessions#_create_a_jira_ticket

  • Jira Ticket should be lowercase ticket
  • Link “Jira ticket” to /integrations/jira/create-a-jira-ticket

@Hikkigaya
Copy link
Collaborator Author

Hikkigaya commented Jun 27, 2024

@erincbailey @tungmhoang The following 3 changes require input from Tung:

https://docs.kobiton.com/integrations/jira/enable-jira-integration

  • In the Note - is that Kobiton account owners or Jira account owners or both? Please clarify
  • Need new screenshot at the bottom that shows there are two options. Show Jira Cloud selected. Add verbiage about selecting the Jira Cloud tab as is done in the new Jira Data Center page.

/integrations/jira/create-a-jira-ticket

In addition to the above, there are two separate comments, I've just tagged Tung in those comments as well.

@tungmhoang
Copy link
Collaborator

@erincbailey All comments have been addressed. Preview link: http://10.2.7.208/integrations/jira/

Copy link
Contributor

@erincbailey erincbailey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple questions/comments.

@tungmhoang
Copy link
Collaborator

@erincbailey all feedbacks addressed.

@tungmhoang
Copy link
Collaborator

Since Erin is OOO, can you help to review instead @frankwmoyer ?

Copy link
Contributor

@erincbailey erincbailey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@tungmhoang tungmhoang merged commit 2ad18af into main Jul 9, 2024
1 check passed
@tungmhoang tungmhoang deleted the 234-add-user-guide-to-enable-jira-data-center-integration branch July 9, 2024 03:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add user guide to enable Jira Data Center integration
3 participants