Skip to content

Broken links #1365

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

Closed
IanManske opened this issue Apr 22, 2024 · 4 comments · Fixed by #1430
Closed

Broken links #1365

IanManske opened this issue Apr 22, 2024 · 4 comments · Fixed by #1430
Labels
good first issue Good for newcomers

Comments

@IanManske
Copy link
Member

IanManske commented Apr 22, 2024

The latest deployment had the following warnings regarding broken links.

warning Broken links found in cookbook/tables.md: ../book/docs/reduce.md
warning Broken links found in de/book/advanced.md: standard_library.md, dataframes.md, creating_errors.md, parallelism.md, explore.md
warning Broken links found in de/book/coloring_and_theming.md: commands/ls.md
warning Broken links found in de/book/coming_to_nu.md: coming_from_cmd.md, nushell_map.md, nushell_map_imperative.md, nushell_map_functional.md, nushell_operator_map.md
warning Broken links found in de/book/custom_completions.md: externs.md, externs.md, ../cookbook/external_completers.md
warning Broken links found in de/book/design_notes.md: how_nushell_code_gets_run.md
warning Broken links found in de/book/environment.md: modules.md, modules.md, modules.md, /commands/docs/env.md, /commands/docs/env.md
warning Broken links found in de/book/getting_started.md: quick_tour.md, thinking_in_nu.md
warning Broken links found in de/book/hooks.md: /Befehle/docs/if.md
warning Broken links found in de/book/loading_data.md: /commands/docs/size.md, /commands/docs/fetch.md
warning Broken links found in de/book/nu_as_a_shell.md: stdout_stderr_exit_codes.md, shells_in_shells.md, line_editor.md, externs.md
warning Broken links found in de/book/nu_fundamentals.md: pipelines.md
warning Broken links found in de/book/overlays.md: modules.md, modules.md#environment-variables, /commands/docs/overlay_remove.md, /commands/docs/overlay_remove.md
warning Broken links found in de/book/programming_in_nu.md: modules.md, testing.md
warning Broken links found in de/book/working_with_strings.md: /commands/docs/str_rpad.md, /commands/docs/build-string.md
warning Broken links found in ja/book/README.md: nu_fundamentals.md, programming_in_nu.md, nu_as_a_shell.md, coming_to_nu.md, design_notes.md, advanced.md
warning Broken links found in ja/book/getting_started.md: thinking_in_nu.md
warning Broken links found in ja/book/installation.md: book/dataframes.md
warning Broken links found in ru/book/README.md: getting_started.md, nu_fundamentals.md, programming_in_nu.md, nu_as_a_shell.md, coming_to_nu.md, design_notes.md, advanced.md, dataframes.md
warning Broken links found in zh-CN/book/environment.md: /commands/docs/env.md, /commands/docs/env.md
warning Broken links found in zh-CN/book/loading_data.md: /commands/docs/size.md, /commands/docs/fetch.md
warning Broken links found in zh-CN/book/overlays.md: /commands/docs/overlay_add.md, /commands/docs/overlay_remove.md, /commands/docs/overlay_remove.md
warning Broken links found in zh-CN/book/table_of_contents.md: thinking_in_nushell.md, pipeline.md
warning Broken links found in zh-CN/book/working_with_strings.md: /commands/docs/str_lpad.md, /commands/docs/str_rpad.md, /commands/docs/build-string.md
@IanManske IanManske added the good first issue Good for newcomers label Apr 22, 2024
@IanManske
Copy link
Member Author

Example PR: #1366

@Kissaki
Copy link
Contributor

Kissaki commented May 29, 2024

Apart from one, which I fixed in #1424, all broken links are from de, ja, ,ru, zh-CN translated book pages. I checked one, and it is missing the translations for the target pages.

What's the intention for translated content with missing pages?

  • Have the text but not link it? / Drop references to content that has not been translated yet?
  • Have the links and duplicate the original, EN, untranslated content when it is not translated yet?
  • Link to the EN content when it is not translated yet?

@IanManske
Copy link
Member Author

IanManske commented May 30, 2024

Hmm... none of these options are ideal, but for now I guess we can link to the EN content when it is not translated yet.
Or, if the text is out of date and/or the change is minimal, dropping the sentence with the link inside could also work.
E.g., text that links to /commands/docs/size.md should be removed, since that command no longer exists.

Kissaki added a commit to Kissaki/nushell.github.io that referenced this issue May 31, 2024
@Kissaki
Copy link
Contributor

Kissaki commented May 31, 2024

I think I found a reasonable solution in PR #1430 - which fixes various things.

For the links that are EN-valid, I linked to EN with a link text EN label.

hustcer pushed a commit that referenced this issue May 31, 2024
* Fix link references in translated books

Fixes #1365

* Add missing EN link labels/qualifiers
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants