search

nushell / nushell.github.io

Nushell's main website, blog, book, and more
https://www.nushell.sh/book/
MIT License
162 stars 400 forks source link

Documents translation status overview #261

Open hustcer opened 2 years ago

hustcer commented 2 years ago

The following table holds the overview of the Nushell docs’ writing and translation status. Welcome to participate in the translation of the docs. And please update the i18n-meta.json file after you have finished writing or translating the doc. Thanks

name en zh-CN de tr ja es pt-BR ru
3rdpartyprompts.md Completed f5987a82d@hustcer translated by @sebastian-xyz - - - - -
README.md Completed fa90895307@hustcer - - cfc7b0d@YukiOnodera - - translated by @blezz-tech
advanced.md In progress - - - - - - -
aliases.md Completed 51522d5591@hustcer translated by @sebastian-xyz - - - - -
background_task.md In progress - f08ae29d@petrisch - - - - -
cheat_sheet.md In progress - - - - - - -
coloring_and_theming.md Completed 1b7d01ac3b@hustcer 93859d14ea@petrisch - - - - -
coming_from_bash.md Completed d6efb9a35a@hustcer translated by @sebastian-xyz - - - - -
coming_from_cmd.md In progress - c39efa00@petrisch - - - - -
coming_to_nu.md In progress - c39efa00@petrisch - - - - -
command_signature.md In progress - 696cb4fe@petrisch - - - - -
configuration.md Completed d6efb9a35a@hustcer translated by @sebastian-xyz - - - - -
control_flow.md Completed - - - - - - -
creating_errors.md Completed ae23eeba3@hustcer - - - - - -
custom_commands.md Completed d6efb9a35a@hustcer translated by @sebastian-xyz - - - - -
custom_completions.md Completed f5987a82d@hustcer 5993a92b@petrisch - - - - -
dataframes.md Completed 129cc2ddea@hustcer - - - - - -
default_shell.md In progress - - - - - - -
design_notes.md In progress - - - - - - -
environment.md Completed d6efb9a35a@hustcer - - - - - -
escaping.md Completed f5987a82d@hustcer translated by @sebastian-xyz - - - - -
explore.md In progress - - - - - - -
externs.md Completed b6c91cabfa@hustcer - - - - - -
getting_started.md In progress - c39efa00@petrisch - cfc7b0d@YukiOnodera - - -
hooks.md In progress 562cad2fb5@hustcer 13ed3117@petrisch - - - - -
how_nushell_code_gets_run.md In progress - - - - - - -
installation.md Completed 73ef7f3153@hustcer translated by @sebastian-xyz - - - - -
introduction.md In progress - - - - - - -
line_editor.md Completed b6c91cabfa@hustcer - - - - - -
loading_data.md Completed fa90895307@hustcer 0c788acfec@petrisch - - - - -
metadata.md Completed ae23eeba3@hustcer 83d74f9af2@Roshanjossey - - - - -
modules.md Completed 73ef7f3153@hustcer - - - - - -
moving_around.md Completed 1b7d01ac3b@hustcer cfba017793@petrisch - - - - -
nu_as_a_shell.md In progress - c39efa00@petrisch - - - - -
nu_fundamentals.md In progress - c39efa00@petrisch - - - - -
nushell_map.md Completed 1b7d01ac3b@hustcer - - - - - -
nushell_map_functional.md Completed 73ef7f3153@hustcer - - - - - -
nushell_map_imperative.md Completed 73ef7f3153@hustcer - - - - - -
nushell_operator_map.md Completed ae23eeba3@hustcer - - - - - -
operators.md Completed 1b7d01ac3b@hustcer c39efa00@petrisch - - - - -
overlays.md In progress 51522d5591@hustcer 2a917adc@petrisch - - - - -
parallelism.md Completed ae23eeba3@hustcer - - - - - -
pipelines.md Completed 6f61fadb69@hustcer 931d7240e2@petrisch - - - - -
plugins.md Completed ae23eeba3@hustcer translated by @sebastian-xyz - - - - -
programming_in_nu.md In progress - c39efa00@petrisch - - - - -
quick_tour.md In progress - - - fcf0d7c8@yukitomoda - - -
regular_expressions.md Completed b6c91cabfa@hustcer - - - - - -
scripts.md Completed fa90895307@hustcer 931d7240e2@petrisch - - - - -
shells_in_shells.md Completed f5987a82d@hustcer - - - - - -
standard_library.md In progress - - - - - - -
stdout_stderr_exit_codes.md Completed 73ef7f3153@hustcer - - - - - -
style_guide.md In progress - - - - - - -
table_of_contents.md Completed 1b7d01ac3b@hustcer - - - - - -
testing.md In progress - - - - - - -
thinking_in_nu.md Completed fa90895307@hustcer c39efa00@petrisch - - - - -
types_of_data.md Completed 73ef7f3153@hustcer - - - - - -
variables_and_subexpressions.md Completed 1b7d01ac3b@hustcer translated by @sebastian-xyz - - - - -
working_with_lists.md Completed 73ef7f3153@hustcer ad03c8d55c@petrisch - - - - -
working_with_strings.md Completed 5d093e293d@hustcer 0c788acfec@petrisch - - - - -
working_with_tables.md Completed 73ef7f3153@hustcer ad03c8d55c@petrisch - - - - -

