PORTN-3059 Add new guide for mapping Jira users to Port accounts

[kodjomiles]

Description

Added new guide to map jira users to port user account

Added docs pages

Please also include the path for the added docs

• Map Jira users to Port user accounts(/guides/all/map-jira-users-to-port-accounts)

[notion-workspace]

Create a guide to map Jira user to a Port user

[aws-amplify-eu-west-1]

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-2576.d2ngvl90zqbob8.amplifyapp.com

[claude]

Claude finished @kodjomiles's task —— View job

---

PR Review Complete ✅

Reviewing PR #2576: PORTN-3059 Add new guide for mapping Jira users to Port accounts

Todo List:

• Read CONTRIBUTING.md to understand review standards
• Review the new guide file: docs/guides/all/map-jira-users-to-port-accounts.md
• Review the modified configuration file: src/components/guides-section/consts.js
• Provide comprehensive review feedback
• Final review summary

---

Overall Assessment

This PR successfully adds a comprehensive guide for mapping Jira users to Port accounts. The implementation is well-structured and follows most of the repository's conventions.

Detailed Review

✅ Strengths

Content Quality:

• Clear, step-by-step instructions that follow the "We" language guideline
• Comprehensive prerequisites section
• Good use of expandable code blocks with descriptive titles
• Practical testing section at the end
• Well-structured automation example

Technical Implementation:

• Correct file placement in docs/guides/all/
• Proper addition to the guides configuration in src/components/guides-section/consts.js
• Appropriate tags and logos for discoverability
• Valid YAML and JSON code examples

Documentation Standards:

• Uses showLineNumbers for multi-line code blocks ✅
• Proper use of admonitions (info block) ✅
• Consistent formatting and structure ✅
• Good use of expandable details sections ✅

🔍 Issues to Address

1. Header Formatting (Line 27)

<h3> Enhance the Port User blueprint</h3>

Issue: Extra space after opening tag
Fix: Should be <h3>Enhance the Port User blueprint</h3>

2. Grammar Issue (Line 13)

which Jira users have Port accounts and which one do not.

Issue: Subject-verb disagreement
Fix: Should be "which ones do not" (plural)

3. Code Block Consistency

• Most code blocks properly use showLineNumbers ✅
• All multi-line code blocks follow the guideline ✅

4. Link Formatting

• All internal links use full paths ✅
• Links are descriptive and clear ✅

📋 Minor Suggestions

1. Enhance Prerequisites
Consider adding a note about required permissions for creating automations, as this affects the automation setup section.

2. Testing Section Enhancement
The testing section could benefit from more specific steps, such as:

• How to verify the relationship was established correctly
• What to do if the mapping doesn't work as expected

🎯 Configuration Review

The changes to src/components/guides-section/consts.js are correct and properly integrated:

• Added to line 1345-1350 with appropriate metadata
• Correct tags: ["Jira", "Automations"] ✅
• Appropriate logos: ["Jira"] ✅
• Proper link format ✅

Compliance with CONTRIBUTING.md

Guideline	Status	Notes
Header capitalization	✅	Proper sentence case used
"We" language in guides	✅	Consistently uses inclusive language
Code block line numbers	✅	All multi-line blocks include showLineNumbers
Full path links	✅	All links use absolute paths
Expandable sections	✅	Good use of details/summary blocks
Technical accuracy	✅	Code examples appear functional
Clear structure	✅	Logical flow from setup to testing

Recommendation

Approve with minor fixes - This is a high-quality guide that follows the repository's standards well. The issues identified are minor and easily resolved:

1. Fix the header spacing on line 27
2. Correct the grammar on line 13
3. Consider the enhancement suggestions for robustness

The guide provides valuable content for users wanting to integrate Jira users with Port accounts and follows the established patterns in the documentation.

---

[claude]

Claude finished @kodjomiles's task —— View job

---

PR Review Complete ✅

Reviewing PR #2576: PORTN-3059 Add new guide for mapping Jira users to Port accounts

Todo List:

• Read CONTRIBUTING.md to understand review standards
• Review the new guide file: docs/guides/all/map-jira-users-to-port-accounts.md
• Review the modified configuration file: src/components/guides-section/consts.js
• Provide comprehensive review feedback
• Final review summary

---

Overall Assessment

This PR successfully adds a comprehensive guide for mapping Jira users to Port accounts. The implementation is well-structured and follows most of the repository's conventions.

Detailed Review

✅ Strengths

Content Quality:

• Clear, step-by-step instructions that follow the "We" language guideline
• Comprehensive prerequisites section
• Good use of expandable code blocks with descriptive titles
• Practical testing section at the end
• Well-structured automation example

Technical Implementation:

• Correct file placement in docs/guides/all/
• Proper addition to the guides configuration in src/components/guides-section/consts.js
• Appropriate tags and logos for discoverability
• Valid YAML and JSON code examples

Documentation Standards:

• Uses showLineNumbers for multi-line code blocks ✅
• Proper use of admonitions (info block) ✅
• Consistent formatting and structure ✅
• Good use of expandable details sections ✅

🔍 Issues to Address

1. Header Formatting (Line 27)

<h3> Enhance the Port User blueprint</h3>

Issue: Extra space after opening tag
Fix: Should be <h3>Enhance the Port User blueprint</h3>

2. Grammar Issue (Line 13)

which Jira users have Port accounts and which one do not.

Issue: Subject-verb disagreement
Fix: Should be "which ones do not" (plural)

3. Code Block Consistency

• Most code blocks properly use showLineNumbers ✅
• All multi-line code blocks follow the guideline ✅

4. Link Formatting

• All internal links use full paths ✅
• Links are descriptive and clear ✅

📋 Minor Suggestions

1. Enhance Prerequisites
Consider adding a note about required permissions for creating automations, as this affects the automation setup section.

2. Testing Section Enhancement
The testing section could benefit from more specific steps, such as:

• How to verify the relationship was established correctly
• What to do if the mapping doesn't work as expected

🎯 Configuration Review

The changes to src/components/guides-section/consts.js are correct and properly integrated:

• Added to line 1345-1350 with appropriate metadata
• Correct tags: ["Jira", "Automations"] ✅
• Appropriate logos: ["Jira"] ✅
• Proper link format ✅

Compliance with CONTRIBUTING.md

Guideline	Status	Notes
Header capitalization	✅	Proper sentence case used
"We" language in guides	✅	Consistently uses inclusive language
Code block line numbers	✅	All multi-line blocks include showLineNumbers
Full path links	✅	All links use absolute paths
Expandable sections	✅	Good use of details/summary blocks
Technical accuracy	✅	Code examples appear functional
Clear structure	✅	Logical flow from setup to testing

Recommendation

Approve with minor fixes - This is a high-quality guide that follows the repository's standards well. The issues identified are minor and easily resolved:

1. Fix the header spacing on line 27
2. Correct the grammar on line 13
3. Consider the enhancement suggestions for robustness

The guide provides valuable content for users wanting to integrate Jira users with Port accounts and follows the established patterns in the documentation.

---