Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc update zh-cn #8147

Merged
merged 3 commits into from
Feb 11, 2020
Merged

doc update zh-cn #8147

merged 3 commits into from
Feb 11, 2020

Conversation

ymzcdg
Copy link
Contributor

@ymzcdg ymzcdg commented Feb 11, 2020

Timestamp was added at the end of the document, it can help me manage version easier.

Description

QMK has changed a lot, so has the documents.
Timestamp was added at the end of the document.
It is suggested to add a timestamp to the document to facilitate the translator to manage the version.
武汉加油!

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

Timestamp was added at the end of the document, it can help me manage version easier.
@fauxpark
Copy link
Member

fauxpark commented Feb 11, 2020

Could you please change the encoding to UTF-8? It looks like this locally:
image

Related: #7665

@ymzcdg
Copy link
Contributor Author

ymzcdg commented Feb 11, 2020

Could you please change the encoding to UTF-8? It looks like this locally:
image

sorry,I will check it.

@ymzcdg
Copy link
Contributor Author

ymzcdg commented Feb 11, 2020

notepad++ default to GB2312, already fixed.

@fauxpark
Copy link
Member

Sorry, there were no changes in that last commit.

@fauxpark
Copy link
Member

Much better, thanks 👍

Copy link
Member

@noroadsleft noroadsleft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a general comment:

Adding a timestamp as you've done here is fine, but the group that's been doing our Japanese translations has been using the original commit hash to track the source English doc:

This has the advantage that it's not specific to a time zone as your method is, in the event someone who perhaps speaks Chinese but doesn't live in China wants to check changes to the English doc that may need updating on the translation.

Anyway, looks good to me. Thank you for your contributions!

@noroadsleft
Copy link
Member

notepad++ default to GB2312, already fixed.

Also, I'm a Notepad++ user myself; you can change the default file encoding under Settings / Preferences / New Document / Encoding (in English, anyway 😃), if it suits. Encoding of an existing file can be changed in the Encoding menu.

@noroadsleft noroadsleft merged commit 6a165c4 into qmk:master Feb 11, 2020
@ymzcdg
Copy link
Contributor Author

ymzcdg commented Feb 12, 2020

Just a general comment:

Adding a timestamp as you've done here is fine, but the group that's been doing our Japanese translations has been using the original commit hash to track the source English doc:

* https://github.com/qmk/qmk_firmware/blame/387c486e570cc94d6798a8f326dcfe7fdeb7891f/docs/ja/arm_debugging.md#L3-L6

This has the advantage that it's not specific to a time zone as your method is, in the event someone who perhaps speaks Chinese but doesn't live in China wants to check changes to the English doc that may need updating on the translation.

Anyway, looks good to me. Thank you for your contributions!

Your method looks very good, but I can't find the way to generate the string of"eae21eed7" with "docs/arm_debugging.md" ,"eae21eed7" is not the commit hash "52c18ef02" and even not md5/sha1 of the document.
I decide to use commit hash and PRid e.g. : arm_debugging.md--52c18ef--7642. I wonder if I can do this.
Thanks for your help.

@ymzcdg
Copy link
Contributor Author

ymzcdg commented Feb 12, 2020

notepad++ default to GB2312, already fixed.

Also, I'm a Notepad++ user myself; you can change the default file encoding under Settings / Preferences / New Document / Encoding (in English, anyway smiley), if it suits. Encoding of an existing file can be changed in the Encoding menu.

Already set but don't work, maybe something wrong with the program. I‘d better use vscode.Thanks.

@noroadsleft
Copy link
Member

Your method looks very good, but I can't find the way to generate the string of"eae21eed7" with "docs/arm_debugging.md" ,"eae21eed7" is not the commit hash "52c18ef02" and even not md5/sha1 of the document.

The eae21eed7 references the commit mash of QMK's master branch at the time the file was translated. Specifically, it's referencing:

https://github.com/qmk/qmk_firmware/blob/eae21eed743d8bb9fd961f91d97a92f0f94247fe/docs/arm_debugging.md

The line with git diff displays the changes that have been made to the original (English) file since the translated file was created or last updated.

@ymzcdg
Copy link
Contributor Author

ymzcdg commented Feb 12, 2020

Your method looks very good, but I can't find the way to generate the string of"eae21eed7" with "docs/arm_debugging.md" ,"eae21eed7" is not the commit hash "52c18ef02" and even not md5/sha1 of the document.

The eae21eed7 references the commit mash of QMK's master branch at the time the file was translated. Specifically, it's referencing:

https://github.com/qmk/qmk_firmware/blob/eae21eed743d8bb9fd961f91d97a92f0f94247fe/docs/arm_debugging.md

The line with git diff displays the changes that have been made to the original (English) file since the translated file was created or last updated.

Thanks. I will learn to use Git.

HokieGeek pushed a commit to HokieGeek/qmk_firmware that referenced this pull request Feb 21, 2020
* update zh-cn translate

Timestamp was added at the end of the document, it can help me manage version easier.

* fix _summary.md to utf-8

* fix _summary.md with vscode
c0psrul3 pushed a commit to c0psrul3/qmk_firmware that referenced this pull request Mar 23, 2020
* update zh-cn translate

Timestamp was added at the end of the document, it can help me manage version easier.

* fix _summary.md to utf-8

* fix _summary.md with vscode
kylekuj pushed a commit to kylekuj/qmk_firmware that referenced this pull request Apr 21, 2020
* update zh-cn translate

Timestamp was added at the end of the document, it can help me manage version easier.

* fix _summary.md to utf-8

* fix _summary.md with vscode
jakeisnt pushed a commit to jakeisnt/qmk_firmware that referenced this pull request Aug 20, 2020
* update zh-cn translate

Timestamp was added at the end of the document, it can help me manage version easier.

* fix _summary.md to utf-8

* fix _summary.md with vscode
BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
* update zh-cn translate

Timestamp was added at the end of the document, it can help me manage version easier.

* fix _summary.md to utf-8

* fix _summary.md with vscode
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants