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

Translating links without actual links may cause problems in documentation (Translating Weblate Docs) #13462

Closed
2 tasks done
yilmazdurmaz opened this issue Jan 9, 2025 · 4 comments
Labels
wontfix Nobody will work on this.

Comments

@yilmazdurmaz
Copy link
Contributor

Describe the issue

Hi, I am checking recent updates to the documentation, and translating if necessary, and I have met a problem. (I am merely checking and translate/proof-read if no one seems to be around for a few weeks)

In at least one rst file, you are using "separated referenced links" but only the referencing strings are included in translations.

Example link: https://hosted.weblate.org/translate/weblate/documentation/tr/?checksum=394b129e66fe6089

And the source:

1. `Create a Google Cloud bucket.`_
.. _Create a Google Cloud bucket.: https://cloud.google.com/storage/docs/creating-buckets

In this example, only the first line is included in the translation component.

If we translate it, then the two will not be the anymore, parser then won't find a match, thus crippling the link's purpose.

I am not exactly sure how your document parser works. I might be overthinking.

Otherwise, please make necessary improvements.

Thanks

I already tried

  • I've read and searched the documentation.
  • I've searched for similar filed issues in this repository.

Steps to reproduce the behavior

Not many steps. I have necessary parts in the description.

Expected behavior

No response

Screenshots

No response

Exception traceback

No response

How do you run Weblate?

weblate.org service

Weblate versions

No response

Weblate deploy checks

No response

Additional context

No response

@yilmazdurmaz
Copy link
Contributor Author

Thanks @nijel , for having this link from another repo:
sphinx-doc/sphinx#13186

@yilmazdurmaz
Copy link
Contributor Author

Translating this should not break links. It breaks it only in rare cases when the same link text is used twice, see sphinx-doc/sphinx#13186

It is nice to know you are well aware of this.

@nijel
Copy link
Member

nijel commented Jan 9, 2025

If we translate it, then the two will not be the anymore, parser then won't find a match, thus crippling the link's purpose.

This is your speculation, or you have seen the issue somewhere?

There is no issue with this particular link being translated, it renders just fine. For example, see German translation: https://docs.weblate.org/de/latest/admin/machine.html#google-cloud-translation-advanced

The issue described in sphinx-doc/sphinx#13186 happens only when the same link is used twice (or more).

@yilmazdurmaz
Copy link
Contributor Author

This is your speculation, or you have seen the issue somewhere?

Sorry for over-reacting.

Different projects have different parsers, and I wasn't sure how Weblate's parser works.

It is best to write it down so we know we are aware of possible problems.

Now that it is clear you already have it, you may close this issue unless there are now devils in your mind.

Thanks again
YILMAZ

@nijel nijel added the wontfix Nobody will work on this. label Jan 9, 2025
@nijel nijel closed this as completed Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wontfix Nobody will work on this.
Projects
None yet
Development

No branches or pull requests

2 participants