Skip to content

Commit

Permalink
fix: fix github url strings (org edx -> openedx)
Browse files Browse the repository at this point in the history
  • Loading branch information
sarina committed Sep 16, 2022
1 parent f53d381 commit 70d6f3f
Show file tree
Hide file tree
Showing 56 changed files with 175 additions and 175 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/commitlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ on:

jobs:
commitlint:
uses: edx/.github/.github/workflows/commitlint.yml@master
uses: openedx/.github/.github/workflows/commitlint.yml@master
2 changes: 1 addition & 1 deletion en_us/course_authors/source/front_matter/read_me.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ For information about other resources, see :ref:`Preface`.
This guide is created using RST_ files and Sphinx_. You, the user community, can
help to update and revise this documentation project on GitHub.

https://github.com/edx/edx-documentation/tree/master/en_us/course_authors/source
https://github.com/openedx/edx-documentation/tree/master/en_us/course_authors/source

The edX documentation team welcomes contributions from Open edX community
members. You can find guidelines for how to `contribute to edX Documentation`_
Expand Down
2 changes: 1 addition & 1 deletion en_us/data/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ into their courses and students.
The *edX Research Guide* is created using RST_ files and Sphinx_. You, as a
member of the user community, can help update and revise this documentation
project on GitHub, using the edx-documentation repository at
https://github.com/edx/edx-documentation/tree/master/en_us/data/source
https://github.com/openedx/edx-documentation/tree/master/en_us/data/source

The edX documentation team welcomes contributions from Open edX community
members. You can find guidelines for how to `contribute to edX Documentation`_
Expand Down
2 changes: 1 addition & 1 deletion en_us/data/source/internal_data_formats/sql_schema.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2222,7 +2222,7 @@ understand which of your learners received a certificate.

For the latest information course certificates, see the `certificate models`_.

.. _`certificate models`: https://github.com/edx/edx-platform/blob/master/lms/djangoapps/certificates/models.py
.. _`certificate models`: https://github.com/openedx/edx-platform/blob/master/lms/djangoapps/certificates/models.py

A sample of the heading row and two data rows in the
``certificates_generatedcertificate`` table follows.
Expand Down
2 changes: 1 addition & 1 deletion en_us/developers/source/analytics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -391,6 +391,6 @@ code. Old calls to ``server_track`` should be replaced with calls to
handling do not currently have a suitable alternative approach, so they
continue to be supported.

.. _event-tracking: https://github.com/edx/event-tracking
.. _event-tracking: https://github.com/openedx/event-tracking
.. _event-tracking documentation: http://event-tracking.readthedocs.io/en/latest/overview.html#event-tracking
.. _Segment: https://segment.com/
2 changes: 1 addition & 1 deletion en_us/developers/source/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ In addition to the components detailed above, the Open edX project also has
services for other capabilities, such as one that manages e-commerce functions
like order work flows and coupons.

.. _edx-platform: https://github.com/edx/edx-platform
.. _edx-platform: https://github.com/openedx/edx-platform
.. _Python: https://www.python.org/
.. _Django: https://www.djangoproject.com/
.. _MongoDB: http://www.mongodb.org/
Expand Down
2 changes: 1 addition & 1 deletion en_us/developers/source/extending_platform/xblocks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ edx-platform (both the LMS and Studio), installation and testing will be much
more straightforward.

