Fix: Readme #475

CodeWithEmad · 2024-08-01T09:04:47Z

This will introduce the following changes:

typo fixed: transiflex -> transifex
code-block added
heading symbol length
make heading dynamic for xblock cookiecutter
Old URL with 404 response updated

openedx-webhooks · 2024-08-01T09:04:51Z

Thanks for the pull request, @CodeWithEmad!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently unmaintained.

To get help with finding a technical reviewer, tag the community contributions project manager for this PR in a comment and let them know that your changes are ready for review:

On the right-hand side of the PR, find the Contributions project, click the caret in the top right corner to expand it, and check the "Primary PM" field for the name of your PM.
Find their GitHub handle here.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

itsjeyd · 2024-08-08T07:50:30Z

@CodeWithEmad Thank you for this contribution!

It looks like the tests will need a bit of work.

Once they're green we can mark this PR as ready for review.

CodeWithEmad · 2024-08-11T10:03:20Z

@itsjeyd Failed job has been resolved.

itsjeyd · 2024-09-07T08:32:51Z

Thanks @CodeWithEmad, I'll mark this PR as ready for review now.

OmarIthawi

Thanks @CodeWithEmad, please check the comments regarding OEP-58 updates

OmarIthawi · 2024-09-08T11:48:27Z

cookiecutter-xblock/{{cookiecutter.repo_name}}/README.rst

 See `transifex documentation <https://docs.transifex.com/integrations/django>`_ for more details about integrating
-django with transiflex.
+django with transifex.


Please link to https://docs.openedx.org/en/latest/developers/how-tos/enable-translations-new-repo.html instead.

OmarIthawi · 2024-09-08T11:49:20Z

cookiecutter-xblock/{{cookiecutter.repo_name}}/README.rst

@@ -127,7 +127,7 @@ The previous command will compile ``.po`` files using
 After compiling the ``.po`` file(s), ``django-statici18n`` is used to create language specific catalogs. See
 ``django-statici18n`` `documentation <https://django-statici18n.readthedocs.io/en/latest/>`_ for more information.

-To upload translations to transiflex use the follow Make target::
+To upload translations to transifex use the follow Make target:


Same here, make push_translations no longer exists as of OEP-58.

Oh, so I'll remove all references to push_translations command.

Please link to https://docs.openedx.org/en/latest/developers/how-tos/enable-translations-new-repo.html instead.

OmarIthawi · 2024-09-08T11:49:27Z

cookiecutter-xblock/{{cookiecutter.repo_name}}/README.rst

@@ -137,7 +137,7 @@ See `config instructions <https://github.com/openedx/i18n-tools#transifex-comman
 transifex credentials.

 See `transifex documentation <https://docs.transifex.com/integrations/django>`_ for more details about integrating
-django with transiflex.
+django with transifex.


I don't get what you mean by "same here".

Please link to https://docs.openedx.org/en/latest/developers/how-tos/enable-translations-new-repo.html instead.

OmarIthawi · 2024-09-08T11:51:35Z

cookiecutter-xblock/{{cookiecutter.repo_name}}/README.rst

@@ -22,9 +22,9 @@ Localization (l10n) is adapting a program to local language and cultural habits.

 Use the locale directory to provide internationalized strings for your XBlock project.
 For more information on how to enable translations, visit the
-`Open edX XBlock tutorial on Internationalization <https://edx.readthedocs.org/projects/xblock-tutorial/en/latest/edx_platform/edx_lms.html>`_.
+`Adding Translated Strings to your XBlock <https://edx.readthedocs.io/projects/xblock/en/latest/xblock-tutorial/edx_platform/edx_lms.html#adding-translated-strings-to-your-xblock>`_.


This is only applicable for non-openedx XBlocks.

github.com/openedx XBlocks has full atlas support:

And this link should be used instead:

https://docs.openedx.org/en/latest/developers/how-tos/enable-translations-new-repo.html

You're right.

itsjeyd · 2024-09-20T12:10:33Z

Thanks for providing a review for this PR @OmarIthawi!

@CodeWithEmad Please have a look at the failing tests when you can.

CodeWithEmad · 2024-09-23T12:17:30Z

My changes were pretty harmless and should not cause the tests to fail, @itsjeyd.
This is happening on other PRs like #488 too.
Also, see #484 (comment)

itsjeyd · 2024-09-26T13:55:27Z

Thanks for the details @CodeWithEmad. What's the next step here, then? Should we consider this PR blocked until someone does the work that @feanil described in #484 (comment)? I'm assuming you're not planning to do it yourself, but let me know if I got the wrong impression 🙂

CodeWithEmad · 2024-10-06T06:11:54Z

Sorry for not getting back to you sooner, @itsjeyd.
I guess #471 should take care of it.

itsjeyd · 2024-10-11T09:06:23Z

No worries @CodeWithEmad, and thanks for the details.

I'll mark this PR as blocked on #471, then.

itsjeyd · 2024-10-31T12:25:16Z

@CodeWithEmad Same note here, #471 has been merged so this PR should be unblocked now.

