Add GitHub Enterprise setup instructions

[vim-zz]

✨ PR Description

Purpose: Add GitHub Enterprise setup instructions for offline runner environments requiring manual action cloning.
Main changes:

• Added new section "GitHub Enterprise Setup" with offline runner instructions
• Added clarification on manually cloning gitstream-github-action and official GitHub actions
• Improved document formatting with additional line breaks for readability

Generated by LinearB AI and added by gitStream.
_{AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀}

[orca-security-us]

Orca Security Scan Summary

Status	Check	Issues by priority
Passed	Infrastructure as Code	0   0   0   0	View in Orca
Passed	SAST	0   0   0   0	View in Orca
Passed	Secrets	0   0   0   0	View in Orca
Passed	Vulnerabilities	0   0   0   0	View in Orca

[gitstream-cm]

✨ PR Review

LGTM

Generated by LinearB AI and added by gitStream.
_{AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀}

Review dismissed

[claude]

PR Review: Add GitHub Enterprise Setup Instructions

Thank you for adding the GitHub Enterprise setup instructions! This is a valuable addition to the documentation. Here's my comprehensive review:

✅ Positives

1. Addresses Important Use Case: GitHub Enterprise users often struggle with action availability, making this documentation essential.
2. Proper Placement: Section 12 placement logically follows the main setup flow.
3. Clear Structure: The numbered list format is consistent with the rest of the document.
4. Maintains Documentation Style: Follows MkDocs/Material theme conventions used throughout the repository.

📝 Areas for Improvement

Documentation Enhancement

1. Expand Technical Details: The current instructions are quite brief. Consider adding:

   • Specific steps on HOW to manually clone GitHub Actions
   • Directory structure for storing these actions
   • Version considerations and update procedures
   • Alternative solutions (e.g., GitHub Enterprise Server with internet access)

2. Add Context and Prerequisites:

   ## 12. GitHub Enterprise Setup
   
   **Prerequisites:**
   - GitHub Enterprise Server with restricted internet access
   - Administrative access to clone actions into the enterprise environment
   
   When running gitStream on GitHub Enterprise Server with restricted internet access, you need to manually "clone" the following actions since runners dont connect to the internet:

3. Provide More Actionable Instructions:

   ### Required Actions to Clone:
   
   1. **gitStream action**: linear-b/gitstream-github-action@v2
      - Clone from: https://github.com/linear-b/gitstream-github-action
      - Required version: v2 or later
   
   2. **Official GitHub actions**:
      - actions/checkout@v3
      - actions/setup-node@v3 
      - actions/github-script@v6
   
   ### Steps to Clone Actions:
   1. Contact your GitHub Enterprise administrator
   2. Request the above actions to be added to your enterprise approved actions
   3. Verify actions are available in your organizations action marketplace

Code Quality Observations

• Formatting: The added blank lines are appropriate and improve readability
• Consistency: Follows the existing document structure and numbering
• Integration: Seamlessly integrates with existing content

🔒 Security Considerations

• Action Security: When manually cloning actions, ensure version pinning for security
• Supply Chain: Recommend documenting the verification process for cloned actions
• Access Control: Consider mentioning enterprise-specific access controls

🚀 Performance Considerations

• Minimal Impact: This is documentation-only, no performance implications
• User Experience: Clear instructions will reduce support overhead

🧪 Test Coverage

• Documentation Testing: Consider adding this scenario to documentation review checklist
• User Validation: Would benefit from validation by actual GitHub Enterprise users

💡 Suggestions for Future Enhancement

1. Add troubleshooting section for common Enterprise setup issues
2. Include screenshots specific to GitHub Enterprise interface
3. Add links to GitHub Enterprise documentation
4. Consider creating a separate dedicated page for Enterprise setup if content grows

Overall Assessment

This is a solid contribution that fills an important documentation gap. The change is small but valuable. With some expansion of the technical details, this will be an excellent resource for GitHub Enterprise users.

Recommendation: ✅ Approve with suggestions for enhancement

Generated with Claude Code

Review dismissed