Article Workshop

A template repository for writing or translating articles, which is based on GitHub infrastructure & flow, and can replace Crowdin-like SaaS for free.

Usage

Maintaner

1. Install GitHub apps in your organization or account:

   1. Probot settings: set up Issue labels & Pull Request rules
   2. PR badge: set up Online VS Code editor entries in Pull Request description

2. Click the Use this template button on the top of this GitHub repository's home page, then create your own repository in the app-installed namespace above

3. Replace all the URLs & Mention tags in the new repository with your own namespace

4. Recommend to add a Notification step in GitHub actions for your Team IM app

Translator

1. Add a new article in Crawler issue form, and wait for minutes

2. Crawler bot will comment on the issue with an editor link of your original article

3. Translate the article in the editor, and save it with Propose changes button, then create a Pull Request for your translation

4. If you haven't translate the full article before your first saving, you can click one of the editor buttons in your Pull Request home page to finish your translation

Reviewer

Follow the GitHub official guide of Pull Request reviewing.

Inspiration

1. https://github.com/freeCodeCamp/chinese
2. https://github.com/orgs/FreeCodeCamp-Chengdu/projects/4
3. https://github.com/kaiyuanshe/open-source-articles