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

Translation Effort - Language-specific links to other OWASP resources #310

Open
phischde opened this issue May 13, 2024 · 4 comments
Open
Assignees

Comments

@phischde
Copy link
Contributor

While translating the LLM Top 10 into German, @johannhartmann and I noticed that there are a few links embedded within the text (not just the references).

For example, LLM05 links to A06:2021 - Vulnerable and Outdated Components. It also links to https://github.com/OWASP/www-project-top-10-for-large-language-model-applications/blob/main/1_0_vulns/Training_Data_Poisoning.md. Furthermore, LLM06 links to the wiki at https://github.com/OWASP/www-project-top-10-for-large-language-model-applications/wiki/Definitions.

This raises two questions:

  • Should links to other OWASP documents point to their English originals or to the translations (where available)?
  • Are there canonical links, or do we just point to the latest/current version? As some of them contain versions, this is a bit unclear.

I couldn't find any guidance in the documentation regarding a common approach. It seems like the Spanish translation has kept the links as they are in the English version.

How should we proceed so that it is consistent across all translations?

(Original post in Slack)

Copy link

👋 Thanks for reporting! Please ensure labels are applied appropriately to the issue so that the workflow automation can triage this to the correct member of the core team

@GangGreenTemperTatum
Copy link
Collaborator

hey @virtualsteve-star , temp assigning to you whilst we source a new translations lead :)

@talesh talesh self-assigned this Jun 13, 2024
@talesh
Copy link
Collaborator

talesh commented Jun 13, 2024

@virtualsteve-star @GangGreenTemperTatum I've been talking with Philippe about this. Working through guidance around it for upcoming translations.

@phischde
Copy link
Contributor Author

After Chatting with @talesh , here are my 2 cents, now that we have finished the German version.

  • We left all the links unchanged to be consistent with the other translations (they also chose this approach).

Based on the translation experience, I would like to suggest / discuss the following.

  • I think that references to other items in the same document should always be by name only. Otherwise we would have to differentiate, e.g. in Markdown linking to files on GitHub, but in PDF linking to other places within the same PDF.
  • Basically, I would minimize links in the body text because of these different treatments of links
  • I would always leave the links below each chapter in the original, as they are the essence of the original text. However, if all the links are below a chapter, it would make sense to also provide a link to a translated version after the original, if available, so that the reader has a choice. Example:
  • https://owasp.org/www-project-top-ten/2017/A2_2017-Broken_Authentication (German: https://owasp.org/www-project-top-ten/2017/de/A2_2017-Fehler_in_der_Authentifizierung.html)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants