GitHub Ocean examples for team, user, issues, and folder

[melodyogonna]

Description

This continues the documentation for the new Github integration powered by Ocean, these are examples for teams, users, issues, and folders.

Updated docs pages

Please also include the path for the updated docs

• Examples (/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/)

[claude]

Claude finished @melodyogonna's task —— View job

---

PR Review: GitHub Ocean examples for team, user, issues, and folder

Todo List:

• Read CONTRIBUTING.md guidelines
• Review main examples.md changes
• Review new example files for issues
• Review new example files for teams and users
• Review new example files for folders/monorepo
• Review new example files for repository collaborators
• Check existing file modifications for consistency
• Address sivanel97's review comments
• Provide final assessment and recommendations

---

Review Summary

This PR successfully adds comprehensive documentation for GitHub Ocean examples covering teams, users, issues, and folders. The changes are well-structured and follow most of the documentation guidelines established in CONTRIBUTING.md.

✅ Strengths

1. Comprehensive Coverage: The PR adds examples for several important GitHub resources (issues, teams, users, folders, collaborators)
2. Consistent Structure: New examples follow the established pattern of blueprint + config files
3. Proper Code Formatting: All code blocks use showLineNumbers as required
4. Collapsible Sections: Proper use of <details> and <summary> elements for better organization
5. Clear Relationships: Well-defined relations between entities (e.g., issues to repositories, teams to members)

⚠️ Issues Found

Critical Issues

1. Inconsistent Summary Formatting - sivanel97's review comments are valid. Several files have inconsistent summary text formats:

   • Some use "blueprint" vs "Blueprint" inconsistencies
   • Missing "click to expand" text in some summaries
   • Inconsistent capitalization patterns

2. Formatting Inconsistencies in examples.md:

   • docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md:129 - Line break should be "In the following example you will ingest..." for consistency
   • docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/examples.md:191 - Should be "The following shows how you can map..." for consistency

3. YAML vs YML Extension Inconsistency:

   • docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-team-members/_github_team_member_port_app_config.mdx:2 shows "port-app-config.yaml" but should be "port-app-config.yml" for consistency

Minor Issues

4. Title Casing Issues:

   • docs/build-your-software-catalog/sync-data-to-catalog/git/github-ocean/examples/example-repository-admins/_github_exporter_example_users_blueprint.mdx:7 - Title should be "User" not "user" (capitalize first letter)

5. Missing Content in Monorepo Config:

   • The monorepo example config file appears to be incomplete - it doesn't include the full resources: wrapper structure like other examples

🔧 Specific Fixes Needed

Based on sivanel97's review comments, the following files need summary formatting fixes:

1. example-issue/_git_exporter_example_issue_blueprint.mdx - Update to: <summary><b>Issue blueprint (click to expand)</b></summary>
2. example-issue/_github_exporter_example_issue_port_app_config.mdx - Update to: <summary><b>Port port-app-config.yml (click to expand)</b></summary>
3. example-monorepo/_github_exporter_example_monorepo_port_app_config.mdx - Update to: <summary><b>Port port-app-config.yml (click to expand)</b></summary>
4. All other files mentioned in sivanel97's comments need similar fixes

📋 Recommendations

1. Apply sivanel97's Suggestions: All the formatting suggestions are valid and should be implemented to ensure consistency
2. Standardize Summary Format: Use the pattern <summary><b>[Entity type] blueprint (click to expand)</b></summary> or <summary><b>Port port-app-config.yml (click to expand)</b></summary>
3. Review Title Casing: Ensure all blueprint titles follow the capitalization guidelines
4. Complete Monorepo Example: The monorepo config appears incomplete - verify it includes all necessary configuration structure

Overall Assessment

Rating: Approve with Changes Required

The PR provides valuable documentation additions that will help users understand GitHub Ocean integration capabilities. The content is technically accurate and well-organized. However, the formatting inconsistencies identified by sivanel97 should be addressed before merging to maintain documentation quality standards.

The changes align well with Port's documentation style and provide practical, usable examples for developers.

---

[matan84]

left a few comments

[matan84]

?

[melodyogonna]

@matan84 Do you have a specific problem? I've changed it to ingest the name rather than all properties.