Skip to content

Conversation

@wildcard
Copy link

@wildcard wildcard commented Nov 30, 2025

Summary

Adds two complementary preview deployment workflows to streamline translation review and content approval:

1. Fork Preview Workflow (New)

  • Runs automatically on push to fork branches (no approval needed)
  • Uses GITHUB_TOKEN (no PAT required)
  • Preview URL: https://{fork-owner}.github.io/training-kit/preview/{branch}/
  • Best for: Self-review and team discussion before PR submission

2. PR Preview Workflow (Existing, Enhanced)

  • Runs on PR creation from forks (requires maintainer approval)
  • Uses fine-grained PAT with minimal permissions
  • Preview URL: https://{fork-owner}.github.io/training-kit/pr-{number}/
  • Best for: Maintainer review of submitted PRs

Gradual Review Process

Step 1: Development & Self-Review (Fork Preview)

  • Contributors push to their fork branch
  • Preview available instantly at fork's GitHub Pages
  • Iterate quickly without waiting for approval

Step 2: Team Discussion (Fork Preview)

  • Share fork preview URL with translation team
  • Gather feedback and make adjustments
  • Approve when ready for formal submission

Step 3: PR Submission & Final Review (PR Preview)

  • Create PR to main project
  • Maintainer approves workflow run
  • Final review using PR-specific preview URL
  • Merge when approved

Benefits

For Contributors:

  • ✅ Instant preview feedback
  • ✅ No waiting for maintainer approval to see changes
  • ✅ Iterate quickly during development

For Translation Teams:

  • ✅ Review translations in context before PR
  • ✅ No technical knowledge needed
  • ✅ Faster turnaround on reviews

For Maintainers:

  • ✅ Review already-vetted content
  • ✅ Control workflow execution for security
  • ✅ Less back-and-forth on PRs

Setup Required

Fork Preview: Just enable GitHub Pages (one-time)
PR Preview (optional): Additionally create fine-grained PAT

See detailed setup guides in:

  • .github/workflows/FORK_PREVIEW_SETUP.md
  • .github/workflows/PR_PREVIEW_SETUP.md
  • .github/workflows/README.md

Testing

Fork preview tested successfully:

  • ✅ Workflow runs automatically on push
  • ✅ Jekyll builds correctly
  • ✅ Deploys to gh-pages branch
  • ✅ Preview URL accessible

Example: https://wildcard.github.io/training-kit/preview/test-pr-preview/

- Add Hebrew translations for GitHub cheat sheets
- Add submodule vs subtree cheat sheet in Hebrew
- Add subversion migration guide in Hebrew
- Add AGENTS.md documentation
- Update index.html to include new resources

💘 Generated with Crush

Assisted-by: Claude Sonnet 4.5 via Crush <[email protected]>
Copilot AI review requested due to automatic review settings November 30, 2025 02:30
Copilot finished reviewing on behalf of wildcard November 30, 2025 02:32
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds Hebrew translations for three GitHub training resources and introduces comprehensive AGENTS.md documentation for AI agents working with the repository.

  • Adds Hebrew (עברית) translations for Git cheat sheet, subversion migration guide, and submodule vs subtree guide
  • Creates detailed AGENTS.md documentation covering project structure, development workflow, and best practices
  • Updates index.html with links to new Hebrew translations in appropriate sections

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
index.html Adds Hebrew translation links in Git Cheat Sheets, SVN migration, and Submodules vs. Subtrees sections
downloads/he/github-git-cheat-sheet.md Hebrew translation of Git cheat sheet with proper RTL formatting
downloads/he/subversion-migration.md Hebrew translation of SVN to Git migration guide with RTL support
downloads/he/submodule-vs-subtree-cheat-sheet.md Hebrew translation of submodules vs subtrees guide with RTL directives
AGENTS.md Comprehensive documentation guide for AI agents, covering project structure, commands, workflows, and conventions

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

redirect_to: false
title: <div dir="rtl">דף תזכורת Git של GitHub</div>
byline: <p dir="rtl">Git היא מערכת קוד פתוח לניהול גרסאות מבוזרת שמאפשרת את הפעילות של GitHub על המחשב שלכם. דף תזכורת זה מרכז את פקודות שורת הפקודה הנפוצות של Git לעיון מהיר.</p>
leadingpath: ../../../
Copy link

Copilot AI Nov 30, 2025

Choose a reason for hiding this comment

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

The leadingpath should be ../../ (two levels up) instead of ../../../ (three levels up). This file is located at downloads/he/github-git-cheat-sheet.md, which is 2 directory levels deep from the root, so it needs to go up 2 levels to reach the root where assets are located. The Spanish translation at the same depth (downloads/es_ES/) correctly uses ../../.

Suggested change
leadingpath: ../../../
leadingpath: ../../

Copilot uses AI. Check for mistakes.
redirect_to: false
title: <div dir="rtl">טיפול בתלויות עם Submodules ו-Subtrees</div>
byline: <p dir="rtl">Submodules ו-subtrees הם כלי Git שמאפשרים לכלול תתי-פרויקטים כתת-תיקייה בתוך פרויקט. המימוש של כל אחד מהם שונה מאוד.</p>
leadingpath: ../../../
Copy link

Copilot AI Nov 30, 2025

Choose a reason for hiding this comment

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

The leadingpath should be ../../ (two levels up) instead of ../../../ (three levels up). This file is located at downloads/he/submodule-vs-subtree-cheat-sheet.md, which is 2 directory levels deep from the root. Other translations at the same depth (e.g., downloads/es_ES/) correctly use ../../.

Suggested change
leadingpath: ../../../
leadingpath: ../../

Copilot uses AI. Check for mistakes.
redirect_to: false
title: <div dir="rtl">מעבר מ-Subversion ל-Git</div>
byline: <p dir="rtl">כשעוברים מ-Subversion ל-Git, יש אוצר מילים וערכת פקודות ללמוד, בנוסף ליכולות החדשות שרק Git מאפשר. דף תזכורת זה נועד לעזור לכם במעבר בין טכנולוגיית Subversion הקלאסית לשימוש המודרני ב-Git עם פלטפורמת השיתוף GitHub.</p>
leadingpath: ../../../
Copy link

Copilot AI Nov 30, 2025

Choose a reason for hiding this comment

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

The leadingpath should be ../../ (two levels up) instead of ../../../ (three levels up). This file is located at downloads/he/subversion-migration.md, which is 2 directory levels deep from the root. Other translations at the same depth (e.g., downloads/es_ES/) correctly use ../../.

Suggested change
leadingpath: ../../../
leadingpath: ../../

Copilot uses AI. Check for mistakes.
Copy link
Author

Choose a reason for hiding this comment

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

compare with other files, all of them are using this path... @copilot

Enables automatic preview deployments for PRs from forks, streamlining translation review and content editing approval.

Features:
- Builds Jekyll site for fork PRs only (excludes internal PRs)
- Deploys to fork's GitHub Pages under pr-{number}/ directory
- Auto-creates gh-pages branch if needed
- Posts preview URL as PR comment
- Uses fine-grained PAT with minimal permissions (Contents + Pages)

Setup guide included for fork owners.

💖 Generated with Crush

Assisted-by: Claude Sonnet 4.5 via Crush <[email protected]>
Complements existing PR preview with automatic fork-based previews.

Two-stage review process:
1. Fork Preview (fork-preview.yml) - Runs automatically on push to fork branches
   - No approval needed
   - Uses GITHUB_TOKEN (no PAT required)
   - URL: https://{fork-owner}.github.io/training-kit/preview/{branch}/
   - Best for: self-review and team discussion

2. PR Preview (pr-preview.yml) - Runs on PR creation (existing workflow)
   - Requires maintainer approval
   - Uses fine-grained PAT
   - URL: https://{fork-owner}.github.io/training-kit/pr-{number}/
   - Best for: maintainer review

Benefits:
- Contributors can iterate quickly without waiting for approval
- Translation teams can review before formal PR submission
- Maintainers review already-vetted content
- Both workflows optional and complementary

💖 Generated with Crush

Assisted-by: Claude Sonnet 4.5 via Crush <[email protected]>
@wildcard wildcard changed the title Add Hebrew translations and AGENTS documentation Add preview deployment workflows for gradual review process Nov 30, 2025
Copy link
Author

Baseurl issue fixed!

The preview URLs now correctly include the full path for assets and links.

Working preview: https://wildcard.github.io/training-kit/preview/test-preview-fix/

All links and CSS/assets now load properly with the corrected baseurl that includes the preview directory path.

Copy link
Author

🎉 Complete Preview Deployment System + Hebrew Translation

This PR now includes two major contributions:

1. 📚 Hebrew Translation (עברית)

Complete Hebrew translations of core documentation:

Git Cheat Sheet:

SVN Migration Guide:

Submodules vs Subtrees:

All translations include:

  • ✅ Right-to-left (RTL) text support
  • ✅ Proper Hebrew terminology
  • ✅ Full command reference with Hebrew explanations
  • ✅ Consistent formatting with other translations

2. 🚀 Automated Preview Deployment Workflows

This PR demonstrates the value of the new workflow system - you can review the Hebrew translations live before merging!

Two-Stage Preview System:

Stage 1: Fork Preview (Automatic)

Stage 2: PR Preview (Maintainer-Approved)

  • Runs when PR is created
  • Requires approval for security
  • Uses fine-grained PAT
  • PR-specific URLs for final review

Benefits Demonstrated:

  1. Instant Feedback - Hebrew translations were reviewed live before PR submission
  2. Easy for Translators - Non-technical contributors can see their work in context
  3. Better Reviews - Maintainers can click and review instead of imagining results
  4. Faster Iteration - Issues found and fixed before formal PR

📋 Review Checklist

Hebrew Translation:

  • Review Git Cheat Sheet formatting and terminology
  • Review SVN Migration guide accuracy
  • Review Submodules vs Subtrees content
  • Check RTL rendering is correct

Preview Workflows:

  • Review workflow security (fork detection, approval requirements)
  • Review documentation clarity for contributors
  • Test fork preview setup instructions
  • Verify baseurl handling for assets/links

🔄 Gradual Review Process in Action

This PR followed the recommended workflow:

  1. Development - Added Hebrew translations in fork
  2. Self-Review - Used fork preview to verify formatting
  3. Team Discussion - Shared preview links for feedback
  4. PR Submission - Now ready for maintainer review with live previews

📖 Documentation

Setup guides included:

  • .github/workflows/README.md - Overview and comparison
  • .github/workflows/FORK_PREVIEW_SETUP.md - Fork setup guide
  • .github/workflows/PR_PREVIEW_SETUP.md - PR preview setup guide

The preview system is designed to streamline translation reviews and make it easier for content editors to contribute quality translations like this Hebrew addition.

@wildcard wildcard changed the title Add preview deployment workflows for gradual review process Add Hebrew translations and automated preview deployment workflows Nov 30, 2025
Fixed technical terminology, improved natural Hebrew phrasing, and
ensured command-line examples follow international standards.

Key improvements:
- Replaced awkward transliterations with natural Hebrew + English refs
- Fixed technical inaccuracies (staging area vs version control)
- Standardized glossary format: Hebrew term (English reference)
- Reverted all command-line args to English for universal clarity
- Improved warning severity to match original tone
- Removed nonsensical translations and financial terminology

26 corrections across 3 Hebrew translation files to align with
professional technical documentation standards.

💘 Generated with Crush

Assisted-by: Claude Sonnet 4.5 via Crush <[email protected]>
@wildcard
Copy link
Author

Hebrew Translation Quality Improvements

As part of this PR, I've reviewed and improved the Hebrew translations for technical accuracy and natural Israeli Hebrew dialect.

Changes Made (26 corrections across 3 files)

Translation Quality Fixes:

  • ✅ Fixed awkward transliteration "מצ'ק-אאוטד" → natural Hebrew "עובדים עליו כרגע (checked out)"
  • ✅ Fixed nonsensical "fork (פורק)" → meaningful "העתק מאגר (fork)"
  • ✅ Corrected technical error: staging ≠ version control → "אזור ההכנה (staging area)"
  • ✅ Replaced bizarre financial terminology "לרכוש מאגר" → proper tech term "לשכפל מאגר"
  • ✅ Improved warning severity to match English original
  • ✅ Standardized glossary format: Hebrew term first, then (English reference)

Command-Line Standards:

  • ✅ Reverted all placeholder arguments from Hebrew to English
  • Examples: [שם][name], [ענף][branch], [קובץ][file]
  • Rationale: Maintains universal understanding, copy-paste compatibility, and consistency with international Git documentation

Translation Principles Applied

  1. Natural Israeli Hebrew dialect (conversational tech language)
  2. Technical accuracy (correct Git behavior descriptions)
  3. English technical terms always referenced in parentheses
  4. All command examples in English for universal clarity
  5. Meaningful translations that preserve connection to English originals

The Hebrew documentation now aligns with professional technical documentation standards while maintaining accessibility for Hebrew-speaking developers.


Files modified:

  • downloads/he/github-git-cheat-sheet.md
  • downloads/he/submodule-vs-subtree-cheat-sheet.md
  • downloads/he/subversion-migration.md

Commit: b1c2a52

Following Hebrew translation best practices, add English reference
to 'מאגר' (repository) when first introduced in section titles and
opening sentences for clarity.
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.

1 participant