InnerSource patterns book translation into Brazilian Portuguese

[jrcosta]

Pull Request: InnerSource patterns book translation into Brazilian Portuguese

Hello!

We'd like to submit our translation of the "InnerSource Patterns Book" for review and inclusion in the repository. This pull request includes the following files and changes:

• Translated all the structured patterns into Brazilian Portuguese. The translation can be found under /translation/pt
• Proofread all the document
• Linted markdown files
• Edited the ToC generation script and templates

Motivation:

We made this translation with the goal of making the valuable content of the "InnerSource Patterns Book" accessible to the Portuguese-speaking community. I believe that this translation will significantly benefit those who wish to learn about InnerSource and its practices.

Progress:

The translation has undergone initial completion and is now ready for the next phase of thorough review and revisions. While the primary content has been translated, there might still be areas that require fine-tuning for accuracy, coherence, and consistency. Your valuable feedback and suggestions will greatly contribute to refining the quality of the translated content. I am committed to working closely with the community to address any issues that arise during the review process.

Thank you for your time and consideration in reviewing this pull request.

Best regards,
Eneri Junior

[jrcosta]

@jrcosta Would it be ok to add you to our CODEOWNERS file?

That would mean that if new PRs are sent in the future that contain changes to the Brazilian Portuguese files, you would automatically be added to the PR as a reviewer. That would help us a lot, as the core maintainers of the repo don't speak that language :)

We can add multiple people per language, so if @zilio would like to do future reviews, I am happy to add you too :)

Sure, you can add me. I would be happy to help! 🚀 😄

[jrcosta]

Thank you all I summarized Pros and Cons here...

If there are no psychological blockers, adopting # 2 is the best from an SEO perspective, and this seems to be the best for the recent and future. In the future, however, we should aim for # 3. It feels more inclusive that way. At least zh-CN and ja-JP don't have tremendous traffic or a lot of external links. en is the default language, and since the locale doesn't appear in the URL, it's not much of a problem. I wonder if other languages will be moved to ja-JP, cn-CN as soon as the SEO problem is solved.

Would like to hear your opinion.

Option 1: Use pt for Brazilian Portuguese

Pros Cons
Simplifies the code structure Doesn't distinguish between dialects
Consistent with existing codes May confuse or alienate non-Brazilian Portuguese speakers
Less verbose Makes it harder to add European Portuguese in the future

Option 2: Use pt-br for Brazilian Portuguese

Pros Cons
Clearly indicates the dialect Inconsistent with existing codes
Allows for future dialects (pt-pt) More verbose
Targets a specific audience precisely While English also has en-US and en-GB, en is adopted for American English, It seems a little strange that only Brazilian Portuguese includes pt-br while pt is absent

Option 3: Change All Codes to Include Region (e.g., ja-JP, zh-CN)

Pros Cons
Standardizes the format for all languages It would break all previous links
Explicitly identifies dialects Makes URLs and directory structure more verbose
Allows for flexibility in adding new dialects Requires change codes and documentation
GitBook.com appears to allow content redirection but not URL redirection. This means there is no way to redirect /en -> /en-US. So existing content is affected and some hack is needed.

hi @yuhattor, Monday will talk with @zilio about that, for reply better here, ok?

[spier]

Love the level of consideration that everybody is given the topic of pt vs pt-br.
Just want to make sure that we are not overthinking this and ending in analysis paralysis :)

My opinion on this topic starts with a question (sorry if that has already been answered):
Is Brazilian Portuguese so different from European Portuguese that speakers of both languages won't understand written text in the respective other language?

My opinion about implementation

I am leaning for option (2), as it is quick to implement and "correct enough for my point of view.

Changes required on a folder/configuration level:

• renaming folder to pt-br
• changing configuration values in the scripts from pt to pt-br

To add another angle, let's consider the user as well (i.e. the reader of our book).
The user sees the language in these places¹:

• language selection at the top left
• sub-string as part of the URL
• (new) possible a country flag in front of the language selection

I am suggesting to implement this as shown in the screenshot below.
Note that to make it even more clear which language we are talking about, I have a country flag in front of the language selection. May not work so well for languages spoken in many countries but I guess for now it is ok?

I have already configured it like this on Staging, so that you can click around:
https://innersourcecommons.gitbook.io/innersource-patterns-staging/v/pt-br/

