Translating Content: Translate the handbook into other languages to reach a broader audience.

[speco29]

The most spoken language in the world by number of native speakers is Mandarin Chinese. With over a billion native speakers, it's the primary language of the majority of people in China, Taiwan, and Singapore.
It can help to reach broader audience to organize different events.
We can add five major languages in our project, let me know your views on that thought ;)

[aterrel]

There are several issues #53 and #54 already talking about translating content. It's a larger project that will take some time to get correct. It requires folks to create a system for:

1. generating the translation
2. adding switches in the book for the selecting languages
3. having a way to update the translations as the book changes in content
4. have a call for translaters to sign up and get tagged.

I recommend writing out a proposal that encompasses all this.

[speco29]

I will look through it on how to write prroposal, can you give me a heads-up like writing proposal and whom to send?
it would be really helpful:)

[aterrel]

I think you can just add your plan here. Basically say what you are doing, your technical approach, and how you we are going to accommodate the list of issues I mentioned.

[aterrel]

Hey @speco29 did you have any updates from your proposal?

[speco29]

Yes, It's my first time writing a proposal, i tried to put everything came up on my mind.
I made a readme file for it.

[speco29]

Here's the proposal

Translation Project for Discover-Cookbook

Introduction
The discover-cookbook is a valuable resource for culinary enthusiasts. Translating the content will make it accessible to a broader audience, fostering a global community of users.

Objectives
-Generate translations for the discover-cookbook.
-Integrate language selection switches within the book.
-Implement a system for updating translations as content changes.
-Engage and tag translators to contribute to the project.

1)Generating Translations
What We Are Doing: Translating the entire content of the discover-cookbook into multiple languages.

Technical Approach:
-Evaluate and select a reliable translation tool or service (e.g., Google Translate, Microsoft Translator).
-Establish a workflow for translating existing content, ensuring consistency and accuracy.

2) Adding Language Switches
What We Are Doing: Integrating switches within the book to allow users to select their preferred language.

Technical Approach:
-Identify and implement language switch mechanisms (e.g., dropdown menus, toggle buttons) within the book's platform.
-Test the functionality across different devices and browsers to ensure seamless language switching.

3) Updating Translations
What We Are Doing: Developing a system to update translations as the book's content changes.

Technical Approach:
-Create a process for tracking changes in the original content.
-Implement a notification system to inform translators of updates.

4) Engaging Translators
What We Are Doing: Calling for translators to sign up and get tagged for their contributions.

Technical Approach:
-Announce a call for translators on relevant platforms (e.g., social media, forums, community websites).
-Develop a tagging system to acknowledge and credit translators for their contributions.
-Provide resources and support for translators to ensure high-quality translations (e.g., guidelines, glossaries, support forums).

Timeline(I'm not sure how much time will it take for these contents, but to get a clear view for each step, I'm adding timeline here)
Phase 1: Initial translation of existing content .

Phase 2: Integration of language switches .

Phase 3: System for updating translations .

Phase 4: Engagement and onboarding of translators.

Resources
-Translation tools/services
-Developers for implementing language switches

Conclusion
Translating the discover-cookbook will significantly enhance its reach and impact, making it accessible to a global audience. By implementing a robust system for translation, language selection, and updates, and engaging a dedicated team of translators, we can ensure the success of this project.

[aterrel]

@speco29 Okay we should just follow the way Matplotlib handles this as a lightweight process in a docs repository. I've added the directory docs/proposals then we can check in your proposal there.

It's easier to comment inline there as this proposal is a bit too vague to be implemented.

@kamila-NF the numfocus gsoc docs say I need 2 mentors, okay to put you down as the back up mentor?

[speco29]

@speco29 Okay we should just follow the way Matplotlib handles this as a lightweight process in a docs repository. I've added the directory docs/proposals then we can check in your proposal there.

It's easier to comment inline there as this proposal is a bit too vague to be implemented.

@kamila-NF the numfocus gsoc docs say I need 2 mentors, okay to put you down as the back up mentor?

should I enhance this proposal a bit more?
or is it fine enough to make a PR of it?

[aterrel]

@speco29 please make a pull request with your proposal. We can update it in the review process. Also you might use this template for this case: It comes from the NumFOCUS gsoc student guide and will be the correct format for submitting to GSOC when the time comes.

[speco29]

Ok, I'll make the PR.
let me know if any changes needed;)

[speco29]

Hello @aterrel
I'm trying to make a PR for proposal, but my previous commits keep getting added with the proposal, even though the branches are different.
how do I remove them?

[aterrel]

You need to create a new branch for each PR you plan on making.

git checkout main
git checkout -b my_new_branch
<do work>
git commit -a ..

Of if you are using the Github UI, you gotta create the new branch and make sure you are on it.

If you put changed on a branch and they aren't too different you can do a few things, all I know are command line based. Probably the most straight forward is an interactive rebase:

interactive rebase and remove branchs

git checkout bad_branch
git checkout -b new_branch
git rebase i <sha_of_commit_before_bad_branch>
... add delete to  commits to remove ...
git log # make sure the new_branch looks correct

Here is contrived example for you where I have two commits and I want to remove the one before:

$ git log --format=short --graph --abbrev-commit --pretty=format:'%h - %d %s %cr <%an>'          
* 344d8d1 -  (HEAD -> main) Adding good commit 4 minutes ago <Andy R. Terrel>
* d534527 -  adding bad commmit 5 minutes ago <Andy R. Terrel>
* 04a56b7 -  (origin/main, origin/HEAD) Update README.md to use .venv 2 days ago <Andy R. Terrel>
*   266d171 -  Merge pull request #202 from aterrel/fix-build-pages-action 6 days ago <Andy R. Terrel>

So we see sha 04a56b7, and that is before the bad commit. The interactive rebase gives use the following:

$ git rebase -i 04a56b7
  1 pick d534527 adding bad commmit
  2 pick 344d8d1 Adding good commit
  3 
  <snip>

We change the bad commit to say drop instead of pick like this:

  1 drop d534527 adding bad commmit
  2 pick 344d8d1 Adding good commit
  3 
  <snip>

And you should get response like: Successfully rebased and updated refs/heads/main. when you save it, with the log now:

$ git log --format=short --graph --abbrev-commit --pretty=format:'%h - %d %s %cr <%an>'        
* c8f0348 -  (HEAD -> main) Adding good commit 48 seconds ago <Andy R. Terrel>
* 04a56b7 -  (origin/main, origin/HEAD) Update README.md to use .venv 2 days ago <Andy R. Terrel>
*   266d171 -  Merge pull request #202 from aterrel/fix-build-pages-action 6 days ago <Andy R. Terrel>

Here is a more comprehensive guide as I can think of two other ways to do this but I don't want to overwhelm.

[speco29]

hello @aterrel
Please check this repo once - https://github.com/speco29/Translation
I've created one example file on how can we add switch, let me know if it looks okay.