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.

Sign up for GitHub

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

Jump to bottom

docs: add new language and fix translation errors | FC-0012 #469

Merged
merged 1 commit into from
Mar 27, 2024
Merged

docs: add new language and fix translation errors | FC-0012 #469

merged 1 commit into from
Mar 27, 2024

Conversation

OmarIthawi
Copy link
Member

@OmarIthawi OmarIthawi commented Feb 21, 2024 •
edited
Loading

Changes

Docs for policy and process for adding new language.

Questions and TODOs

  • Finish the documents
  • Double check on Language Removal policy
  • Double check on commitment policy

Refs

This pull request is part of the FC-0012 project which implements the Translation Infrastructure update OEP-58.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 21, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Feb 21, 2024 •
edited
Loading

Thanks for the pull request, @OmarIthawi! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@OmarIthawi OmarIthawi mentioned this pull request Feb 21, 2024
Open
@OmarIthawi OmarIthawi changed the title docs: add new language and fix translation errors docs: add new language and fix translation errors | FC-0012 Feb 21, 2024
@itsjeyd itsjeyd added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Feb 23, 2024
@OmarIthawi

This comment was marked as off-topic.

Sign in to view
@OmarIthawi OmarIthawi closed this Feb 27, 2024
@OmarIthawi OmarIthawi reopened this Feb 27, 2024
@OmarIthawi OmarIthawi marked this pull request as ready for review February 27, 2024 20:28
@OmarIthawi
Copy link
Member Author

@brian-smith-tcril @ehuthmacher I've added a policy in the add a language how-to document.

Please review it. I'm hoping you could provide some critical feedback, esp. on the language removal idea.

Let me know what do you think.

@OmarIthawi OmarIthawi force-pushed the add-new-language branch 2 times, most recently from 50b3a26 to 0df4215 Compare February 27, 2024 20:33
@ehuthmacher
Copy link

@OmarIthawi Thank you! I am looking at this page, which does not appear have the updated information in it. Can you send me a direct link to the policy? I do not seem to find it.

@brian-smith-tcril
Copy link
Contributor

@ehuthmacher you'll want to look at the PR deploy preview versions
https://docsopenedxorg--469.org.readthedocs.build/en/469/translators/how-tos/how-to-fix-translation-errors.html
https://docsopenedxorg--469.org.readthedocs.build/en/469/translators/how-tos/how-to-request-a-new-language.html

e0d
e0d approved these changes Feb 29, 2024
View reviewed changes
Copy link
Contributor

@e0d e0d left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One question for Eden to make sure this aligns with other places we may have documented similar details. For me this hits all the right notes, thanks for writing it up.

source/translators/how-tos/how-to-request-a-new-language.rst Outdated

* If you request a new language, we ask that you commit to the success of your
language’s translation project. Particularly, we expect you to:

* Be an active translator
* Be an active translator: Translate the ``edx-platform`` and main Micro-frontends such as Learning MFE and others.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ehuthmacher should we point to wherever you have documented requirements or are they covered here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@e0d @ehuthmacher This is a new requirement that I'm proposing. I suppose we need to further document it somewhere else.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ehuthmacher could you please check the changes proposed in this pull request?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@OmarIthawi The policy looks good to me. I will run it by the group on Wednesday to ensure that they are satisfied as well. I added it to our TX GH board. The only correction is, under the requirements section - "be an active translator of the openedx-translations project", rather than edx-platform.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@e0d All of our translation related documentation needs to be updated to reflect the TX project transition, under OEP-58. I will bring this up during our next TX meeting to see if someone has capacity to assist in this effort.

@OmarIthawi
Copy link
Member Author

@ehuthmacher I've updated the document to be less confusing in regards to the old project.

@ehuthmacher ehuthmacher mentioned this pull request Mar 20, 2024
Open
@sarina sarina merged commit 6e0a12f into openedx:main Mar 27, 2024
2 checks passed
@openedx-webhooks
Copy link

@OmarIthawi 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brian-smith-tcril brian-smith-tcril brian-smith-tcril approved these changes

@ehuthmacher ehuthmacher ehuthmacher approved these changes

@e0d e0d e0d approved these changes

Assignees
No one assigned
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@OmarIthawi @openedx-webhooks @ehuthmacher @brian-smith-tcril @e0d @itsjeyd @sarina