To enable an XBlock for testing in your devstack
(https://github.com/edx/configuration/wiki/edX-Developer-Stack), follow these
(https://github.com/openedx/configuration/wiki/edX-Developer-Stack), follow these
steps.

#. Install your block.
Expand Down
2 changes: 1 addition & 1 deletion en_us/developers/source/front_matter/read_me.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The *edX Developer Documentation* is created using RST_ files and Sphinx_.
You, the user community, can help update and revise this documentation project
on GitHub.

https://github.com/edx/edx-documentation/tree/master/en_us/developers/source
https://github.com/openedx/edx-documentation/tree/master/en_us/developers/source

The edX documentation team welcomes contributions from Open edX community
members. You can find guidelines for how to `contribute to edX Documentation`_
Expand Down
2 changes: 1 addition & 1 deletion en_us/developers/source/internationalization/i18n.rst
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@ preview language. Use the **Reset** button to reset the preview language to
your default setting. Refresh your browser page to display the page in the
selected language. The language persists for the duration of your session.

.. _RTL UI Guidelines: https://github.com/edx/edx-platform/wiki/RTL-UI-Best-Practices
.. _RTL UI Guidelines: https://github.com/openedx/edx-platform/wiki/RTL-UI-Best-Practices


.. _i18n Style Guidelines:
Expand Down
2 changes: 1 addition & 1 deletion en_us/developers/source/preventing_xss/preventing_xss.rst
Original file line number Diff line number Diff line change
Expand Up @@ -656,7 +656,7 @@ Legacy JavaScript files
JavaScript files are often used to perform DOM manipulation, and must properly
HTML-escape text before inserting it into the DOM.

The `UI Toolkit <https://github.com/edx/edx-ui-toolkit>`_ introduces various
The `UI Toolkit <https://github.com/openedx/edx-ui-toolkit>`_ introduces various
``StringUtils`` and ``HtmlUtils`` that are useful for handling escaping in
JavaScript. You can declare ``StringUtils`` and ``HtmlUtils`` as dependencies
using RequireJS ``define``, as seen in the following example.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,6 @@ Custom Interpolation Tag Example:
{% endblocktrans %}
{% interpolate_html msg start_anchor='<ahref="'|add:site.siteconfiguration.certificate_help_url|add:'">'|safe end_anchor='</a>'|safe %}
See an `example of this custom tag <https://github.com/edx/credentials/blob/57d02cb5d5bde7fce4f4862fd03cd42879e6f123/credentials/templates/credentials/programs/base.html#L116-L120>`__ used in the credentials codebase.
See an `example of this custom tag <https://github.com/openedx/credentials/blob/57d02cb5d5bde7fce4f4862fd03cd42879e6f123/credentials/templates/credentials/programs/base.html#L116-L120>`__ used in the credentials codebase.

The `interpolate_html tag <https://github.com/edx/xss-utils/blob/f2333be958e1f2e0970cf92c9da5a707999f6aad/xss_utils/templatetags/django_markup.py#L11>`__ is now available in a shared library for use in all IDAs.
The `interpolate_html tag <https://github.com/openedx/xss-utils/blob/f2333be958e1f2e0970cf92c9da5a707999f6aad/xss_utils/templatetags/django_markup.py#L11>`__ is now available in a shared library for use in all IDAs.
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ In both cases, we use a library called bleach.
Mako filters for bleaching
--------------------------

At the time of writing this, we do not yet have Mako filters for bleaching.  However, that would be very useful and was `detailed and requested on this PR <https://github.com/edx/web-certificates/pull/55#discussion_r156088103>`__. If you need this, please do the following:
At the time of writing this, we do not yet have Mako filters for bleaching.  However, that would be very useful._ If you need this, please do the following:

1. See if this was already added, 

2. If not, implement it and add to the `xss-lint repo <https://github.com/edx/xss-utils>`__.
2. If not, implement it and add to the `xss-lint repo <https://github.com/openedx/xss-utils>`__.

3. Update this documentation to detail using the filters.

Expand All @@ -38,15 +38,15 @@ Strip all HTML tags
You would typically do this when people have entered HTML tags inside a field in the past, and you no longer want to support HTML, but you also don't want escaped HTML tags to start appearing on the page.

Here is an \ `example using bleach to strip all
tags <https://github.com/edx/edx-platform/blob/a864b450a889df77f1c7379271dc9a80b3c1a8ee/lms/templates/courseware/progress_graph.js#L76>`__.
tags <https://github.com/openedx/edx-platform/blob/a864b450a889df77f1c7379271dc9a80b3c1a8ee/lms/templates/courseware/progress_graph.js#L76>`__.

Strip all but safe HTML tags
----------------------------

You would do this if you in fact want to allow a user to be able to use certain simple HTML tags, like "<br />", in their input.  Use this sparingly.  It is much simpler to deal with plain text fields.

Here is an \ `example using bleach to only allow basic/safe supported
tags <https://github.com/edx/edx-platform/blob/e8a36957b1f732974260e7b9b42b9c25148b492c/common/lib/capa/capa/inputtypes.py#L792>`__.
tags <https://github.com/openedx/edx-platform/blob/e8a36957b1f732974260e7b9b42b9c25148b492c/common/lib/capa/capa/inputtypes.py#L792>`__.

In addition to adding in the HTML to your data, you will probably need to turn off HTML escaping when outputting this data inside a template. The following is an example of this in Mako.

Expand Down
2 changes: 1 addition & 1 deletion en_us/developers/source/process/code-considerations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -281,5 +281,5 @@ you have questions, please contact us at docs@edx.org.


.. _cover letter: http://edx.readthedocs.io/projects/edx-developer-guide/en/latest/process/cover-letter.html
.. _GitHub repository: https://github.com/edx/edx-documentation
.. _GitHub repository: https://github.com/openedx/edx-documentation
.. _edX documentation: http://docs.edx.org
2 changes: 1 addition & 1 deletion en_us/developers/source/process/core-committer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ process is different:
pull request should be closed, inform the community managers, and they will
handle it.

.. _the documentation for doing so: https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request
.. _the documentation for doing so: https://github.com/openedx/edx-platform/wiki/How-to-Rebase-a-Pull-Request

Each Scrum team should decide for themselves how to estimate stories related to
reviewing external pull requests, and how to claim points for those stories,
Expand Down
4 changes: 2 additions & 2 deletions en_us/developers/source/process/cover-letter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,5 +64,5 @@ includes before and after screenshots, so the UX team can quickly understand
what changes were made and make suggestions. Further, the pull request
indicates how to manually test the feature and what date it is needed by.

.. _Pull Request 4675: https://github.com/edx/edx-platform/pull/4675
.. _Pull Request 4983: https://github.com/edx/edx-platform/pull/4983
.. _Pull Request 4675: https://github.com/openedx/edx-platform/pull/4675
.. _Pull Request 4983: https://github.com/openedx/edx-platform/pull/4983
6 changes: 3 additions & 3 deletions en_us/developers/source/process/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ overview of the process is here:
:target: ../_images/pr-process.png

.. _Open edX Proposal (OEP) process: http://open-edx-proposals.readthedocs.io/en/latest/
.. _The instructions here: https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst#step-0-join-the-conversation
.. _contribution agreement: https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst#step-1-sign-a-contribution-agreement
.. _The instructions here: https://github.com/openedx/edx-platform/blob/master/CONTRIBUTING.rst#step-0-join-the-conversation
.. _contribution agreement: https://github.com/openedx/edx-platform/blob/master/CONTRIBUTING.rst#step-1-sign-a-contribution-agreement

General Guidelines
------------------
Expand All @@ -84,7 +84,7 @@ For XBlocks you intend to install on edx.org, please also read the `XBlock
Review Guidelines`_.

.. _Internationalization Coding Guidelines: https://openedx.atlassian.net/wiki/edx.readthedocs.io/projects/edx-developer-guide/en/latest/internationalization/i18n.html
.. _RTL UI Best Practices: https://github.com/edx/edx-platform/wiki/RTL-UI-Best-Practices
.. _RTL UI Best Practices: https://github.com/openedx/edx-platform/wiki/RTL-UI-Best-Practices
.. _Accessibility Guidelines: http://edx.readthedocs.io/projects/edx-developer-guide/en/latest/accessibility.html
.. _Analytics Guidelines: http://edx.readthedocs.io/projects/edx-developer-guide/en/latest/analytics.html
.. _Eventing Design and Review Process: https://openedx.atlassian.net/wiki/display/AN/Eventing+Design+and+Review+Process
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ produces HTML documentation for it. An example follows.
.. _Airbnb JavaScript Style Guide: https://github.com/airbnb/javascript
.. _Babel: https://babeljs.io/
.. _description of testing for the edx-platform repository: https://github.com/edx/edx-platform/blob/master/docs/en_us/internal/testing.rst
.. _edX ESLint Config: https://github.com/edx/eslint-config-edx/tree/master/packages/eslint-config-edx
.. _edX ESLint Config for ES5: https://github.com/edx/eslint-config-edx/tree/master/packages/eslint-config-edx-es5
.. _description of testing for the edx-platform repository: https://github.com/openedx/edx-platform/blob/master/docs/en_us/internal/testing.rst
.. _edX ESLint Config: https://github.com/edx-unsupported/eslint-config-edx/tree/master/packages/eslint-config-edx
.. _edX ESLint Config for ES5: https://github.com/edx-unsupported/eslint-config-edx/tree/master/packages/eslint-config-edx-es5
.. _edX UI Toolkit: http://ui-toolkit.edx.org/
.. _ES5: https://www.ecma-international.org/ecma-262/5.1/
.. _ES2015: http://www.ecma-international.org/ecma-262/6.0/
Expand Down
2 changes: 1 addition & 1 deletion en_us/developers/source/style_guides/python-guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ Not like this::
We intentionally stray from `PEP 257`_ in this case. The formatting
inconsistency between single and multi-line docstrings can result in merge
conflicts when upstream and downstream branches change the same docstring. See
this `GitHub comment <https://github.com/edx/edx-documentation/pull/999#issuecomment-215537490>`_
this `GitHub comment <https://github.com/openedx/edx-documentation/pull/999#issuecomment-215537490>`_
for more context.

**********
Expand Down
4 changes: 2 additions & 2 deletions en_us/developers/source/style_guides/sass-guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ This should instead be written as::

.. _CSS Rules: https://github.com/stylelint/stylelint/blob/master/docs/user-guide/rules.md#possible-errors
.. _default flag: http://sass-lang.com/documentation/file.SASS_REFERENCE.html#Variable_Defaults___default
.. _edX Stylelint Config: https://github.com/edx/stylelint-config-edx
.. _edX Stylelint Config README: https://github.com/edx/stylelint-config-edx#sass-style-guide
.. _edX Stylelint Config: https://github.com/edx-unsupported/stylelint-config-edx
.. _edX Stylelint Config README: https://github.com/edx-unsupported/stylelint-config-edx#sass-style-guide
.. _SCSS-Specific Rules: https://www.npmjs.com/package/stylelint-scss#list-of-rules
.. _Stylelint: https://stylelint.io/
2 changes: 1 addition & 1 deletion en_us/developers/source/testing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ file on GitHub.
code-quality
test_openedx_features

.. _testing.rst: https://github.com/edx/edx-platform/blob/6d2468d0dcf782a7561ecc61946146d6fae2762f/docs/en_us/internal/testing.rst
.. _testing.rst: https://github.com/openedx/edx-platform/blob/6d2468d0dcf782a7561ecc61946146d6fae2762f/docs/en_us/internal/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ site looks, without changing how it works.
enable_themes
compiling_theme

In addition, an `example theme <https://github.com/edx/sample-themes>`_ is
In addition, an `example theme <https://github.com/openedx/sample-themes>`_ is
available for review.
Original file line number Diff line number Diff line change
Expand Up @@ -401,4 +401,4 @@ will have been generated for eligible learners.

.. include:: ../../../links/links.rst

.. _edx/credentials: https://github.com/edx/credentials
.. _edx/credentials: https://github.com/openedx/credentials
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ The following waffle flag needs to be enabled:

``course_experience.enable_course_goals``

To send goal reminder emails, you need to regularly run the following `management command <https://github.com/edx/edx-platform/blob/master/lms/djangoapps/course_goals/management/commands/goal_reminder_email.py#L101>`_.
To send goal reminder emails, you need to regularly run the following `management command <https://github.com/openedx/edx-platform/blob/master/lms/djangoapps/course_goals/management/commands/goal_reminder_email.py#L101>`_.

edx.org runs this command at the following cron schedule H \*/3 \* \* \*

.. note:: For the emails to work you will need to have at least one email channel configured within https://github.com/edx/edx-ace
.. note:: For the emails to work you will need to have at least one email channel configured within https://github.com/openedx/edx-ace
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Setting Up the User Retirement Driver Scripts
#############################################

Tubular (`edx/tubular on github <https://github.com/edx/tubular>`_) is a
Tubular (`edx/tubular on github <https://github.com/openedx/tubular>`_) is a
repository of Python 3 scripts designed to plug into various automation
tooling. Included in Tubular are two scripts intended to drive the user
retirement workflow.
Expand Down Expand Up @@ -57,7 +57,7 @@ of execution for each environment. Each item is a list in the form of:
#. End state name
#. IDA to call against (LMS, ECOMMERCE, or CREDENTIALS currently)
#. Method name to call in Tubular's
`edx_api.py <https://github.com/edx/tubular/blob/master/tubular/edx_api.py>`_
`edx_api.py <https://github.com/openedx/tubular/blob/master/tubular/edx_api.py>`_

For example: ``['RETIRING_CREDENTIALS', 'CREDENTIALS_COMPLETE', 'CREDENTIALS',
'retire_learner']`` will set the user's state to ``RETIRING_CREDENTIALS``, call
Expand All @@ -78,7 +78,7 @@ Set up your execution environment.

.. code-block:: bash
git clone https://github.com/edx/tubular.git
git clone https://github.com/openedx/tubular.git
cd tubular
virtualenv --python=`which python3` venv
source venv/bin/activate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ feature. Note that some of these settings values are lambda functions rather
than standard string literals. This is intentional; it is a pattern for
defining *derived* settings specific to Open edX. Read more about it in
`openedx/core/lib/derived.py
<https://github.com/edx/edx-platform/blob/fdc50c3/openedx/core/lib/derived.py>`_.
<https://github.com/openedx/edx-platform/blob/fdc50c3/openedx/core/lib/derived.py>`_.

.. list-table::
:header-rows: 1
Expand Down Expand Up @@ -53,7 +53,7 @@ defining *derived* settings specific to Open edX. Read more about it in
- ``'RETIREMENT_SERVICE_USER'``
- The username of the retirement service worker.
* - RETIREMENT_STATES
- See `lms/envs/common.py <https://github.com/edx/edx-platform/blob/fe82954/lms/envs/common.py#L3421-L3449>`_
- See `lms/envs/common.py <https://github.com/openedx/edx-platform/blob/fe82954/lms/envs/common.py#L3421-L3449>`_
in the ``RETIREMENT_STATES`` setting
- A list that defines the name and order of states for the retirement
workflow. See `Retirement States`_ for details.
Expand All @@ -73,7 +73,7 @@ installations, so it is the responsibility of the administrator to populate
the state list.

The default states are defined in `lms/envs/common.py
<https://github.com/edx/edx-platform/blob/fe82954/lms/envs/common.py#L3421-L3449>`_
<https://github.com/openedx/edx-platform/blob/fe82954/lms/envs/common.py#L3421-L3449>`_
in the ``RETIREMENT_STATES`` setting. There must be, at minimum, a ``PENDING``
state at the beginning, and ``COMPLETED``, ``ERRORED``, and ``ABORTED`` states
at the end of the list. Also, for every ``RETIRING_foo`` state, there must be
Expand Down
2 changes: 1 addition & 1 deletion en_us/install_operations/source/front_matter/read_me.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The *Installing and Configuring the Open edX Platform* documentation is created
using RST_ files and Sphinx_. As a member of the community, you can help update
and revise this documentation project on GitHub.

https://github.com/edx/edx-documentation/tree/master/en_us/install_operations/source
https://github.com/openedx/edx-documentation/tree/master/en_us/install_operations/source

The edX documentation team welcomes contributions from Open edX community
members. You can find guidelines for how to `contribute to edX Documentation`_
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ running on that instance.

.. code-block:: bash
git clone https://github.com/edx/edx-analytics-configuration.git
git clone https://github.com/openedx/edx-analytics-configuration.git
#. Configure the shell to use the AWS credentials of the administrative AWS
user.
Expand Down
4 changes: 2 additions & 2 deletions en_us/install_operations/source/mobile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ There are currently two edX mobile applications, one for iOS and one for
Android. You can find the source code and additional documentation for each
application in the following repositories.

* iOS: http://github.com/edx/edx-app-ios
* iOS: http://github.com/openedx/edx-app-ios

* Android: http://github.com/edx/edx-app-android
* Android: http://github.com/openedx/edx-app-android

*****************************************
Configuring Mobile Application Features
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Upgrading from Aspen to Birch

You can upgrade your Open edX instance that is running the Aspen release to the
Birch release, using the ``migrate.sh`` script in the configuration repository,
`available here <https://github.com/edx/configuration/blob/master/util/vagrant/migrate.sh>`_.
`available here <https://github.com/openedx/configuration/blob/master/util/vagrant/migrate.sh>`_.

.. note::
The upgrade scripts provided are verified only for upgrading instances
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Upgrading from Birch to Cypress
You can upgrade an Open edX instance that is running the Birch release to the
Cypress release, by using the ``migrate.sh`` script in the configuration
repository, `available here
<https://github.com/edx/configuration/blob/master/util/vagrant/migrate.sh>`_.
<https://github.com/openedx/configuration/blob/master/util/vagrant/migrate.sh>`_.

.. note::
The upgrade scripts provided are verified only for upgrading instances
Expand Down
Loading

0 comments on commit 70d6f3f

Please sign in to comment.