API-Security
API-Security copied to clipboard
OWASP
Translation es
Hi, I found this resources super helpful and I would like non-english speakers to be able to benefit from this as well.
Do you have translation projects or do you accept translation PRs?
I see the sources are in 2019/en, so I guess I could create a 2019/es for a Spanish translation to work in.
Would that be something you'd want/like? I'm willing to make the Spanish translation, but let me know if there is an established way to contribute on this matter (maybe there is a separated repo for translations or you already have a Spanish version that I couldn't find.
Hi @leonelquinteros, I share your vision about translations.
OWASP API Security Top 10 translations are more than welcome but I suggest you to wait for the stable release: it should be announced in OWASP Global AppSec Amsterdam on Sept 26th.
You got it right: Spanish translation should come into the 2019/es/ directory.
We didn't receive any other request/contact for translations to Spanish, so I
think you're on the lead.
Give me a few days to check how to take advantage of GitHub Projects to manage translation efforts.
Cheers, Paulo A. Silva
@PauloASilva Sounds like a plan!
I'll look forward for updates on this issue and we'll follow up from there.
Hi guys, I checked GitHub projects but I am not sure it'll help managing translation efforts. I don't think it will be possible to give external contributors permission to create new cards and manage their progress.
For now I think we can do it with one issue per translation effort, using a standardized title (e.g. "Translation es-ES", "Translation pt-PT") and the "translation" label. The issue will be assigned to the translation effort leader.
What do you think?
Cheers, Paulo A. Silva
FYI for ZAP we use Crowdin: https://crowdin.com/project/owasp-zap We have tooling that pushed our English translations to Crowdin and also pulls translations back and submits them as PRs. Probably not reusable by other projects I'm afraid as they are very ZAP specific, but just so you know its possible.
@PauloASilva, by "translation effort" you mean "new language"?
@ErezYalon Yes, plus if a translation get stalled we can replace the leader.
FYI for ZAP we use Crowdin: https://crowdin.com/project/owasp-zap We have tooling that pushed our English translations to Crowdin and also pulls translations back and submits them as PRs. Probably not reusable by other projects I'm afraid as they are very ZAP specific, but just so you know its possible.
I've used it before for another OWASP documentation project (OWASP Testing Guide 4.0) but it didn't make it easier, particularly due to:
- lack of context: translating small sentences without context makes it hard to get a fluent reading.
- lack of reviewers: because each sentence needs to be reviewed to be approved the translation got stalled.
I think Crowdin may work fine for software internationalization since most of the text should be short sentences like prompts and tooltips. For documentation projects, specially those with space constraints like Top 10, I am not sure (based on my previous experience).
I led the OWASP Top 10 2017 pt-pt translation and it went smooth:
- each section (markdown) was assigned to a contributor
- once the section translation was finished a PR was opened to the translation branch
- PRs were reviewed and merged by the translation leader
- when all sections were translated the template was updated by the translation leader and a PR was opened to the official repository.
I think this workflow may work for the OWASP API Security Top 10, but we can leave it to the "translation leader" to decide how to do it.
BTW, before someone asks, why pt-pt and not only pt?
In the past we tried an all-in-one pt-pt and pt-br OWASP Secure Coding Practices Quick Reference Guide translation, but the outcome was not as good as we expected. Although both countries speak Portuguese, we have different idiomatic expressions.
I believe that experience makes us avoid past mistakes and get time to experience new ones (aka get more experienced).
Cheers, Paulo A. Silva
@PauloASilva Whenever you're ready to start, feel free to assign the Translation issue to me and I'll start working on it.
If that happens, I'll be happy to get help from @shekodn during the process, we can align our work in the corresponding issue later.
I guess we can come up with a quick translation document in the beginning and open to reviewers and corrections from there.
The PRs process Paulo mentioned to organize this work sounds good for me.
Cheers!
Hi @leonelquinteros, The issue was assigned to you.
Please clone the repo and create a translation/es-es branch from the master.
Once you get the translation done, please open a PR from translation/es-es to our master.
Thank you both! Paulo A. Silva
I agree with @PauloASilva 's proposal. How do you want us to organize @leonelquinteros? I also think we should assign each markdown to a contributor or let each contributor grab a specific document to translate.
@shekodn I've forked the repo here: https://github.com/leonelquinteros/API-Security
Adding you as a collaborator right now.
I've already started with the firsts markdowns. As this will be quick and there are only 2 of us right now, would you like to pick some markdowns and move forward from there? Just open an issue on my fork indicating which markdowns you'll take.
@leonelquinteros I saw your invite, but I cannot add issues yet. Also, where should we continue the conversation in order to distribute the tasks? I was thinking about starting to translate the following:
- [ ] 0x01-about-owasp.md
- [ ] 0x02-foreword.md
- [ ] 0x03-introduction.md
- [ ] 0x04-release-notes.md
- [ ] 0x10-api-security-risks.md
- [ ] 0x11-t10.md
Thanks!
@shekodn I've enabled issues on the repo.
Go for it! I'm ok with you translating these markdown files.
@leonelquinteros thanks! I'll keep you posted with my updates.
Please let me know if you start with something so we can be on sync :D
How far are you guys with Spanish translation? I think it's a good idea to have some chapters meetings on the same day to present "simultaneously" translated versions across the countries. What you think, guys? I'm working on pt-BR version.
I think we got like 50% I've been slowly moving forward as I've also transitioned jobs so I'll get back to speed soon.
Any idea of the date for these meetings?
I'm thought sometime in April. Are you in "OWASP LATAM" Whatsapp group? I think you can get some help there to speed it up! Do you like the idea? I like it!!! Many meetings on the same day, across the cities and countries. It will be awesome!
Sounds good! I'm not in that group. Any help is welcome, specially to review the translations we already have. It would be awesome to do these meetings! I'm not an active member of the community (yet), so not sure if there are people in Argentina more involved that I can get in touch with.
@leonelquinteros if you guys already have 50% translated, commit it to the forked repo! This group that I've mentioned is for chapters leaderships. From what city of Argentina are you from?
@raphaelhagi I'm from Buenos Aires, everything is committed to the forked repo already: https://github.com/leonelquinteros/API-Security/tree/translation/es-es
Reviews and contributions are welcome!
I'm sorry. I was off during last month, but I can keep up this weekend with the remaining topics. In the meantime I pushed 0xaa-insufficient-logging-monitoring.md and will start translating 0xa8 and 0xa9. @leonelquinteros
Hello guys,
We proudly release a pt-BR translation. I think we can do a simultaneous launch it on-line as a webinar, due the COVID-19. You have a date expectation for finish your work?
@raphaelhagi When do you want to make the launch? I think that the deadline should be one week before to allow some peer-reviews
There is not a defined date, so we can discuss it from here. I think 15 or 20 days are great.
@raphaelhagi what about finishing the work and leaving it ready for peer review in 8 days?
