training-kit icon indicating copy to clipboard operation
training-kit copied to clipboard

Add Hebrew translations and automated preview deployment workflows

Open wildcard opened this issue 2 months ago • 3 comments

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/

wildcard avatar Nov 30 '25 02:11 wildcard

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.

wildcard avatar Nov 30 '25 03:11 wildcard

🎉 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)

  • ✅ Runs automatically on fork branch pushes
  • ✅ No maintainer approval needed
  • ✅ Uses GITHUB_TOKEN (no PAT required)
  • Working example: https://wildcard.github.io/training-kit/preview/test-preview-fix/

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 avatar Nov 30 '25 07:11 wildcard

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

wildcard avatar Nov 30 '25 15:11 wildcard