Skip to content

Commit

Permalink
fix: update github urls with new openedx/ org
Browse files Browse the repository at this point in the history
  • Loading branch information
sarina committed Sep 14, 2022
1 parent ceeefa9 commit 053f839
Show file tree
Hide file tree
Showing 11 changed files with 38 additions and 38 deletions.
16 changes: 8 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ Library and utilities for implementing and reporting on feature toggles.
Documentation is on `Read the Docs`_. Code repository is on `GitHub`_.

.. _Read the Docs: https://edx.readthedocs.io/projects/edx-toggles/en/latest/readme.html
.. _GitHub: https://github.com/edx/edx-toggles
.. _GitHub: https://github.com/openedx/edx-toggles

See the `scripts README`_ for more information on the scripts for reporting on the status of
feature toggles.

.. _scripts README: https://github.com/edx/edx-toggles/blob/master/scripts/README.rst
.. _scripts README: https://github.com/openedx/edx-toggles/blob/master/scripts/README.rst

License
-------
Expand All @@ -29,16 +29,16 @@ 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 Open edX code in general.

PR description template should be automatically applied if you are sending PR from github interface; otherwise you
can find it it at `PULL_REQUEST_TEMPLATE.md <https://github.com/edx/edx-toggles/blob/master/.github/PULL_REQUEST_TEMPLATE.md>`_
can find it it at `PULL_REQUEST_TEMPLATE.md <https://github.com/openedx/edx-toggles/blob/master/.github/PULL_REQUEST_TEMPLATE.md>`_

Issue report template should be automatically applied if you are sending it from github UI as well; otherwise you
can find it at `ISSUE_TEMPLATE.md <https://github.com/edx/edx-toggles/blob/master/.github/ISSUE_TEMPLATE.md>`_
can find it at `ISSUE_TEMPLATE.md <https://github.com/openedx/edx-toggles/blob/master/.github/ISSUE_TEMPLATE.md>`_

Reporting Security Issues
-------------------------
Expand All @@ -58,8 +58,8 @@ refer to this `list of resources`_ if you need any assistance.
:target: https://pypi.python.org/pypi/edx-toggles/
:alt: PyPI

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

.. |codecov-badge| image:: http://codecov.io/github/edx/edx-toggles/coverage.svg?branch=master
Expand All @@ -75,5 +75,5 @@ refer to this `list of resources`_ if you need any assistance.
:alt: Supported Python versions

.. |license-badge| image:: https://img.shields.io/github/license/edx/edx-toggles.svg
:target: https://github.com/edx/edx-toggles/blob/master/LICENSE.txt
:target: https://github.com/openedx/edx-toggles/blob/master/LICENSE.txt
:alt: License
4 changes: 2 additions & 2 deletions docs/decisions/0002-application-toggle-state.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For security purposes:

Note: Django Setting toggles could also have a default provided upon retrieval. That topic will be covered under a separate ADR.

.. _WaffleFlag: https://github.com/edx/edx-platform/blob/77e490f0578cbaa5a4c2e6110b848cceef30962b/openedx/core/djangoapps/waffle_utils/__init__.py#L373
.. _WaffleFlag: https://github.com/openedx/edx-platform/blob/77e490f0578cbaa5a4c2e6110b848cceef30962b/openedx/core/djangoapps/waffle_utils/__init__.py#L373

Consequences
------------
Expand All @@ -47,7 +47,7 @@ The implementation of this toggle state endpoint needs to live with the toggle c

The current implementation of toggle state gathering will be refactored/reworked into the new endpoint.

.. _waffle_utils: https://github.com/edx/edx-platform/tree/77e490f0578cbaa5a4c2e6110b848cceef30962b/openedx/core/djangoapps/waffle_utils
.. _waffle_utils: https://github.com/openedx/edx-platform/tree/77e490f0578cbaa5a4c2e6110b848cceef30962b/openedx/core/djangoapps/waffle_utils

Rejected Alternatives
---------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/decisions/0003-django-setting-toggles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ Implementation Steps:
* Cleaning up `common.py` where appropriate by removing unnecessary defaults should also be done.
* We can define these in a `toggles.py` file in the apps. We can consider moving (permanent) waffle definitions from `waffle.py` to `toggles.py`.

.. _implemented setting toggle classes: https://github.com/edx/edx-toggles/blob/53cf1f71be35ee886521d3d6badafee69198a551/edx_toggles/toggles/internal/setting_toggle.py
.. _toggle state endpoint: https://github.com/edx/edx-platform/blob/216b99264a50011cb313f5b391abeae61870acee/openedx/core/djangoapps/waffle_utils/views.py#L20
.. _implemented setting toggle classes: https://github.com/openedx/edx-toggles/blob/53cf1f71be35ee886521d3d6badafee69198a551/edx_toggles/toggles/internal/setting_toggle.py
.. _toggle state endpoint: https://github.com/openedx/edx-platform/blob/216b99264a50011cb313f5b391abeae61870acee/openedx/core/djangoapps/waffle_utils/views.py#L20

Rejected Alternatives
---------------------
Expand Down
10 changes: 5 additions & 5 deletions docs/decisions/0005-toggle-life-expectancy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ If a stakeholder wanted to review our "permanent" toggles to determine which rea
* Most permanent toggles have ``.. toggle_use_cases: open_edx``, which provides no information about the confidence around it being a permanent toggle.
* If confidence were boosted using additional research or a failed attempt to DEPR, there would be no consistent way to document this change in confidence, other than adding text to the ``toggle_description`` and hoping it would be seen.

.. _set of use cases for toggles: https://github.com/edx/open-edx-proposals/blob/c2d3b2a/oeps/oep-0017-bp-feature-toggles.rst#use-cases
.. _Details a reporting requirement: https://github.com/edx/open-edx-proposals/blob/c2d3b2a/oeps/oep-0017-bp-feature-toggles.rst#req-12-report
.. _PR discussion about toggle_use_cases: https://github.com/edx/edx-platform/pull/24815#issuecomment-681174018
.. _PR to implement this proposal: https://github.com/edx/code-annotations/pull/49
.. _set of use cases for toggles: https://github.com/openedx/open-edx-proposals/blob/c2d3b2a/oeps/oep-0017-bp-feature-toggles.rst#use-cases
.. _Details a reporting requirement: https://github.com/openedx/open-edx-proposals/blob/c2d3b2a/oeps/oep-0017-bp-feature-toggles.rst#req-12-report
.. _PR discussion about toggle_use_cases: https://github.com/openedx/edx-platform/pull/24815#issuecomment-681174018
.. _PR to implement this proposal: https://github.com/openedx/code-annotations/pull/49

Decision
--------
Expand Down Expand Up @@ -108,4 +108,4 @@ Consequences
* The `how-to documenting_new_feature_toggles.rst`_ should be updated as necessary.
* OEP-17 should be updated to reflect these choices. Note that the OEP is outdated in other ways as well.

.. _how-to documenting_new_feature_toggles.rst: https://github.com/edx/edx-toggles/blob/master/docs/how_to/documenting_new_feature_toggles.rst
.. _how-to documenting_new_feature_toggles.rst: https://github.com/openedx/edx-toggles/blob/master/docs/how_to/documenting_new_feature_toggles.rst
16 changes: 8 additions & 8 deletions docs/how_to/adding_new_ida_to_toggle_report.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ Steps required (2-4 hours):
You can follow similar steps to use the settings Sphinx extension to publish non-boolean non-toggle setting annotations as well.

.. _readthedocs documention for edx-platform feature toggles: https://edx.readthedocs.io/projects/edx-platform-technical/en/latest/featuretoggles.html
.. _annotated toggles in the edx-platform codebase: https://github.com/edx/edx-platform/search?q=toggle_name
.. _search for featuretoggles in edx-platform: https://github.com/edx/edx-platform/search?q=featuretoggles
.. _annotated toggles in the edx-platform codebase: https://github.com/openedx/edx-platform/search?q=toggle_name
.. _search for featuretoggles in edx-platform: https://github.com/openedx/edx-platform/search?q=featuretoggles

Toggles State Endpoint
======================
Expand Down Expand Up @@ -67,8 +67,8 @@ Steps required (2-4 hours):
- (Optional) If your IDA has custom toggle types, you can subclass and override the reporting methods as was done in the edx-platform `example toggles state endpoint view`_.

.. _ToggleStateReport: https://edx.readthedocs.io/projects/edx-toggles/en/latest/edx_toggles.toggles.state.internal.html#module-edx_toggles.toggles.state.internal.report
.. _example toggles state endpoint view: https://github.com/edx/edx-platform/blob/650b0c1/openedx/core/djangoapps/waffle_utils/views.py#L50-L66
.. _example urls.py in edx-platform: https://github.com/edx/edx-platform/blob/650b0c13603468d33e3e629ef1e36acc8fefd683/openedx/core/djangoapps/waffle_utils/urls.py
.. _example toggles state endpoint view: https://github.com/openedx/edx-platform/blob/650b0c1/openedx/core/djangoapps/waffle_utils/views.py#L50-L66
.. _example urls.py in edx-platform: https://github.com/openedx/edx-platform/blob/650b0c13603468d33e3e629ef1e36acc8fefd683/openedx/core/djangoapps/waffle_utils/urls.py
.. _supported toggle classes from edx-toggles: https://edx.readthedocs.io/projects/edx-toggles/en/latest/how_to/implement_the_right_toggle_type.html#implementing-the-right-toggle-class

