search

erg-lang / erg

A statically typed language compatible with Python
http://erg-lang.org
Apache License 2.0
2.68k stars 55 forks source link

Put a badge on all translated documents #51

Closed mtshiba closed 2 years ago

mtshiba commented 2 years ago

Continuation from https://github.com/erg-lang/erg/issues/48.

A badge indicating the translation status should be attached to all translated documents.

The format of the badge is as follows.

[![badge](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgezf7g7pd5.execute-api.ap-northeast-1.amazonaws.com%2Fdefault%2Fsource_up_to_date%3Fowner%3Derg-lang%26repos%3Derg%26ref%3Dmain%26path%3{ORIGINAL_FILE_NAME}%26commit_hash%3D{ORIGINAL_COMMIT_HASH})
](https://gezf7g7pd5.execute-api.ap-northeast-1.amazonaws.com/default/source_up_to_date?owner=erg-lang&repos=erg&ref=main&path={ORIGINAL_FILE_NAME}&commit_hash={ORIGINAL_COMMIT_HASH})

Replace {ORIGINAL_FILE_NAME} and {ORIGINAL_COMMIT_HASH} with the appropriate ones.

As an example, here is the badge of README_zh-CN.md. The original one is README.md. {ORIGINAL_FILE_NAME} = README.md {ORIGINAL_HASH} = 47b9b758acea9d4ea5d618436935b197636074f6 The result is as follows.

[![badge](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgezf7g7pd5.execute-api.ap-northeast-1.amazonaws.com%2Fdefault%2Fsource_up_to_date%3Fowner%3Derg-lang%26repos%3Derg%26ref%3Dmain%26path%3DREADME.md%26commit_hash%3D47b9b758acea9d4ea5d618436935b197636074f6)
](https://gezf7g7pd5.execute-api.ap-northeast-1.amazonaws.com/default/source_up_to_date?owner=erg-lang&repos=erg&ref=main&path=README.md&commit_hash=47b9b758acea9d4ea5d618436935b197636074f6)

The badge should be placed directly below the document title.

The documents under doc/EN are the ones I have not yet finished putting badges on. The original is located under doc/JA.

mtshiba commented 2 years ago

Badges should be checked to ensure that they are linked correctly; VSCode's markdown preview, for example, can be used to preview that the badge is functioning properly.

C-BJ commented 2 years ago

You should translate Japanese documents to English as soon as possible and set English documents as the initial documents, because people will prefer to start translating from English documents rather than Japanese documents. @mtshiba

mtshiba commented 2 years ago

OK, we should also set up an issue to translate the Japanese documents into English.