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.

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

docs: add seealso for oep58 in enable-translations-new-repo.rst #383

Closed
wants to merge 31 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
180ea17
docs: add OEP-58 overview to developer concepts
brian-smith-tcril Aug 2, 2023
14d3d9f
docs: limit developer concepts TOC max depth to 2
brian-smith-tcril Aug 2, 2023
e7ed3d8
chore: pull in legacy dev guide from edx-documentation
brian-smith-tcril Aug 1, 2023
e3ca6d3
docs: add legacy guide to TOC
brian-smith-tcril Aug 1, 2023
d4c5dfd
fix: update legacy dev docs to build on new site
brian-smith-tcril Aug 1, 2023
565c761
chore: Updating Python Requirements
edx-requirements-bot Aug 6, 2023
a004587
Merge pull request #365 from openedx/jenkins/upgrade-python-requireme…
Aug 7, 2023
7cb564c
docs: add Palm.2 to list of releases
mtyaka Aug 9, 2023
8d2a682
docs: Update 'install tutor nightly' command
apexDev37 Aug 10, 2023
7bf28e0
docs: Add a maintainers homepage.
feanil Aug 11, 2023
04700fe
Merge pull request #367 from openedx/mtyaka/add-new-release
arbrandes Aug 11, 2023
d6ca011
docs: clarify that visual problem editor is not the default in Palm (…
kdmccormick Aug 15, 2023
10a1411
docs: use markdown for npm published READMEs
brian-smith-tcril Aug 17, 2023
e2fb852
docs: Updated based on PR feedback.
feanil Aug 17, 2023
095b8b9
Merge pull request #369 from openedx/feanil/maintainer_home
Aug 18, 2023
67cb107
chore: Updating Python Requirements
edx-requirements-bot Aug 20, 2023
4dba611
Merge pull request #372 from openedx/jenkins/upgrade-python-requireme…
Aug 22, 2023
d1960b7
Merge pull request #368 from apexDev37/docs-update-tutor-command
Aug 22, 2023
c7520c3
chore: Updating Python Requirements
edx-requirements-bot Aug 27, 2023
37348eb
Merge pull request #373 from openedx/jenkins/upgrade-python-requireme…
Aug 29, 2023
6e7c748
fix: readthedocs file renamed
edx-requirements-bot Sep 1, 2023
9da62b0
Merge pull request #375 from openedx/jenkins/zshkoor/readthedocs-37348eb
Sep 1, 2023
e38849c
Merge pull request #371 from brian-smith-tcril/md-readmes-for-npm
Sep 1, 2023
a7dd310
chore: Updating Python Requirements
edx-requirements-bot Sep 3, 2023
ede8833
Merge pull request #376 from openedx/jenkins/upgrade-python-requireme…
Sep 5, 2023
80d3ce1
chore: Updating Python Requirements
edx-requirements-bot Sep 10, 2023
149cc9f
Merge pull request #378 from openedx/jenkins/upgrade-python-requireme…
Sep 12, 2023
a30582e
chore: Updating Python Requirements
edx-requirements-bot Sep 17, 2023
2254c13
Merge pull request #379 from openedx/jenkins/upgrade-python-requireme…
Sep 18, 2023
7b75183
Merge branch 'main' into seealso
OmarIthawi Sep 20, 2023
d7d2746
docs: add seealso for oep58 in enable-translations-new-repo.rst
OmarIthawi Sep 20, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
10 changes: 5 additions & 5 deletions requirements/base.txt
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ packaging==23.1
# via
# pydata-sphinx-theme
# sphinx
pydata-sphinx-theme==0.13.3
pydata-sphinx-theme==0.14.0
# via sphinx-book-theme
pygments==2.15.1
pygments==2.16.1
# via
# accessible-pygments
# pydata-sphinx-theme
# sphinx
pytz==2023.3
pytz==2023.3.post1
# via babel
requests==2.31.0
# via
Expand All @@ -58,7 +58,7 @@ six==1.16.0
# via livereload
snowballstemmer==2.2.0
# via sphinx
soupsieve==2.4.1
soupsieve==2.5
# via beautifulsoup4
sphinx==6.2.1
# via
Expand Down Expand Up @@ -102,7 +102,7 @@ sphinxcontrib-youtube==1.2.0
# via -r requirements/base.in
sphinxext-rediraffe==0.2.7
# via -r requirements/base.in
tornado==6.3.2
tornado==6.3.3
# via livereload
typing-extensions==4.7.1
# via pydata-sphinx-theme
Expand Down
12 changes: 8 additions & 4 deletions requirements/pip-tools.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@
#
# make upgrade
#
build==0.10.0
build==1.0.3
# via pip-tools
click==8.1.6
click==8.1.7
# via pip-tools
importlib-metadata==6.8.0
# via build
packaging==23.1
# via build
pip-tools==7.1.0
pip-tools==7.3.0
# via -r requirements/pip-tools.in
pyproject-hooks==1.0.0
# via build
Expand All @@ -19,8 +21,10 @@ tomli==2.0.1
# build
# pip-tools
# pyproject-hooks
wheel==0.41.0
wheel==0.41.2
# via pip-tools
zipp==3.16.2
# via importlib-metadata

# The following packages are considered to be unsafe in a requirements file:
# pip
Expand Down
4 changes: 2 additions & 2 deletions requirements/pip.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
#
# make upgrade
#
wheel==0.41.0
wheel==0.41.2
# via -r requirements/pip.in

# The following packages are considered to be unsafe in a requirements file:
pip==23.2.1
# via -r requirements/pip.in
setuptools==68.0.0
setuptools==68.2.2
# via -r requirements/pip.in
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ Palm
- 2023-06-14
- open-release/palm.1

* - Palm.2
- 2023-08-09
- open-release/palm.2

Olive
=====

Expand All @@ -75,6 +79,10 @@ Olive
- 2023-04-11
- open-release/olive.3

* - Olive.4
- 2023-05-22
- open-release/olive.4

Nutmeg
======

Expand Down
5 changes: 2 additions & 3 deletions source/community/release_notes/palm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,16 +97,15 @@ Instructor Experiences
New Visual Problem Editor
=========================

The release includes an improved problem-authoring experience with an interactive editor. Writing markdown
The release includes an experimental improved problem-authoring experience with an interactive editor. When enabled, writing markdown
code is no longer necessary. But, the advanced mode is still available, maintaining the ability to write and edit
OLX XML.

The Open edX wiki page `[2U] New Visual Problem Editor <https://openedx.atlassian.net/wiki/spaces/OEPM/blog/2023/04/07/3724312593/2U+New+Visual+Problem+Editor>`_
provides a brief explanation of what has changed in the problem editor. Updated detailed instructions on writing
problems can be found in section `8.4. Working with Problem Components <https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/course_components/create_problem.html#working-with-problem-components>`_ of the Building and Running an edX Course documentation.

The visual problem editor is an update to the Course Authoring Micro-frontend first released in Olive and is enabled by
default in Palm. To enable the Visual Problem Editor, add the waffle flag
The Visual Problem Editor is hosted in the existing Course Authoring Micro-frontend. To enable the Visual Problem Editor, add the waffle flag
:code:`new_core_editors.use_new_problem_editor` and set the value to “Yes” for all users.

New ORA Grading Experience
Expand Down
1 change: 1 addition & 0 deletions source/developers/concepts/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Concepts Home
#############

.. toctree::
:maxdepth: 2
:glob:

*
Expand Down
79 changes: 79 additions & 0 deletions source/developers/concepts/oep58.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
OEP-58 Overview
###############

What is OEP-58?
===============

OEP-58 is a project to streamline translations management throughout the Open edX project.

How translations are managed now
================================

Where translations currently live
---------------------------------

Translations currently live in 2 places.

* In each repository in the form of ``.mo``, ``.po``, and ``.json`` files.
* In the ``edx-platform`` transifex project.

How translations are written
----------------------------

Translators edit translations in the ``edx-platform`` transifex project

How translations get into repositories from transifex
-----------------------------------------------------

Each repository has a jenkins job that:

* Pulls updated translations from transifex via the `deprecated`_ v2 api
* Commits the updated translations directly to the repo as `edx-transifex-bot`_

How translations currently get deployed
---------------------------------------

Translations are files in a repository that are built and deployed with the rest of the code.

How translations will be managed post OEP-58
============================================

Where translations will live
----------------------------

* In the `openedx-translations repository`_
* In the ``openedx-translations`` transifex project

How translations will be written
--------------------------------

Translators will edit translations in the ``openedx-translations`` transifex project

How translations will get from transifex to the `openedx-translations repository`_
----------------------------------------------------------------------------------

Translations will be committed to the `openedx-translations repository`_ via the supported `Transifex Integration GitHub App`_

How translations will be deployed
---------------------------------

The build process for each repository will be updated to use `openedx-atlas`_ to pull translations from the `openedx-translations repository`_.

What needs to happen for a repository to make the switch
--------------------------------------------------------
* The build process must be updated to support using `openedx-atlas`_ to pull translations from the `openedx-translations repository`_
* The repository must be configured to use the `openedx-atlas`_ method at build time
* The `openedx-translations repository`_ must be updated to include the source strings
* Translations must exist in the ``openedx-translations`` transifex project

Additional reading
==================
* `OEP-58: Translations Management — Open edX Proposals 1.0 documentation <https://open-edx-proposals.readthedocs.io/en/latest/architectural-decisions/oep-0058-arch-translations-management.html>`_
* `openedx-atlas README <https://github.com/openedx/openedx-atlas/blob/main/README.rst>`_
* `openedx-translations README <https://github.com/openedx/openedx-translations/blob/main/README.rst>`_

.. _deprecated: https://community.transifex.com/t/important-reminder-api-tx-cli-deprecation/3202
.. _edx-transifex-bot: https://github.com/edx-transifex-bot
.. _openedx-translations repository: https://github.com/openedx/openedx-translations
.. _Transifex Integration GitHub App: https://github.com/apps/transifex-integration
.. _openedx-atlas: https://github.com/openedx/openedx-atlas
2 changes: 2 additions & 0 deletions source/developers/how-tos/enable-translations-new-repo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ To enable translations on a new repository according to the `OEP-58 - Translatio
for Python)
- Configure the repository according to the appropriate section later in this document.

.. seealso::
:doc:`/developers/concepts/oep58`

Configuration
*************
Expand Down
21 changes: 21 additions & 0 deletions source/developers/how-tos/ongoing-maintainers-tasks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,27 @@ As a part of bringing your repository into alignment with the standards of the p

Keeping your dependencies up-to-date on a regular basis is both lest costly and more secure than waiting a long time between package updates. It is recommended that you **apply all security fix on packages you depend on within weekly**. For automated PRs that don't contain security updates to dependent packages it is still recommended that you triage them on a weekly basis. Schedule any complex upgrades in a timely manner - you don't want to be in a situation where it becomes an emergency to land them (whether to get new features or apply a major security fix).

Approving GitHub Actions for new committer PRs
**********************************************

.. note::

This process is only for contributors that already have passed the CLA check, for those that haven’t please follow the normal process for helping the contributor onboard.

When a user opens their first PR in a repository you maintain it is likely that they will need to be approved before some Github Actions, such as tests, will run. This is to protect us all from having malicious code run in our account as part of our test suite.

When this occurs the orange “Approve and run“ will appear for the PR.

The current process for this is to:

1. Look over the PR to make sure that it is legitimate and there are no malicious changes.

a. In the event of a questionable or malicious looking change, please notify #maintainers-pilot in Slack to warn other maintainers and allow us to take appropriate action.

2. Any maintainer or Axim employee with write permissions on the repository can approve the PR after step 1 has been completed. This should only need to be done once per contributor per repository.

3. Once the PR is unblocked, the rest of the approval process should work as normal.

Participating in Forum Discussions
**********************************

Expand Down
23 changes: 21 additions & 2 deletions source/developers/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ Open edX Developers
:class-card: sd-shadow-md sd-p-2
:class-footer: sd-border-0

* :doc:`how-tos/maintain-a-repo`
* :doc:`how-tos/enable-python-upgrade-automation`
* :doc:`how-tos/enable-javascript-upgrade-automation`
+++
Expand Down Expand Up @@ -59,7 +58,6 @@ Open edX Developers
:class-card: sd-shadow-md sd-p-2
:class-footer: sd-border-0

* :doc:`references/tools_for_maintainers`
* :doc:`references/internal_data_formats/index`
* `edx-platform <https://github.com/openedx/edx-platform>`_
* `frontend-platform <https://openedx.github.io/frontend-platform>`_
Expand All @@ -70,3 +68,24 @@ Open edX Developers
:expand:

More References

.. grid-item-card:: Maintainers Home
:class-card: sd-shadow-md sd-p-2
:class-footer: sd-border-0

* :doc:`how-tos/maintain-a-repo`
* :doc:`how-tos/ongoing-maintainers-tasks`
* :doc:`references/tools_for_maintainers`

+++
.. button-ref:: maintainers_home
:color: primary
:outline:
:expand:

Maintainers Home

.. toctree::
:hidden:

maintainers_home
49 changes: 49 additions & 0 deletions source/developers/maintainers_home.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
Maintainers Home
################

.. grid:: 1 2 2 2
:gutter: 3
:padding: 0

.. grid-item-card:: How-tos
:class-card: sd-shadow-md sd-p-2
:class-footer: sd-border-0

* :doc:`how-tos/maintain-a-repo`
* :doc:`how-tos/ongoing-maintainers-tasks`

.. grid-item-card:: References
:class-card: sd-shadow-md sd-p-2
:class-footer: sd-border-0

* :doc:`references/tools_for_maintainers`
* `Maintainers Slack Channel`_

.. grid-item-card:: Process Documentation
:class-card: sd-shadow-md sd-p-2
:class-footer: sd-border-0

* `Maintainership Wiki Space`_
* `Maintainers Scrum of Scrums Notes`_
* `Maintainers Office Hours Notes`_

Concepts Documentation
**********************

* :doc:`openedx-proposals:processes/oep-0055-proc-project-maintainers` - The
OEP that kicked off the maintainership program.

* `Community Contributions Project Manager`_ - The role definition for the
Community Project Managers. They help triage community PRs and coordinate
reviews from subject matter experts.

.. _Maintainers Slack Channel: https://openedx.slack.com/archives/C03R320AFJP

.. _Maintainers Office Hours Notes: https://openedx.atlassian.net/wiki/spaces/COMM/pages/3603791889/Office+Hours+Notes

.. _Maintainers Scrum of Scrums Notes: https://openedx.atlassian.net/wiki/spaces/COMM/pages/3507027983/Maintainers+Scrum+of+Scrums

.. _Maintainership Wiki Space: https://openedx.atlassian.net/wiki/spaces/COMM/pages/3426844690/Maintainership+Pilot

.. _Community Contributions Project Manager: https://openedx.atlassian.net/wiki/spaces/COMM/pages/3548807177/Community+Contributions+Project+Manager

2 changes: 1 addition & 1 deletion source/developers/quickstarts/first_openedx_pr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Answer them however you like, although the default answers will work fine.

.. code-block:: bash

tutor dev quickstart
tutor dev launch

Depending on your system and your Internet connection speed,
this could take anywhere from five minutes to over an hour,
Expand Down
1 change: 1 addition & 0 deletions source/developers/references/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,5 @@ Other References
tools_for_maintainers
a11y-ref
internal_data_formats/index
legacy_guide/index
glossary
Loading