[wp-meta] [Making WordPress.org] #7520: Move Handbooks to GitHub to ease ability to contribute content
Making WordPress.org
noreply at wordpress.org
Fri Aug 30 16:40:05 UTC 2024
#7520: Move Handbooks to GitHub to ease ability to contribute content
-----------------------------+---------------------
Reporter: oglekler | Owner: (none)
Type: feature request | Status: new
Priority: normal | Milestone:
Component: Handbooks | Resolution:
Keywords: |
-----------------------------+---------------------
Comment (by wildworks):
Regarding localizing the documentation, I would like to share the workflow
that the Japanese community follows.
== If the Handbook is managed on GitHub
- Fork the repository on GitHub.
- Clone the repository to our machine.
- Translate the text. Comment out the original text and add the translated
Japanese text below it, as shown below. Example:
{{{
<!--
Hello World!
-->
今日は世界!
}}}
- Submit the translated page as a PR. Community members review and merge
the PR ([https://github.com/jawordpressorg/developer-plugins-
handbook/pull/144/files example]).
- Copy the markdown text of the translated page and paste it into the
block editor on the Japanese Handbook site.
- If the upstream repository is updated, merge it into the Japanese
repository. Here, we review the updates made in the upstream repository
and make a new translation if necessary.
== If the Handbook is not managed on GitHub
- In this case, too, create a repository for Japanese.
- Use the [https://github.com/alleyinteractive/wp-block-converter WP Block
Converter] tool to parse the published handbook page and convert it to
markdown.
- Translate the text. Comment out the original text and add the translated
Japanese text below it.
- Submit the translated page as a PR. Community members review and merge
the PR.
- Copy the Markdown text of the page where the translation is completed
and paste it into the block editor of the Japanese Handbook site.
- Periodically, run the WP Block Converter tool locally.
- If any differences are found, make a new translation.
In both cases, we use GitHub, and I certainly feel the problem of it being
hard for users who are not familiar with GitHub to contribute.
--
Ticket URL: <https://meta.trac.wordpress.org/ticket/7520#comment:20>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org
More information about the wp-meta
mailing list