webpack / webpack/webpack.js.org

Proposal: Arabic translation for webpack.js.org documentation

Open
#8,246 15 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
2.3k
Forks
3.4k
Avg merge
13h 32m
Merged PRs (30d)
71

Description

Feature documentation

Arabic translation / localization of the webpack.js.org documentation.

we are a small group of 4-5 native Arabic speakers interested in contributing an Arabic translation for webpack.js.org.

we noticed that the README still points contributors to the translation branch:
https://github.com/webpack/webpack.js.org/tree/translation however, that branch appears to be very old compared to the current main branch, and the current documentation content is now in .mdx files under src/content.

before we start translating or opening pull requests, we would like to ask what contribution path the webpack documentation team prefers for a new Arabic translation.

Author(s)

Suggested contributors to the Arabic translation:

  • @RlxChap2
  • @arabpolice
  • @ameencfw
  • @semon009
  • @MohaDev-69

N/A for feature authors, since this is a documentation translation proposal rather than documentation for a newly implemented webpack feature.

Additional information

Our proposed approach:

  1. start from the current main branch, not from the old translation branch.
  2. begin with a small proof of concept instead of a large translation PR.
  3. translate only 2-3 important pages first, for example:
    • src/content/guides/installation.mdx
    • src/content/guides/getting-started.mdx
    • src/content/concepts/index.mdx
  4. we'll keep all code examples, package names, option names, links, and MDX structure unchanged.
  5. use a shared Arabic glossary to keep technical terminology consistent.
  6. submit small pull requests for easier review. (also look at the questions bellow)
  7. since maintainers may not be Arabic speakers (ig), so each translation PR will be reviewed internally by at least one separate native Arabic speaker before submission.

we are willing to maintain the Arabic translation over time, not only submit a one-time bulk translation.

[x] I am willing to work on this issue and submit a pull request.


Questions:

  1. should Arabic translation work to be in this repository ? or in a separate repository, or under a separate domain/subdomain?
  2. should all translation work be based on the current main branch?
  3. would the team accept a small Arabic proof-of-concept PR before a wider translation effort?
  4. is there a preferred structure or workflow for new language translations?
  5. are there maintainers or reviewers we should coordinate with before starting?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the README translation guidance and compare the old translation branch with current main content under src/content, especially the named installation.mdx, getting-started.mdx, and concepts/index.mdx files. The repository, workflow, and review process still need maintainer direction; once agreed, a small proof of concept covering those pages while preserving MDX structure would define done.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, localization
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.