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

Set up language fallback for docs, and update translation guidelines #7403

Merged
merged 6 commits into from
Nov 23, 2019

Conversation

fauxpark
Copy link
Member

@fauxpark fauxpark commented Nov 19, 2019

Description

Without this fallbackLanguages array, pages that don't exist in the selected language will 404. All links must also be prefixed with the language code, or it will revert back to English.

Additionally, pointed users towards using the qmk docs CLI command, and used fenced code blocks in translating.md, for syntax highlighting.

Also I think the country flags should be the actual emoji characters, instead of eg. :ja:, as some of them appear to be unsupported currently.

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).

@fauxpark fauxpark requested a review from a team November 19, 2019 02:47
@zvecr zvecr requested a review from a team November 19, 2019 02:50
@mtei
Copy link
Contributor

mtei commented Nov 19, 2019

Some of the section titles (those linked from others) must also be as follows:

diff --git a/docs/zh-cn/newbs_flashing.md b/docs/zh-cn/newbs_flashing.md
index 05a9eb55e..5f1899c5b 100644
--- a/docs/zh-cn/newbs_flashing.md
+++ b/docs/zh-cn/newbs_flashing.md
@@ -78,5 +78,5 @@
 
-## 使用命令行刷新键盘
+## 使用命令行刷新键盘 :id=flash-your-keyboard-from-the-command-line
 
 首先,您需要知道您的键盘使用的是哪个bootloader。通常是以下四个常见的bootloader。Pro-Micro 和 clones 使用 CATERINA, Teensy 使用 Halfkay, OLKB 键盘使用 QMK-DFU, 其他的atmega32u4芯片使用DFU。

I think this description needs to be added to docs/translating.md.
(If the English version already contains :id=xxx, translators to the new language will be easier to translate.)

@mtei
Copy link
Contributor

mtei commented Nov 20, 2019

I have a suggestion.

The following information at the end of docs/README.md may help newcomers.

?> You can also view this document directly in a repository that has been cloned to your computer. [How to view] (translating.md#previewing-the-translations)

@fauxpark
Copy link
Member Author

@mtei I moved the entire section to contributing.md, as this information can be used for any kind of docs work, not just translations.

@mtei
Copy link
Contributor

mtei commented Nov 21, 2019

@fauxpark, Information on how to preview documents is also useful for users who want to create their own keymaps but do not plan to contribute.
So it would be nice to have a link to the description in README.md or somewhere.

@fauxpark
Copy link
Member Author

I'm not quite sure what you mean. This is primarily a dev tool for testing changes to the docs - if you just want to read them you can simply go to the docs site.

@mtei
Copy link
Contributor

mtei commented Nov 22, 2019

I want to be able to read the document without being connected to the internet if possible.

@fauxpark
Copy link
Member Author

Okay, how's this?

@mtei
Copy link
Contributor

mtei commented Nov 22, 2019

Thank you!

@zvecr zvecr merged commit 9ea9806 into qmk:master Nov 23, 2019
@fauxpark fauxpark deleted the docs-translations-fallback branch November 23, 2019 16:09
noroadsleft pushed a commit that referenced this pull request Dec 2, 2019
* for initial commit

* for initial commit

* for initial commit

* Update led_update_kb example (#7451)

* Update led_update_kb example

* Update comment to explain pin behavior

* wordsmith

* wordsmithing 2

* Remove CR when computing BOOTLOADER_SIZE. (#7453)

* Set up language fallback for docs, and update translation guidelines (#7403)

* Set up language fallback for docs, and update translation guidelines

* Title Case

* Add ID example

* Link to emoji flag cheatsheet

* Move docs preview section to contributing.md

* Point to docs preview in the readme

* [Keyboard] Added Cans12er keyboard (#7455)

* added cans12er keyboard

* updated readme

Updated the readme to conform with the provided template from the qmk_firmware githubpage

* Update keyboards/cans12er/README.md

Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>

* Changed configuration

Changed the configuration based on the Change Request from PR #7455 made by github user noroadsleft

* [Keyboard] Update ATmega32A readme files to match template (#7462)

* Update atmega32a readme files to match template

* Update atmega32a readme files to match template - fixes

* Apply suggestions from code review

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Co-Authored-By: shela <shelaf@users.noreply.github.com>
ripxorip pushed a commit to ripxorip/qmk_firmware that referenced this pull request Dec 3, 2019
…mk#7403)

* Set up language fallback for docs, and update translation guidelines

* Title Case

* Add ID example

* Link to emoji flag cheatsheet

* Move docs preview section to contributing.md

* Point to docs preview in the readme
ripxorip pushed a commit to ripxorip/qmk_firmware that referenced this pull request Dec 3, 2019
* for initial commit

* for initial commit

* for initial commit

* Update led_update_kb example (qmk#7451)

* Update led_update_kb example

* Update comment to explain pin behavior

* wordsmith

* wordsmithing 2

* Remove CR when computing BOOTLOADER_SIZE. (qmk#7453)

* Set up language fallback for docs, and update translation guidelines (qmk#7403)

* Set up language fallback for docs, and update translation guidelines

* Title Case

* Add ID example

* Link to emoji flag cheatsheet

* Move docs preview section to contributing.md

* Point to docs preview in the readme

* [Keyboard] Added Cans12er keyboard (qmk#7455)

* added cans12er keyboard

* updated readme

Updated the readme to conform with the provided template from the qmk_firmware githubpage

* Update keyboards/cans12er/README.md

Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>

* Changed configuration

Changed the configuration based on the Change Request from PR qmk#7455 made by github user noroadsleft

* [Keyboard] Update ATmega32A readme files to match template (qmk#7462)

* Update atmega32a readme files to match template

* Update atmega32a readme files to match template - fixes

* Apply suggestions from code review

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Co-Authored-By: shela <shelaf@users.noreply.github.com>
patrl pushed a commit to patrl/qmk_firmware that referenced this pull request Dec 29, 2019
…mk#7403)

* Set up language fallback for docs, and update translation guidelines

* Title Case

* Add ID example

* Link to emoji flag cheatsheet

* Move docs preview section to contributing.md

* Point to docs preview in the readme
patrl pushed a commit to patrl/qmk_firmware that referenced this pull request Dec 29, 2019
* for initial commit

* for initial commit

* for initial commit

* Update led_update_kb example (qmk#7451)

* Update led_update_kb example

* Update comment to explain pin behavior

* wordsmith

* wordsmithing 2

* Remove CR when computing BOOTLOADER_SIZE. (qmk#7453)

* Set up language fallback for docs, and update translation guidelines (qmk#7403)

* Set up language fallback for docs, and update translation guidelines

* Title Case

* Add ID example

* Link to emoji flag cheatsheet

* Move docs preview section to contributing.md

* Point to docs preview in the readme

* [Keyboard] Added Cans12er keyboard (qmk#7455)

* added cans12er keyboard

* updated readme

Updated the readme to conform with the provided template from the qmk_firmware githubpage

* Update keyboards/cans12er/README.md

Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>

* Changed configuration

Changed the configuration based on the Change Request from PR qmk#7455 made by github user noroadsleft

* [Keyboard] Update ATmega32A readme files to match template (qmk#7462)

* Update atmega32a readme files to match template

* Update atmega32a readme files to match template - fixes

* Apply suggestions from code review

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Co-Authored-By: shela <shelaf@users.noreply.github.com>
HokieGeek pushed a commit to HokieGeek/qmk_firmware that referenced this pull request Feb 21, 2020
…mk#7403)

* Set up language fallback for docs, and update translation guidelines

* Title Case

* Add ID example

* Link to emoji flag cheatsheet

* Move docs preview section to contributing.md

* Point to docs preview in the readme
HokieGeek pushed a commit to HokieGeek/qmk_firmware that referenced this pull request Feb 21, 2020
* for initial commit

* for initial commit

* for initial commit

* Update led_update_kb example (qmk#7451)

* Update led_update_kb example

* Update comment to explain pin behavior

* wordsmith

* wordsmithing 2

* Remove CR when computing BOOTLOADER_SIZE. (qmk#7453)

* Set up language fallback for docs, and update translation guidelines (qmk#7403)

* Set up language fallback for docs, and update translation guidelines

* Title Case

* Add ID example

* Link to emoji flag cheatsheet

* Move docs preview section to contributing.md

* Point to docs preview in the readme

* [Keyboard] Added Cans12er keyboard (qmk#7455)

* added cans12er keyboard

* updated readme

Updated the readme to conform with the provided template from the qmk_firmware githubpage

* Update keyboards/cans12er/README.md

Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>

* Changed configuration

Changed the configuration based on the Change Request from PR qmk#7455 made by github user noroadsleft

* [Keyboard] Update ATmega32A readme files to match template (qmk#7462)

* Update atmega32a readme files to match template

* Update atmega32a readme files to match template - fixes

* Apply suggestions from code review

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Co-Authored-By: shela <shelaf@users.noreply.github.com>
BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
…mk#7403)

* Set up language fallback for docs, and update translation guidelines

* Title Case

* Add ID example

* Link to emoji flag cheatsheet

* Move docs preview section to contributing.md

* Point to docs preview in the readme
BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
* for initial commit

* for initial commit

* for initial commit

* Update led_update_kb example (qmk#7451)

* Update led_update_kb example

* Update comment to explain pin behavior

* wordsmith

* wordsmithing 2

* Remove CR when computing BOOTLOADER_SIZE. (qmk#7453)

* Set up language fallback for docs, and update translation guidelines (qmk#7403)

* Set up language fallback for docs, and update translation guidelines

* Title Case

* Add ID example

* Link to emoji flag cheatsheet

* Move docs preview section to contributing.md

* Point to docs preview in the readme

* [Keyboard] Added Cans12er keyboard (qmk#7455)

* added cans12er keyboard

* updated readme

Updated the readme to conform with the provided template from the qmk_firmware githubpage

* Update keyboards/cans12er/README.md

Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>

* Changed configuration

Changed the configuration based on the Change Request from PR qmk#7455 made by github user noroadsleft

* [Keyboard] Update ATmega32A readme files to match template (qmk#7462)

* Update atmega32a readme files to match template

* Update atmega32a readme files to match template - fixes

* Apply suggestions from code review

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Co-Authored-By: shela <shelaf@users.noreply.github.com>
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.

4 participants