Possible status values: -,Completed,In Progress,Being translated by @ABC, commit_id@author or simply a COMMIT ID indicate your translation end to.

hustcer commented 2 years ago

@sebastian-xyz Hi, Thanks for your contribution, could you please update i18-meta.json file in your next PR? for example:

{
    "name": "aliases.md",
    "en": "In progress",
    "de": "Translated by @sebastian-xyz ",
    "zh-cn": "-",
    "ja": "-",
    "es": "-",
    "pt-BR": "-"
  },

Then I can update the content of this table in time.

hustcer commented 2 years ago

Translation status has been updated

hustcer commented 2 years ago

After this PR: https://github.com/nushell/nushell.github.io/pull/408, it's recommend to use commit_id@author or simply a COMMIT-ID to indicate your translation end to the specified commit, then you can use command like nu ./i18n.nu outdated zh-CN to check the outdated translations(documents have been changed after your last translation) for the specified locale.

hustcer commented 2 years ago

For those who want to translate the nushell docs, here is a Translation Guide for you. Thanks for your contribution!

petrisch commented 2 years ago

@sebastian-xyz Can you have a look here: petrisch Maybe I can contribute some things from time to time, but it should fit in with the rest, so I hesitate to make a PR.

sebastian-xyz commented 2 years ago

@petrisch From reading through it I noticed you used 'wir' as in the english version. I tried to avoid that since it is not that common in german. Otherwise I didn't notice anything that I would change or that varies from the way I did it. But it's also fine like this. Thanks! Feel also free to ping me on discord if you've got any other questions while translating :)

hustcer commented 2 years ago

@petrisch It's not recommend to change the file name after translation, change the file name will cause some code formatting issue, and may make ./i18n.nu script fail

petrisch commented 2 years ago

@hustcer thats one thing I was wondering about, since now in the german translate there is variablen_und_unterausdruecke.md which is a filename change. @sebastian-xyz Thanks for the comment, I'm not on discord, but I will ping you first maybe in my fork before doing any PR

Kissaki commented 1 month ago

Possible status values: -,Completed,In Progress,Being translated by @ABC, commit_id@author or simply a COMMIT ID indicate your translation end to.

What does Completed and In Progress on EN mean? Looks like column EN is Complete when any one translation exists? If so, I find that very misleading. EN content completeness has nothing to do with translations.

There seems to be at least two grammatical errors in or simply a COMMIT ID indicate your translation end to.

Kissaki commented 1 month ago

I see the Complete and In Progress values on en are in the i18n-meta.json file as well. I still don't understand the intention or how they make sense.

hustcer commented 1 month ago

What does Completed and In Progress on EN mean? Looks like column EN is Complete when any one translation exists? If so, I find that very misleading. EN content completeness has nothing to do with translations.

Completed in EN means the doc has been finished and won't change in the near future, and it's safe to translate; In Progress means the doc is still in writing and may change quite a lot, it's not safe to translate yet. I admit that it's misleading and the status may outdated.

There seems to be at least two grammatical errors in or simply a COMMIT ID indicate your translation end to.

English is not my native language, glad you can correct me.

Kissaki commented 1 month ago

What are you trying to say with it? What is the commit id supposed to be for? The commit that created the translation? The last commit that made changes to the translation?

Kissaki commented 1 month ago

I suggest some changes in PR #1431 - it also drops the confusion by dropping the elaboration.

hustcer commented 1 month ago

What are you trying to say with it? What is the commit id supposed to be for? The commit that created the translation? The last commit that made changes to the translation?

Supposing you are in nu docs repo and going to translate book/configuration.md doc from commit id: b985c653da, and you finish the translation some time. And a few days later the nu docs repo has lots of new commits, the book/configuration.md has been updated too, you may want to update your translation, but what's changed to the original doc after your last translation? You can use git diff b985c653da book/configuration.md to see what's changed and update your translation according to the changes. The commit id: b985c653da is what supposed to be add to the i18n-meta.json

Kissaki commented 1 month ago

ah, so the base ref of the original text [state]

Then I assume for commit@author the commit is used that way as well. I interpreted it differently.