Toggles State Reports Spreadsheet
Expand All @@ -91,7 +91,7 @@ Steps required (1 hour):

.. _Toggle State Reports Spreadsheet (private to edX.org): https://tinyurl.com/edx-toggles-state
.. _feature-toggle-report-generator.yml: https://github.com/edx/edx-internal/blob/master/tools-edx-jenkins/feature-toggle-report-generator.yml
.. _scripts/configuration.yaml: https://github.com/edx/edx-toggles/blob/master/scripts/configuration.yaml
.. _scripts/configuration.yaml: https://github.com/openedx/edx-toggles/blob/master/scripts/configuration.yaml

How the Toggle State Reports Spreadsheet is generated
=====================================================
Expand All @@ -111,7 +111,7 @@ The steps to collect annotations are automated through a Jenkins job:

The job creates files with names like ``<ida_name>-annotations.yml``. The feature toggle report generator will key off the ``ida_name`` in the filename in order to be able to link this data to the toggle state data collected.

.. _code_annotations: https://github.com/edx/code-annotations
.. _code_annotations: https://github.com/openedx/code-annotations

Gathering state data from HTTP endpoint
---------------------------------------
Expand Down Expand Up @@ -142,6 +142,6 @@ The csv reports are published to a private Google Sheet. See `Toggle State Repor
.. _groovy job specification: https://github.com/edx/jenkins-job-dsl-internal/blob/master/jobs/tools-edx-jenkins.edx.org/createFeatureToggleReportGeneratorJobs.groovy
.. _script to push data to s3 bucket: https://github.com/edx/jenkins-job-dsl-internal/blob/master/resources/push-feature-toggle-data-to-s3.sh
.. _script to pull data from s3 bucket: https://github.com/edx/jenkins-job-dsl-internal/blob/master/resources/pull-feature-toggle-data-from-s3.sh
.. _feature_toggle_report_generator.py: https://github.com/edx/edx-toggles/blob/master/scripts/feature_toggle_report_generator.py
.. _feature_toggle_report_generator.py: https://github.com/openedx/edx-toggles/blob/master/scripts/feature_toggle_report_generator.py
.. _publish-feature-toggle-report: https://tools-edx-jenkins.edx.org/job/Feature-Toggle-Report-Generator/job/publish-feature-toggle-report/
.. _README: https://github.com/edx/edx-toggles/blob/master/scripts/README.rst
.. _README: https://github.com/openedx/edx-toggles/blob/master/scripts/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ Place all resulting annotations yml files in a single directory. The name of ann
Create Report
-------------

Use instructions found in `"Creating a Feature Toggle Report" section of Readme <https://github.com/edx/edx-toggles/blob/master/scripts/README.rst#creating-a-feature-toggle-report>`__ to generate report.
Use instructions found in `"Creating a Feature Toggle Report" section of Readme <https://github.com/openedx/edx-toggles/blob/master/scripts/README.rst#creating-a-feature-toggle-report>`__ to generate report.
4 changes: 2 additions & 2 deletions docs/how_to/documenting_new_feature_toggles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Copy-paste this boilerplate template to document a feature toggle::
# .. toggle_use_cases: temporary OR circuit_breaker OR vip OR opt_out OR opt_in OR open_edx
# .. toggle_creation_date: 2020-01-01
# .. toggle_target_removal_date: 2020-07-01 (this is required if toggle_use_cases includes temporary. If not, simply remove it.)
# .. toggle_tickets: (Optional) https://openedx.atlassian.net/browse/DEPR-xxx, https://github.com/edx/edx-platform/blob/master/docs/decisions/xxx.rst, https://github.com/edx/edx-platform/pull/xxx (details initial feature)
# .. toggle_tickets: (Optional) https://openedx.atlassian.net/browse/DEPR-xxx, https://github.com/openedx/edx-platform/blob/master/docs/decisions/xxx.rst, https://github.com/openedx/edx-platform/pull/xxx (details initial feature)
SOME_FEATURE_NAME = ...

