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 es #22

Open
leonelquinteros opened this issue Sep 21, 2019 · 56 comments
Open

Translation es #22

leonelquinteros opened this issue Sep 21, 2019 · 56 comments
Assignees

Comments

@leonelquinteros
Copy link

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.

@PauloASilva
Copy link
Collaborator

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 PauloASilva self-assigned this Sep 22, 2019
@PauloASilva PauloASilva changed the title Translations? Translation es Sep 22, 2019
@PauloASilva PauloASilva pinned this issue Sep 22, 2019
@leonelquinteros
Copy link
Author

@PauloASilva Sounds like a plan!

I'll look forward for updates on this issue and we'll follow up from there.

@shekodn
Copy link

shekodn commented Jan 24, 2020

Any updates @leonelquinteros ? I can help with the Spanish translation :D

@PauloASilva
Copy link
Collaborator

PauloASilva commented Jan 24, 2020

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

@ErezYalon
Copy link
Member

@PauloASilva, by "translation effort" you mean "new language"?

@psiinon
Copy link
Member

psiinon commented Jan 24, 2020

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
Copy link
Collaborator

@PauloASilva, by "translation effort" you mean "new language"?

@ErezYalon Yes, plus if a translation get stalled we can replace the leader.

@PauloASilva
Copy link
Collaborator

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

@leonelquinteros
Copy link
Author

leonelquinteros commented Jan 24, 2020

@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!

@PauloASilva
Copy link
Collaborator

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

@leonelquinteros
Copy link
Author

@PauloASilva Awesome!

@shekodn
Copy link

shekodn commented Jan 24, 2020

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
Copy link

shekodn commented Jan 24, 2020

@leonelquinteros let me know when you clone the repo :D

@leonelquinteros
Copy link
Author

@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.

@shekodn
Copy link

shekodn commented Jan 24, 2020

@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!

@leonelquinteros
Copy link
Author

@shekodn I've enabled issues on the repo.

Go for it! I'm ok with you translating these markdown files.

@shekodn
Copy link

shekodn commented Jan 25, 2020

@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

@raphaelhagi
Copy link
Contributor

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.

@leonelquinteros
Copy link
Author

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?

@raphaelhagi
Copy link
Contributor

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!

@leonelquinteros
Copy link
Author

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.

@raphaelhagi
Copy link
Contributor

@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?

@leonelquinteros
Copy link
Author

@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!

@shekodn
Copy link

shekodn commented Mar 13, 2020

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

@raphaelhagi
Copy link
Contributor

Great! With COVID-19 I think we need to wait to launch simultaneously.

@ricardosupo
Copy link

I'm willing to make the Spanish translation too.

@raphaelhagi
Copy link
Contributor

raphaelhagi commented Apr 1, 2020

@raphaelhagi what about finishing the work and leaving it ready for peer review in 8 days?

That's great.
@ricardosupo, can you help @leonelquinteros with the translation that he has already started?

@leonelquinteros
Copy link
Author

Hi @ricardosupo, thanks for your help! It's really needed as I find myself in a pretty busy moment now.
I've added you as a collaborator to the spanish translation repo: https://github.com/leonelquinteros/API-Security/

You can push your contributions directly to translation/0x01/es-es branch.

@shekodn
Copy link

shekodn commented Apr 2, 2020

@leonelquinteros no worries!

@ricardosupo thanks for reaching out! I'll create tasks to start with the peer review and the missing chapters (about to commit ch.8)

@shekodn
Copy link

shekodn commented Apr 2, 2020

@ricardosupo Thanks again and feel free to assign yourself any card you want from https://github.com/leonelquinteros/API-Security/projects/1. Also, I added this template in order to manage the skeleton of each .md file leonelquinteros#2

@shekodn
Copy link

shekodn commented Apr 2, 2020

Hi @ricardosupo, thanks for your help! It's really needed as I find myself in a pretty busy moment now.
I've added you as a collaborator to the spanish translation repo: https://github.com/leonelquinteros/API-Security/

You can push your contributions directly to translation/0x01/es-es branch.

@leonelquinteros is it translation/0x01/es-es or translation/es-es? I've pushing to the latter branch.

@shekodn
Copy link

shekodn commented Apr 6, 2020

UPDATE:

There are still 10 cards without an assignee for the translation phase (peer-review still missing). Assuming 1 hour per card, we need 10 person-hours to finish this week. I will close at least 5 during this work week.

If we manage to close those 10 cards this week, we can focus on reviewing the translation effort in the week after and meet @raphaelhagi 's deadline.