(once deployed to production the URL will be https://patterns.innersourcecommons.org/v/pt-br/)

Note to self:
The flags (emojis) that I copied into the space titles are from here: https://emojiguide.com/flags/flag-united-states/

Footnotes

1. The configuration that the user sees is completely independent of the values we are using on the folder and configuration level. ↩

[DanielleAlmeida]

Mudaria de "trapaças" para "incrédulo": "Existe desconfiança em relação às contribuições devido a um histórico incrédulo: equipes enviaram contribuições incompletas e posteriormente solicitaram correções para torná-las prontas para uso em produção."

[DanielleAlmeida]

I´d like to suggest to change: from the word "cheating" (trapaças" in portguese - Brazil) to "unbelieving" (incrédulos).

[zilio]

Olá @DanielleAlmeida, fazendo a adaptação para utilizar o incrédulo, não sei se passa a mensagem adequada para esse tópico, pois "incredulidade" geralmente se refere a uma falta de crença ou dúvida sobre algo, e não necessariamente a atos de enganação ou trapaça.

Existe desconfiança em relação às contribuições devido a um histórico de incredulidade: equipes enviaram contribuições incompletas e posteriormente solicitaram correções para torná-las prontas para uso em produção.

Talvez utilizar como os Japoneses fizeram e utilizar a expressão "devido a um histórico de má conduta" para indicar de forma mais clara que no passado os desenvolvedores entregaram código incompleto.

Existe desconfiança em relação às contribuições devido a um histórico de má conduta: equipes enviaram contribuições incompletas e posteriormente solicitaram correções para torná-las prontas para uso em produção.

[spier]

As an aside: Great to see even more collaboration on the translation 🥳 Thank you @DanielleAlmeida!

[spier]

@jrcosta one idea that may seem slightly strange but let me share it anyways:

As @zilio and you were already two people working on this translation, one might argue that one round of verification/review of the translation has already happened.

Therefore what we could do is to release the current version of this translation as is, and then let further reviews/fixes of the translations happen one-by-one in further PRs in the future.

It would allow us to get the first version of this translation published quickly, so that people in Brazil can already benefit from it. Even if small mistakes (or wrong translations) may still exist.

What would you think about that approach?

Do we have anything to loose?

[jrcosta]

My opinion on this topic starts with a question (sorry if that has already been answered): Is Brazilian Portuguese so different from European Portuguese that speakers of both languages won't understand written text in the respective other language?

At this juncture, we require a proficient PT-PT speaker to validate. In my opinion, it's easy to use, but I lack extensive knowledge of this language to make this assertion.

My opinion about implementation

I am leaning for option (2), as it is quick to implement and "correct enough for my point of view.

Changes required on a folder/configuration level:

• renaming folder to pt-br
• changing configuration values in the scripts from pt to pt-br

Taking into account what I mentioned earlier, in my view, option 2 is the most favorable. Can I proceed with implementing the changes to utilize this option, or should I wait for further approval?

[spier]

Can I proceed with implementing the changes to utilize this option, or should I wait for further approval?

@jrcosta yes please, go ahead :)
Doing a git mv pt pt-br within the translation folder should get you there.

[jrcosta]

@jrcosta one idea that may seem slightly strange but let me share it anyways:

As @zilio and you were already two people working on this translation, one might argue that one round of verification/review of the translation has already happened.

Therefore what we could do is to release the current version of this translation as is, and then let further reviews/fixes of the translations happen one-by-one in further PRs in the future.

It would allow us to get the first version of this translation published quickly, so that people in Brazil can already benefit from it. Even if small mistakes (or wrong translations) may still exist.

What would you think about that approach?

Do we have anything to loose?

Regarding that, following a conversation with @zilio and @DanielleAlmeida (who were already reviewing it), we share the unanimous opinion that it would indeed be a good idea to publish it now as an initial book. As the community starts using it, corrections may arise, and we will review and implement them.

I would like to request that we also add @DanielleAlmeida to the list of contributors when the pull request is ready. She was willing and had already begun reviewing. Is this possible, @spier?

[spier]

Yes, you can add her to the respective files in the footer.

We can also add her to the PR as a co-author.

Should I already merge and publish the book, or are there other things that you want to do before that?

[spier]

FYI I already put the latest version of this branch on Staging. Looks like it all works fine from the pt-br folder:
https://innersourcecommons.gitbook.io/innersource-patterns-staging/v/pt-br/

[spier]

@jrcosta I just saw that the pt-br translation of https://innersourcecommons.org was announced today (in slack).

So if you could confirm that I can merge this branch, then I could get this published today as well, making for a nice double punch for Português Brasileiro in the InnerSource Commons :)

[jrcosta]

@jrcosta I just saw that the pt-br translation of https://innersourcecommons.org was announced today (in slack).

So if you could confirm that I can merge this branch, then I could get this published today as well, making for a nice double punch for Português Brasileiro in the InnerSource Commons :)

Hello, @spier! What fantastic news!

As for the other patterns that need to be translated and the necessary changes, along with mentions and more, I can include them in another pull request. In regard to this one, feel free to publish it.

[welcome]

Congrats on merging your first pull request! 🎉 We here at The InnerSource Commons are proud of you! 💖 Thank you so much for your contribution 🎁

[spier]

@jrcosta @zilio @DanielleAlmeida I can only second what our bot said above: Thank you :)

This has been a fantastic contribution, and super smooth process (from my side at least).

If you want to share any insights into how the contribution process went for you, and maybe what could be improved for contributions of new languages (or translations of new patterns for existing languages) in the future, please do!

Thanks again, you rock!

[jrcosta]

@jrcosta @zilio @DanielleAlmeida I can only second what our bot said above: Thank you :)

This has been a fantastic contribution, and super smooth process (from my side at least).

If you want to share any insights into how the contribution process went for you, and maybe what could be improved for contributions of new languages (or translations of new patterns for existing languages) in the future, please do!

Thanks again, you rock!

I appreciate your words, @spier. As my first contribution to a project, I can say that I felt very at ease, and your support was essential for that. Thank you!