Configuration model
Expand Down Expand Up @@ -213,5 +213,5 @@ The documentation format used to annotate feature toggles is stored in the code-
See `how-to document non-boolean Django settings`_, for Django settings which are not feature toggles.

.. _`OEP-17: Feature Toggles`: https://open-edx-proposals.readthedocs.io/en/latest/oep-0017-bp-feature-toggles.html
.. _feature_toggle_annotations.yaml: https://github.com/edx/code-annotations/blob/master/code_annotations/contrib/config/feature_toggle_annotations.yaml
.. _feature_toggle_annotations.yaml: https://github.com/openedx/code-annotations/blob/master/code_annotations/contrib/config/feature_toggle_annotations.yaml
.. _how-to document non-boolean Django settings: https://code-annotations.readthedocs.io/en/latest/contrib/how_to/documenting_django_settings.html
2 changes: 1 addition & 1 deletion docs/how_to/get_feature_toggles_annotation_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ To run the code-annotations tool to collect annotations into a report, run the c
code_annotations static_find_annotations --config_file $VIRTUAL_ENV/lib/python3.5/site-packages/code_annotations/config_and_tools/config/feature_toggle_annotations.yaml
.. _code_annotations: https://www.github.com/edx/code-annotations
.. _code_annotations: https://www.github.com/openedx/code-annotations
12 changes: 6 additions & 6 deletions docs/how_to/implement_the_right_toggle_type.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Using your toggle
This section covers waffle switches and flags as well as Django Settings toggles.
For information on `Configuration Models`_ refer to that library.

.. _Configuration Models: https://github.com/edx/django-config-models/
.. _Configuration Models: https://github.com/openedx/django-config-models/

Creating toggles
-----------------
Expand All @@ -69,7 +69,7 @@ For the waffle flag and switch, you will use Django Admin "waffle" section to co

Functions to override waffle flags in test are provided in `testutils`_.

.. _testutils: https://github.com/edx/edx-toggles/blob/master/edx_toggles/toggles/testutils.py
.. _testutils: https://github.com/openedx/edx-toggles/blob/master/edx_toggles/toggles/testutils.py

Accessing toggles
------------------
Expand Down Expand Up @@ -119,7 +119,7 @@ If the toggle is being added to edx-platform, and it needs to be used by both LM

Avoid referring to boolean Django Settings directly. However, if a boolean setting toggle is implemented without one of the wrapping classes, its annotation implementation would be `DjangoSetting`.

.. _SettingToggle and SettingDictToggle classes: https://github.com/edx/edx-toggles/blob/master/edx_toggles/toggles/internal/setting_toggle.py
.. _SettingToggle and SettingDictToggle classes: https://github.com/openedx/edx-toggles/blob/master/edx_toggles/toggles/internal/setting_toggle.py
.. _ADR for the Setting Toggle classes: ../decisions/0003-django-setting-toggles.rst

Waffle Switches
Expand All @@ -145,12 +145,12 @@ In edx-platform, there is also:

.. _WaffleFlag class: ../edx_toggles.toggles.internal.waffle.html#module-edx_toggles.toggles.internal.waffle
.. _waffle: https://waffle.readthedocs.io/
.. _CourseWaffleFlag: https://github.com/edx/edx-platform/blob/master/openedx/core/djangoapps/waffle_utils/__init__.py
.. _ExperimentWaffleFlag: https://github.com/edx/edx-platform/blob/master/lms/djangoapps/experiments/flags.py
.. _CourseWaffleFlag: https://github.com/openedx/edx-platform/blob/master/openedx/core/djangoapps/waffle_utils/__init__.py
.. _ExperimentWaffleFlag: https://github.com/openedx/edx-platform/blob/master/lms/djangoapps/experiments/flags.py

Config Models
--------------

A `ConfigurationModel`_ can be used if all other options do not suit your needs. In most cases, it is no longer necessary.

.. _ConfigurationModel: https://github.com/edx/django-config-models/
.. _ConfigurationModel: https://github.com/openedx/django-config-models/
4 changes: 2 additions & 2 deletions scripts/configuration.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
ida:
lms:
github_url: https://github.com/edx/edx-platform
github_url: https://github.com/openedx/edx-platform
credentials:
github_url: https://github.com/edx/credentials
github_url: https://github.com/openedx/credentials
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ def is_requirement(line):
long_description=README + '\n\n' + CHANGELOG,
author='edX',
author_email='[email protected]',
url='https://github.com/edx/edx-toggles',
url='https://github.com/openedx/edx-toggles',
packages=[
'edx_toggles',
],
Expand Down

0 comments on commit 053f839

Please sign in to comment.