@leonelquinteros
Copy link
Author

@shekodn It's the latest branch, you're OK, I was just copying and pasting from the repo URL xD

@shekodn
Copy link

shekodn commented Apr 16, 2020

UPDATE:

6 more to-do cards to finish translation efforts. I'm pretty sure we can finish before Monday. What do you think @leonelquinteros ?

@leonelquinteros
Copy link
Author

@shekodn I had some time yesterday to add another translation, hopefully we can have it for Monday, but I can't tell for sure as mi available time during the quarantine has been seized by my 3yo kid xD

Let's push forward to do it anyway!

@shekodn
Copy link

shekodn commented Apr 18, 2020

@leonelquinteros let's go for it! I'll aim for 4 since I don't have kids ;)

@raphaelhagi
Copy link
Contributor

I worked hard on pt-BR translation as my wife was pregnant. Now I'm a father of a little girl, called Melissa. :-D
Hopefully we can schedule a presentation of this work on the same day, for portuguese and spanish audiences!

@shekodn
Copy link

shekodn commented Apr 18, 2020

Congrats to you and your family @raphaelhagi !

We will need to review the translations. Any tip on this one? I was thinking about making a checklist with things such as making sure no links are broken and to check consistency among titles

@raphaelhagi
Copy link
Contributor

Thanks @leonelquinteros

@PauloASilva asks for updates on links to the new owasp website, and we did it on pt-BR version.

@shekodn
Copy link

shekodn commented Apr 20, 2020

Update: 2 more cards to translate (plus proofreading and fixing minor typos). Let's do this @leonelquinteros ? Is still Monday ;)

@ricardosupo
Copy link

ricardosupo commented Apr 20, 2020 via email

@shekodn
Copy link

shekodn commented Apr 20, 2020

Hi everyone, can you tell me what help you need actually? This topic email was in spam but I can help now. El lun., 20 abr. 2020 a las 10:32, Sergio Díaz ([email protected]) escribió:

Update: 2 more cards to translate (plus proofreading and fixing minor typos). Let's do this @leonelquinteros https://github.com/leonelquinteros ? Is still Monday ;) — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#22 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADNO4764CG7BZWM5ZA4ZKH3RNRTJTANCNFSM4IY7DC4A .
-- Ricardo

@ricardosupo Thanks again and feel free to assign yourself any card you want from https://github.com/leonelquinteros/API-Security/projects/1

We need to translate ch. 6 and peer review all the markdowns.

@leonelquinteros
Copy link
Author

Hi everyone,

I've pushed the last pending translation to the repo.
Should we send a PR and do the review on this repo? Or do you want to review on the fork?

@PauloASilva
Copy link
Collaborator

Hi @leonelquinteros,
If you're all done with the translation and proofreading, please open the PR.

I won't be able to review the text since I don't speak Spanish.
The best I can do is:

  • review Markdown formatting according to the .editorconfig in the repo
  • check whether hyperlinks are OK
  • check PDF/ODT overall look & feel

Cheers,
Paulo A. Silva

@leonelquinteros
Copy link
Author

Thanks @PauloASilva

We're done with the translation, but we're missing contributors for proofreading. I did a quick run myself, but I'd like to have some external eyes looking at it.
What do you think? Should we PR anyway?

@shekodn
Copy link

shekodn commented Apr 30, 2020

Thanks a lot, @leonelquinteros ! If you want we can proofread each other's work. Maybe @ricardosupo can also help? What bout asking in the Latam WhatsApp group?

@ricardosupo
Copy link

ricardosupo commented Apr 30, 2020 via email

@PauloASilva
Copy link
Collaborator

PauloASilva commented Apr 30, 2020 via email

@leonelquinteros
Copy link
Author

@PauloASilva I'll open the PR.
Please reach out to these channels as I don't have access to them.

Thanks!

@PauloASilva
Copy link
Collaborator

Hi @leonelquinteros,
It's done (Slack and ML).

Please subscribe the ML and follow the thread.

Cheers,
Paulo A. Silva

@JohnVargas
Copy link

Hi!
Can I help with translation??

@PauloASilva
Copy link
Collaborator

PauloASilva commented Oct 6, 2020

@JohnVargas I am sure your review, comments and suggestions will be more than welcome.
Check the comments in the PR: the ODT and PDF versions were missing, maybe you can work that out (some brief guidelines)

@leonelquinteros any progress with the ES translation?

Cheers,
Paulo A. Silva

PauloASilva pushed a commit that referenced this issue Jan 22, 2021
Update 0xaa-insufficient-logging-monitoring.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

8 participants