Skip to content

Commit

Permalink
fix: apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Brian Smith <[email protected]>
  • Loading branch information
OmarIthawi and brian-smith-tcril authored Sep 6, 2023
1 parent 3691dd5 commit a4aa32e
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions source/developers/how-tos/enable-translations-new-repo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ The next sections cover the steps to enable translations on a new repo depending
Python Django Plugins and XBlocks
=================================

To include a non-microservice Python repository (such as XBlock, Open edX plugin, or library) in the translations
To include a non-microservice Python repository (such as an XBlock, Open edX plugin, or library) in the translations
workflow:

#. If you are creating a new repository, use the: `edx-cookiecutters`_ templates such as ``django-app`` or ``xblock``.
#. If you are creating a new repository, use the `edx-cookiecutters`_ templates such as ``django-app`` or ``xblock``.

#. For existing repos which don't have the ``make extract_translations`` command, it can be copied from the
`edx-cookiecutters`_ Makefile in the corresponding template e.g. ``cookiecutter-xblock`` Makefile for XBlocks.
Expand Down Expand Up @@ -123,7 +123,7 @@ edX project. There are many Django microservices in the Open edX ecosystem, such

#. Create a draft pull request in the `openedx-translations repo`_

#. Follow the instructions in the :ref:`testing-in-your-fork` section to verify new repository configuration.
#. Follow the instructions in the :ref:`testing-in-your-fork` section to verify the new repository configuration.

#. Mark your pull request as ready for review and wait for it to be merged.

Expand Down Expand Up @@ -166,22 +166,22 @@ React Repos
Testing translations sync in your fork
======================================

Before submitting a pull request for review in the `openedx-translations repo`_, it's possible to test the workflow
in your fork by following the steps below:
Before submitting a pull request for review in the `openedx-translations repo`_, you should test the workflow
on a fork by following the steps below:

#. Fork the `openedx-translations repo`_.
#. Make a pull request in your fork and modify the `extract-translation-source-files.yml`_ workflow to include your
#. Make a pull request to your fork and modify the `extract-translation-source-files.yml`_ workflow to include your
repo and your organization name ...... **TODO:** add example https://github.com/Zeit-Labs/openedx-translations/pull/1/files

**TODO:** Add full test instructions like Shadi, Brian and Omar tested in their forks.

#. Add any test translations to your fork of the `openedx-translations repo`_ in the repo directory to overcome the
fact that translations don't exist on the upstream `openedx-translations repo`_ yet.
fact that translations don't exist in the upstream `openedx-translations repo`_ yet.

We recommend copying an existing translations. For example to test `credentials`_ we would copy the
`course discovery translations`_ and modifying it to include `credentials`_ conf/locale.
We recommend copying existing translations. For example to test `credentials`_ we would copy the
`course discovery translations`_ directory and modify it to include `credentials`_ conf/locale.

#. Temporarily edit the ``Makefile`` so the ``pull_translations`` step pulls via your fork e.g.
#. Temporarily edit the ``Makefile`` so the ``pull_translations`` step pulls from your fork e.g.
``atlas pull --repository=Zeit-Labs/openedx-translations``.

#. If you're testing and Open edX plugin, run the ``$ OPENEDX_ATLAS_PULL=true make pull_translations`` command in
Expand All @@ -190,7 +190,7 @@ in your fork by following the steps below:

#. Run the application (or plugin) and verify the translations you've added are working properly.

This step assumes that you're already familiar with `Tutor`_ and/or `devstack`_.
**Note:** This step assumes that you're already familiar with `Tutor`_ and/or `devstack`_.


.. _debugging-translations:
Expand All @@ -199,7 +199,7 @@ in your fork by following the steps below:
Debugging translations workflows
================================

After adding a repository to the `openedx-translations repo`_ verify the following in the next day:
After adding a repository to the `openedx-translations repo`_ verify the following the next day:

#. The `extract-translation-source-files.yml`_ GitHub workflow worked successfully and the build passes in the
`openedx-translations GitHub Actions tab`_. If something fails, ask for help in the `#wg-translations`_ Open edX
Expand All @@ -211,8 +211,8 @@ After adding a repository to the `openedx-translations repo`_ verify the followi
#. Ensure the new Transifex resource is 100% translated. Alternatively, Open edX Transifex admins can force sync via
the "Manual Sync" button in the `Transifex GitHub App sync logs`_ page.

#. Wait for the next sync to kick in. The sync is managed by Transifex and usually it kicks in less than an hour
which we'll verify in the next step. The `Transifex GitHub App sync logs`_ shows the most recent sync results.
#. Wait for the next sync. The sync is managed by Transifex and usually takes less than an hour
(which we'll verify in the next step). The `Transifex GitHub App sync logs`_ show the most recent sync results.

#. Verify that the Transifex GitHub App created sync pull requests and auto-merged it to the repo.
An example of a successfully merged pull request is the
Expand Down

0 comments on commit a4aa32e

Please sign in to comment.