With this, we're not worried about teh size of the project_desc and the generated rst file is always working.

The size of the heading symbols should be the same size as the titles, otherwise might act funny in different environments

This will add a copy button + syntax highlighting in GitHub.

transiflex -> transifex

CodeWithEmad · 2024-10-31T21:31:26Z

It's done, @itsjeyd

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 1, 2024

CodeWithEmad force-pushed the fix/readme branch from d078efb to a1c3db4 Compare August 3, 2024 15:06

CodeWithEmad force-pushed the fix/readme branch from a1c3db4 to ff20b9d Compare August 11, 2024 10:02

itsjeyd added waiting for eng review PR is ready for review. Review and merge it, or suggest changes. needs reviewer assigned PR needs to be (re-)assigned a new reviewer labels Sep 7, 2024

OmarIthawi suggested changes Sep 8, 2024

View reviewed changes

CodeWithEmad force-pushed the fix/readme branch 2 times, most recently from 6e0c55f to 912a053 Compare September 15, 2024 12:31

OmarIthawi approved these changes Sep 18, 2024

View reviewed changes

itsjeyd removed needs reviewer assigned PR needs to be (re-)assigned a new reviewer waiting for eng review PR is ready for review. Review and merge it, or suggest changes. labels Sep 20, 2024

itsjeyd added the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Sep 20, 2024

CodeWithEmad mentioned this pull request Sep 23, 2024

chore: cleanup #474

Merged

CodeWithEmad force-pushed the fix/readme branch from 912a053 to e4d5b63 Compare October 6, 2024 09:47

itsjeyd added blocked by other work PR cannot be finished until other work is complete and removed waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels Oct 11, 2024

itsjeyd added waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. and removed blocked by other work PR cannot be finished until other work is complete labels Oct 31, 2024

CodeWithEmad added 2 commits October 31, 2024 19:47

fix: make heading dynamic

2f4626e

With this, we're not worried about teh size of the project_desc and the generated rst file is always working.

chore: heading symbol length

ba80105

The size of the heading symbols should be the same size as the titles, otherwise might act funny in different environments

chore: code-block added

5c8baf8

This will add a copy button + syntax highlighting in GitHub.

CodeWithEmad force-pushed the fix/readme branch from e4d5b63 to d86ee45 Compare October 31, 2024 16:17

CodeWithEmad added 3 commits November 1, 2024 00:51

chore: typo fixed

c07b2e4

transiflex -> transifex

fix: old links with 404 status updated

7864f08

chore: push_translations no longer exists as of OEP-58

6e6ea44

CodeWithEmad force-pushed the fix/readme branch from d86ee45 to 6e6ea44 Compare October 31, 2024 21:22

feanil approved these changes Nov 4, 2024

View reviewed changes

feanil merged commit 26118b9 into openedx:master Nov 4, 2024
5 checks passed

CodeWithEmad deleted the fix/readme branch November 4, 2024 22:02

itsjeyd removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Nov 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Readme #475

Fix: Readme #475

CodeWithEmad commented Aug 1, 2024 •

edited

Loading

openedx-webhooks commented Aug 1, 2024

itsjeyd commented Aug 8, 2024

CodeWithEmad commented Aug 11, 2024

itsjeyd commented Sep 7, 2024

OmarIthawi left a comment

OmarIthawi Sep 8, 2024

OmarIthawi Sep 8, 2024

CodeWithEmad Sep 15, 2024

OmarIthawi Sep 17, 2024

OmarIthawi Sep 8, 2024

CodeWithEmad Sep 15, 2024

OmarIthawi Sep 17, 2024

OmarIthawi Sep 8, 2024

CodeWithEmad Sep 15, 2024

itsjeyd commented Sep 20, 2024

CodeWithEmad commented Sep 23, 2024 •

edited

Loading

itsjeyd commented Sep 26, 2024

CodeWithEmad commented Oct 6, 2024 •

edited

Loading

itsjeyd commented Oct 11, 2024

itsjeyd commented Oct 31, 2024

CodeWithEmad commented Oct 31, 2024

Fix: Readme #475

Fix: Readme #475

Conversation

CodeWithEmad commented Aug 1, 2024 • edited Loading

openedx-webhooks commented Aug 1, 2024

What's next?

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

🔘 Let us know that your PR is ready for review:

Who will review my changes?

Where can I find more information?

When can I expect my changes to be merged?

itsjeyd commented Aug 8, 2024

CodeWithEmad commented Aug 11, 2024

itsjeyd commented Sep 7, 2024

OmarIthawi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

itsjeyd commented Sep 20, 2024

CodeWithEmad commented Sep 23, 2024 • edited Loading

itsjeyd commented Sep 26, 2024

CodeWithEmad commented Oct 6, 2024 • edited Loading

itsjeyd commented Oct 11, 2024

itsjeyd commented Oct 31, 2024

CodeWithEmad commented Oct 31, 2024

CodeWithEmad commented Aug 1, 2024 •

edited

Loading

CodeWithEmad commented Sep 23, 2024 •

edited

Loading

CodeWithEmad commented Oct 6, 2024 •

edited

Loading