Skip to content

Commit

Permalink
Merge pull request openedx#227 from openedx/tcril/fix-gh-org-url
Browse files Browse the repository at this point in the history
Fix github url strings (org edx -> openedx)
  • Loading branch information
sarina authored Sep 13, 2022
2 parents 1789f55 + 269387a commit e256b11
Show file tree
Hide file tree
Showing 45 changed files with 85 additions and 78 deletions.
22 changes: 14 additions & 8 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,16 @@
# ** DO NOT EDIT THIS FILE **
# ***************************
#
# This file was generated by edx-lint: http://github.com/edx/edx-lint
# This file was generated by edx-lint: https://github.com/openedx/edx-lint
#
# If you want to change this file, you have two choices, depending on whether
# you want to make a local change that applies only to this repo, or whether
# you want to make a central change that applies to all repos using edx-lint.
#
# Note: If your .editorconfig file is simply out-of-date relative to the latest
# .editorconfig in edx-lint, ensure you have the latest edx-lint installed
# and then follow the steps for a "LOCAL CHANGE".
#
# LOCAL CHANGE:
#
# 1. Edit the local .editorconfig_tweaks file to add changes just to this
Expand All @@ -24,27 +28,24 @@
# CENTRAL CHANGE:
#
# 1. Edit the .editorconfig file in the edx-lint repo at
# https://github.com/edx/edx-lint/blob/master/edx_lint/files/.editorconfig
# https://github.com/openedx/edx-lint/blob/master/edx_lint/files/.editorconfig
#
# 2. install the updated version of edx-lint (in edx-lint):
#
# $ pip install .
#
# 3. Run (in edx-lint):
#
# # uses .editorconfig_tweaks from edx-lint for linting in edx-lint
# # NOTE: Use Python 3.x, which no longer includes comments in the output file
# $ edx_lint write .editorconfig
#
# 4. Make a new version of edx_lint, submit and review a pull request with the
# .editorconfig update, and after merging, update the edx-lint version by
# creating a new tag in the repo (uses pbr).
# .editorconfig update, and after merging, update the edx-lint version and
# publish the new version.
#
# 5. In your local repo, install the newer version of edx-lint.
#
# 6. Run:
#
# # uses local .editorconfig_tweaks
# $ edx_lint write .editorconfig
#
# 7. This will modify the local file. Submit a pull request to get it
Expand All @@ -63,6 +64,8 @@
# SERIOUSLY.
#
# ------------------------------
# Generated by edx-lint version: 5.2.5
# ------------------------------
[*]
end_of_line = lf
insert_final_newline = true
Expand All @@ -88,7 +91,10 @@ trim_trailing_whitespace = false
[.git/*]
trim_trailing_whitespace = false

[COMMIT_EDITMSG]
max_line_length = 72

[*.rst]
max_line_length = 79

# 01d24285b953f74272f86b1e42a0235315085e59
# f2f02689fced7a2e0c62c2f9803184114dc2ae4b
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 .github/workflows/upgrade-python-requirements.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ jobs:
requirements_bot_github_email: ${{ secrets.REQUIREMENTS_BOT_GITHUB_EMAIL }}
edx_smtp_username: ${{ secrets.EDX_SMTP_USERNAME }}
edx_smtp_password: ${{ secrets.EDX_SMTP_PASSWORD }}
uses: edx/.github/.github/workflows/upgrade-python-requirements.yml@master
uses: openedx/.github/.github/workflows/upgrade-python-requirements.yml@master
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Currently work to support xAPI and Caliper event formats is in progress.

See `OEP 26`_ for background; the xAPI and Caliper subdocuments in particular include a specification of how LMS events will be translated to the format of the respective protocols.

.. _event-tracking: https://github.com/edx/event-tracking
.. _event-tracking: https://github.com/openedx/event-tracking
.. _OEP 26: https://open-edx-proposals.readthedocs.io/en/latest/oep-0026-arch-realtime-events.html

Documentation
Expand All @@ -35,7 +35,7 @@ How To Contribute
-----------------

Contributions are very welcome.
Please read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`__ for details.
Please read `How To Contribute <https://github.com/openedx/edx-platform/blob/master/CONTRIBUTING.rst>`__ for details.
Even though they were written with ``edx-platform`` in mind, the guidelines
should be followed for all Open edX projects.

Expand Down Expand Up @@ -66,8 +66,8 @@ For more information about these options, see the `Getting Help <https://openedx
:target: https://pypi.python.org/pypi/event-routing-backends/
:alt: PyPI

.. |ci-badge| image:: https://github.com/edx/event-routing-backends/workflows/Python%20CI/badge.svg?branch=master
:target: https://github.com/edx/event-routing-backends/actions?query=workflow%3A%22Python+CI%22
.. |ci-badge| image:: https://github.com/openedx/event-routing-backends/workflows/Python%20CI/badge.svg?branch=master
:target: https://github.com/openedx/event-routing-backends/actions?query=workflow%3A%22Python+CI%22
:alt: CI

.. |codecov-badge| image:: https://codecov.io/github/edx/event-routing-backends/coverage.svg?branch=master
Expand All @@ -83,5 +83,5 @@ For more information about these options, see the `Getting Help <https://openedx
:alt: Supported Python versions

.. |license-badge| image:: https://img.shields.io/github/license/edx/event-routing-backends.svg
:target: https://github.com/edx/event-routing-backends/blob/master/LICENSE.txt
:target: https://github.com/openedx/event-routing-backends/blob/master/LICENSE.txt
:alt: License
2 changes: 1 addition & 1 deletion docs/decisions/0001-purpose-of-this-repo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Decision

Among the components listed above, Asynchronous Routing Backend and the
regular-expressions filter will be added in the core app (i.e.
`event-tracking <https://github.com/edx/event-tracking>`__) while the
`event-tracking <https://github.com/openedx/event-tracking>`__) while the
other components, i.e. Caliper transformer backend, xAPI transformer
backend and router, will be added in the current repo.

Expand Down
4 changes: 2 additions & 2 deletions docs/decisions/0003-router-configurations-storage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ Decision

Keeping in mind a large number of enterprise clients, we will store
router configurations in `Django configuration models
<https://github.com/edx/django-config-models>`__.
<https://github.com/openedx/django-config-models>`__.

Consequences
------------

Storing configurations in `Django configuration
models <https://github.com/edx/django-config-models>`__ will keep the
models <https://github.com/openedx/django-config-models>`__ will keep the
settings files cleaner.

Django configuration models have built-in caching support which would
Expand Down
2 changes: 1 addition & 1 deletion docs/decisions/0005-PII-leakage-prevention.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ Benefits

#. Only the instances where this accessor is called, will need to be reviewed during code review, in order to check for potential PII leakage.

.. _method: https://github.com/edx/event-routing-backends/blob/f430d4cf58bdab01e42fcc944241898606873d82/event_routing_backends/processors/mixins/base_transformer.py#L139
.. _method: https://github.com/openedx/event-routing-backends/blob/f430d4cf58bdab01e42fcc944241898606873d82/event_routing_backends/processors/mixins/base_transformer.py#L139
28 changes: 14 additions & 14 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Version information of mapping

Version of mapping of edx event onto xAPI or Caliper format, for each event, is included in the statement and event respectively. Version is a string of format "X.Y" where increment in X represents breaking changes and increment in Y represents addition of fields in the event json, both starting with zero.

In xAPI statement, version is in value of the key ``https://github.com/edx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst`` in ``extensions`` of ``Context`` of the statement.
In xAPI statement, version is in value of the key ``https://github.com/openedx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst`` in ``extensions`` of ``Context`` of the statement.

In Caliper event, version is in value of the key ``eventVersion`` in ``extensions`` of the event.

Expand Down Expand Up @@ -216,28 +216,28 @@ A sample override for ``xapi`` backend is presented below. Here we are allowing
}
}
.. _event-tracking: https://github.com/edx/event-tracking
.. _event-tracking: https://github.com/openedx/event-tracking
.. _NameWhitelist: https://github.com/edx/event-tracking/blob/master/eventtracking/processors/whitelist.py
.. _NameWhitelist: https://github.com/openedx/event-tracking/blob/master/eventtracking/processors/whitelist.py
.. _RegexFilter: https://github.com/edx/event-tracking/blob/master/eventtracking/processors/regex_filter.py
.. _RegexFilter: https://github.com/openedx/event-tracking/blob/master/eventtracking/processors/regex_filter.py
.. _save_statement: https://github.com/edx/event-routing-backends/blob/2ec15d054b3b1dd6072689aa470f3d805486526e/event_routing_backends/utils/xapi_lrs_client.py#L70
.. _save_statement: https://github.com/openedx/event-routing-backends/blob/2ec15d054b3b1dd6072689aa470f3d805486526e/event_routing_backends/utils/xapi_lrs_client.py#L70
.. _post: https://github.com/edx/event-routing-backends/blob/2ec15d054b3b1dd6072689aa470f3d805486526e/event_routing_backends/utils/http_client.py#L67
.. _post: https://github.com/openedx/event-routing-backends/blob/2ec15d054b3b1dd6072689aa470f3d805486526e/event_routing_backends/utils/http_client.py#L67
.. _AsyncRoutingBackend: https://github.com/edx/event-tracking/blob/fccad3d118f594fe304ec48517e896447f15e782/eventtracking/backends/async_routing.py#L13
.. _AsyncRoutingBackend: https://github.com/openedx/event-tracking/blob/fccad3d118f594fe304ec48517e896447f15e782/eventtracking/backends/async_routing.py#L13
.. _CaliperProcessor: https://github.com/edx/event-routing-backends/blob/ac192ab6b4d1452ada37302d1481eea2f58aef19/event_routing_backends/processors/caliper/transformer_processor.py#L16
.. _CaliperProcessor: https://github.com/openedx/event-routing-backends/blob/ac192ab6b4d1452ada37302d1481eea2f58aef19/event_routing_backends/processors/caliper/transformer_processor.py#L16
.. _XApiProcessor: https://github.com/edx/event-routing-backends/blob/ac192ab6b4d1452ada37302d1481eea2f58aef19/event_routing_backends/processors/xapi/transformer_processor.py#L16
.. _XApiProcessor: https://github.com/openedx/event-routing-backends/blob/ac192ab6b4d1452ada37302d1481eea2f58aef19/event_routing_backends/processors/xapi/transformer_processor.py#L16
.. _CaliperEnvelopeProcessor: https://github.com/edx/event-routing-backends/blob/ac192ab6b4d1452ada37302d1481eea2f58aef19/event_routing_backends/processors/caliper/envelope_processor.py#L12
.. _CaliperEnvelopeProcessor: https://github.com/openedx/event-routing-backends/blob/ac192ab6b4d1452ada37302d1481eea2f58aef19/event_routing_backends/processors/caliper/envelope_processor.py#L12
.. _EventsRouter: https://github.com/edx/event-routing-backends/blob/ac192ab6b4d1452ada37302d1481eea2f58aef19/event_routing_backends/backends/events_router.py#L15
.. _EventsRouter: https://github.com/openedx/event-routing-backends/blob/ac192ab6b4d1452ada37302d1481eea2f58aef19/event_routing_backends/backends/events_router.py#L15
.. _business_critical_events: https://github.com/edx/event-routing-backends/blob/e375674156b347be833ad8c2479be2c4ff4b073f/event_routing_backends/helpers.py#L197
.. _business_critical_events: https://github.com/openedx/event-routing-backends/blob/e375674156b347be833ad8c2479be2c4ff4b073f/event_routing_backends/helpers.py#L197
.. _edx-celeryutils: https://github.com/edx/edx-celeryutils
.. _edx-celeryutils: https://github.com/openedx/edx-celeryutils
.. _commands: https://github.com/edx/edx-celeryutils/tree/master/celery_utils/management/commands
.. _commands: https://github.com/openedx/edx-celeryutils/tree/master/celery_utils/management/commands
4 changes: 2 additions & 2 deletions docs/howto/how_to_test.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
How To Test
===========

This is a rough guide of how to go about testing backends in edx-platform. It assumes you have devstack already up and running. If not, see `devstack docs <https://github.com/edx/devstack>`_.
This is a rough guide of how to go about testing backends in edx-platform. It assumes you have devstack already up and running. If not, see `devstack docs <https://github.com/openedx/devstack>`_.


Add edx-event-routing-backends to requirements
Expand Down Expand Up @@ -70,7 +70,7 @@ There are two ways you can filter events:

- Event types can be filtered using `RegexFilter`_ in EVENT_TRACKING_BACKENDS.${backend_name}.OPTIONS.processors.OPTIONS

.. _RegexFilter: https://github.com/edx/event-tracking/blob/master/eventtracking/processors/regex_filter.py
.. _RegexFilter: https://github.com/openedx/event-tracking/blob/master/eventtracking/processors/regex_filter.py

- Particular instances of event types can be filtered based on key, value pair in the serialized event dict. When setting up router in django admin, add key, value pair you want to match_params. If you want all instances of events to be sent, set match_params to empty dict: `match_params: {}`

Expand Down
11 changes: 6 additions & 5 deletions docs/xapi-extensions/eventVersion.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
+-------------------------------------------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Extensions | Title | Description |
+=================================================================================================+====================+================================================================================================================================================================================================================================================================================+
| https://github.com/edx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst | "event version"@en | "This version represents version of mapping of a single edx event onto xapi format. Value should be a string of format "X.Y" where increment in X represents breaking changes and increment in Y represents addition of fields in the event json, both starting with 0 (zero)" |
+-------------------------------------------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------------------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Extensions | Title | Description |
+=====================================================================================================+====================+================================================================================================================================================================================================================================================================================+
| https://github.com/openedx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst | "event version"@en | "This version represents version of mapping of a single edx event onto xapi format. Value should be a string of format "X.Y" where increment in X represents breaking changes and increment in Y represents addition of fields in the event json, both starting with 0 (zero)" |
+-----------------------------------------------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

2 changes: 1 addition & 1 deletion event_routing_backends/processors/xapi/constants.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
XAPI_RESULT_VIDEO_PROGRESS = 'https://w3id.org/xapi/video/extensions/progress'
XAPI_TRANSFORMER_VERSION = '1.0.3'
XAPI_EVENT_VERSION_KEY = \
'https://github.com/edx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst'
'https://github.com/openedx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst'

# Languages
EN = 'en'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
]
},
"extensions": {
"https://github.com/edx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0",
"https://github.com/openedx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0",
"https://w3id.org/xapi/video/extensions/length": 195.0
}
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
},
"context": {
"extensions": {
"https://github.com/edx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
"https://github.com/openedx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
}
},
"object": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
},
"context": {
"extensions": {
"https://github.com/edx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
"https://github.com/openedx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
}
},
"object": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
},
"context": {
"extensions": {
"https://github.com/edx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
"https://github.com/openedx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
}
},
"object": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
},
"context": {
"extensions": {
"https://github.com/edx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
"https://github.com/openedx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
}
},
"object": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
},
"context": {
"extensions": {
"https://github.com/edx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
"https://github.com/openedx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
}
},
"object": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
},
"context": {
"extensions": {
"https://github.com/edx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
"https://github.com/openedx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
}
},
"object": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
},
"context": {
"extensions": {
"https://github.com/edx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
"https://github.com/openedx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
}
},
"object": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
]
},
"extensions": {
"https://github.com/edx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
"https://github.com/openedx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
}
},
"object": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
]
},
"extensions": {
"https://github.com/edx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
"https://github.com/openedx/event-routing-backends/blob/master/docs/xapi-extensions/eventVersion.rst": "1.0"
}
},
"object": {
Expand Down
Loading

0 comments on commit e256b11

Please sign in to comment.