Skip to content
This repository was archived by the owner on Aug 1, 2024. It is now read-only.

Commit c8e8d98

Browse files
authored
Merge pull request #966 from openedx/tcril/fix-gh-org-url
Fix github url strings (org edx -> openedx)
2 parents 7e6b9df + 597e71b commit c8e8d98

14 files changed

Lines changed: 162 additions & 84 deletions

.editorconfig

Lines changed: 83 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,71 @@
1-
# This is a file to standardize editor settings: http://EditorConfig.org
2-
1+
# ***************************
2+
# ** DO NOT EDIT THIS FILE **
3+
# ***************************
4+
#
5+
# This file was generated by edx-lint: https://github.com/openedx/edx-lint
6+
#
7+
# If you want to change this file, you have two choices, depending on whether
8+
# you want to make a local change that applies only to this repo, or whether
9+
# you want to make a central change that applies to all repos using edx-lint.
10+
#
11+
# Note: If your .editorconfig file is simply out-of-date relative to the latest
12+
# .editorconfig in edx-lint, ensure you have the latest edx-lint installed
13+
# and then follow the steps for a "LOCAL CHANGE".
14+
#
15+
# LOCAL CHANGE:
16+
#
17+
# 1. Edit the local .editorconfig_tweaks file to add changes just to this
18+
# repo's file.
19+
#
20+
# 2. Run:
21+
#
22+
# $ edx_lint write .editorconfig
23+
#
24+
# 3. This will modify the local file. Submit a pull request to get it
25+
# checked in so that others will benefit.
26+
#
27+
#
28+
# CENTRAL CHANGE:
29+
#
30+
# 1. Edit the .editorconfig file in the edx-lint repo at
31+
# https://github.com/openedx/edx-lint/blob/master/edx_lint/files/.editorconfig
32+
#
33+
# 2. install the updated version of edx-lint (in edx-lint):
34+
#
35+
# $ pip install .
36+
#
37+
# 3. Run (in edx-lint):
38+
#
39+
# $ edx_lint write .editorconfig
40+
#
41+
# 4. Make a new version of edx_lint, submit and review a pull request with the
42+
# .editorconfig update, and after merging, update the edx-lint version and
43+
# publish the new version.
44+
#
45+
# 5. In your local repo, install the newer version of edx-lint.
46+
#
47+
# 6. Run:
48+
#
49+
# $ edx_lint write .editorconfig
50+
#
51+
# 7. This will modify the local file. Submit a pull request to get it
52+
# checked in so that others will benefit.
53+
#
54+
#
55+
#
56+
#
57+
#
58+
# STAY AWAY FROM THIS FILE!
59+
#
60+
#
61+
#
62+
#
63+
#
64+
# SERIOUSLY.
65+
#
66+
# ------------------------------
67+
# Generated by edx-lint version: 5.2.5
68+
# ------------------------------
369
[*]
470
end_of_line = lf
571
insert_final_newline = true
@@ -11,12 +77,24 @@ trim_trailing_whitespace = true
1177

1278
[{Makefile, *.mk}]
1379
indent_style = tab
80+
indent_size = 8
1481

15-
[*.{js,json,yml,yaml}]
82+
[*.{yml,yaml,json}]
1683
indent_size = 2
1784

18-
[*.rst]
19-
max_line_length = 79
85+
[*.js]
86+
indent_size = 2
2087

2188
[*.diff]
2289
trim_trailing_whitespace = false
90+
91+
[.git/*]
92+
trim_trailing_whitespace = false
93+
94+
[COMMIT_EDITMSG]
95+
max_line_length = 72
96+
97+
[*.rst]
98+
max_line_length = 79
99+
100+
# f2f02689fced7a2e0c62c2f9803184114dc2ae4b

.github/workflows/commitlint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ on:
77

88
jobs:
99
commitlint:
10-
uses: edx/.github/.github/workflows/commitlint.yml@master
10+
uses: openedx/.github/.github/workflows/commitlint.yml@master

.github/workflows/upgrade-python-requirements.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ jobs:
2121
requirements_bot_github_email: ${{ secrets.REQUIREMENTS_BOT_GITHUB_EMAIL }}
2222
edx_smtp_username: ${{ secrets.EDX_SMTP_USERNAME }}
2323
edx_smtp_password: ${{ secrets.EDX_SMTP_PASSWORD }}
24-
uses: edx/.github/.github/workflows/upgrade-python-requirements.yml@master
24+
uses: openedx/.github/.github/workflows/upgrade-python-requirements.yml@master

README.rst

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ platform. Use it to get up and running quickly with Open edX services.
77
Documentation is on `Read the Docs`_. Code repository is on `GitHub`_.
88

99
.. _Read the Docs: https://edx.readthedocs.io/projects/open-edx-devstack/en/latest/
10-
.. _GitHub: https://github.com/edx/devstack
10+
.. _GitHub: https://github.com/openedx/devstack
1111

1212
The Devstack runs as multiple containers with `Docker Compose`_ at its core.
1313

@@ -339,30 +339,30 @@ Some common service combinations include:
339339
* ``ecommerce``: Ecommerce, but also LMS as a dependency (for auth)
340340
* ``studio+credentials``: Services can be combined to affect both at once
341341

342-
.. _credentials: https://github.com/edx/credentials
343-
.. _discovery: https://github.com/edx/course-discovery
344-
.. _ecommerce: https://github.com/edx/ecommerce
345-
.. _edx_notes_api: https://github.com/edx/edx-notes-api
346-
.. _forum: https://github.com/edx/cs_comments_service
347-
.. _frontend-app-payment: https://github.com/edx/frontend-app-payment
348-
.. _frontend-app-publisher: https://github.com/edx/frontend-app-publisher
349-
.. _frontend-app-gradebook: https://github.com/edx/frontend-app-gradebook
350-
.. _lms: https://github.com/edx/edx-platform
351-
.. _frontend-app-program-console: https://github.com/edx/frontend-app-program-console
352-
.. _registrar: https://github.com/edx/registrar
353-
.. _studio: https://github.com/edx/edx-platform
354-
.. _lms: https://github.com/edx/edx-platform
355-
.. _frontend-app-learning: https://github.com/edx/frontend-app-learning
356-
.. _frontend-app-library-authoring: https://github.com/edx/frontend-app-library-authoring
357-
.. _frontend-app-course-authoring: https://github.com/edx/frontend-app-course-authoring
358-
.. _frontend-app-account: https://github.com/edx/frontend-app-account
342+
.. _credentials: https://github.com/openedx/credentials
343+
.. _discovery: https://github.com/openedx/course-discovery
344+
.. _ecommerce: https://github.com/openedx/ecommerce
345+
.. _edx_notes_api: https://github.com/openedx/edx-notes-api
346+
.. _forum: https://github.com/openedx/cs_comments_service
347+
.. _frontend-app-payment: https://github.com/openedx/frontend-app-payment
348+
.. _frontend-app-publisher: https://github.com/openedx/frontend-app-publisher
349+
.. _frontend-app-gradebook: https://github.com/openedx/frontend-app-gradebook
350+
.. _lms: https://github.com/openedx/edx-platform
351+
.. _frontend-app-program-console: https://github.com/openedx/frontend-app-program-console
352+
.. _registrar: https://github.com/openedx/registrar
353+
.. _studio: https://github.com/openedx/edx-platform
354+
.. _lms: https://github.com/openedx/edx-platform
355+
.. _frontend-app-learning: https://github.com/openedx/frontend-app-learning
356+
.. _frontend-app-library-authoring: https://github.com/openedx/frontend-app-library-authoring
357+
.. _frontend-app-course-authoring: https://github.com/openedx/frontend-app-course-authoring
358+
.. _frontend-app-account: https://github.com/openedx/frontend-app-account
359359
.. _frontend-app-profile: https://github.com/openedx/frontend-app-profile
360360
.. _frontend-app-authn: https://github.com/openedx/frontend-app-authn
361-
.. _xqueue: https://github.com/edx/xqueue
362-
.. _coursegraph: https://github.com/edx/edx-platform/tree/master/openedx/core/djangoapps/coursegraph
361+
.. _xqueue: https://github.com/openedx/xqueue
362+
.. _coursegraph: https://github.com/openedx/edx-platform/tree/master/cms/djangoapps/coursegraph#coursegraph-support
363363
.. _frontend-app-ora-grading: https://github.com/edx/frontend-app-ora-grading
364-
.. _insights: https://github.com/edx/edx-analytics-dashboard
365-
.. _analyticsapi: https://github.com/edx/edx-analytics-data-api
364+
.. _insights: https://github.com/openedx/edx-analytics-dashboard
365+
.. _analyticsapi: https://github.com/openedx/edx-analytics-data-api
366366

367367

368368
Known Issues
@@ -407,18 +407,18 @@ As a specific example, if ``OPENEDX_RELEASE`` is set in your environment as ``ju
407407
.. _licensing terms: https://www.docker.com/pricing/faq
408408
.. _Docker for Windows: https://docs.docker.com/docker-for-windows/
409409
.. _configuring Docker for Mac: https://docs.docker.com/docker-for-mac/#/advanced
410-
.. _feature added in Docker 17.05: https://github.com/edx/configuration/pull/3864
410+
.. _feature added in Docker 17.05: https://github.com/openedx/configuration/pull/3864
411411
.. _edx-e2e-tests README: https://github.com/edx/edx-e2e-tests/#how-to-run-lms-and-studio-tests
412412
.. _edxops Docker image: https://hub.docker.com/r/edxops/
413413
.. _Docker Hub: https://hub.docker.com/
414414
.. _Pycharm Integration documentation: docs/pycharm_integration.rst
415415
.. _devpi documentation: docs/devpi.rst
416-
.. _edx-platform testing documentation: https://github.com/edx/edx-platform/blob/master/docs/guides/testing/testing.rst#running-python-unit-tests
417-
.. |Build Status provisioning| image:: https://github.com/edx/devstack/actions/workflows/provisioning-tests.yml/badge.svg?branch=master
418-
:target: https://github.com/edx/devstack/actions/workflows/provisioning-tests.yml
416+
.. _edx-platform testing documentation: https://github.com/openedx/edx-platform/blob/master/docs/guides/testing/testing.rst#running-python-unit-tests
417+
.. |Build Status provisioning| image:: https://github.com/openedx/devstack/actions/workflows/provisioning-tests.yml/badge.svg?branch=master
418+
:target: https://github.com/openedx/devstack/actions/workflows/provisioning-tests.yml
419419
:alt: Provisioning tests
420-
.. |Build Status CLI| image:: https://github.com/edx/devstack/actions/workflows/cli-tests.yml/badge.svg?branch=master
421-
:target: https://github.com/edx/devstack/actions/workflows/cli-tests.yml
420+
.. |Build Status CLI| image:: https://github.com/openedx/devstack/actions/workflows/cli-tests.yml/badge.svg?branch=master
421+
:target: https://github.com/openedx/devstack/actions/workflows/cli-tests.yml
422422
:alt: CLI tests
423423
.. |docs| image:: https://readthedocs.org/projects/docs/badge/?version=latest
424424
:alt: Documentation Status

docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ services:
3535
container_name: "edx.${COMPOSE_PROJECT_NAME:-devstack}.coursegraph"
3636
hostname: coursegraph.devstack.edx
3737
# Try to keep this in sync with the NEO4J_VERSION declared within
38-
# https://github.com/edx/configuration/blob/master/playbooks/roles/neo4j
38+
# https://github.com/openedx/configuration/blob/master/playbooks/roles/neo4j
3939
image: neo4j:3.5.28
4040
networks:
4141
default:

docs/decisions/0004-backends-depend-on-frontends.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Consequences
6060
* An email and Slack message will be sent out to explain these changes and how we anticipate that they will impact developer workflows. The email will explain that if a micro-frontend is required to simulate common user story in the default configuration, then that frontend should be devstack, and should be automatically started by the relevant backend using ``depends_on``.
6161

6262

63-
.. _documentation in frontend-build: https://github.com/edx/frontend-build#local-module-configuration-for-webpack
63+
.. _documentation in frontend-build: https://github.com/openedx/frontend-build#local-module-configuration-for-webpack
6464
.. _ADR 5: ./0005-frontend-package-mounts.rst
6565

6666
Rejected Alternatives

docs/decisions/0005-frontend-package-mounts.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Current SOA: Local packages for frontends
3434

3535
Unfortunately, this flow is currently *not* an option for frontend services (i.e., micro-frontends) when they're run via devstack. This was probably not an intentional omission; frontend services were added to devstack in a somewhat ad-hoc way, and the local-package workflow was probably overlooked.
3636

37-
There is, however, an established strategy for using local packages when running frontends *outside* of devstack. This stategy is described in the `frontend-build documentation <https://github.com/edx/frontend-build#local-module-configuration-for-webpack>`_. Essentially, frontend package respositories can be placed anywhere in the host system, and each frontend's ``module.config.js`` can be pointed at those local respositories using a path relative to the frontend itself. For example:
37+
There is, however, an established strategy for using local packages when running frontends *outside* of devstack. This stategy is described in the `frontend-build documentation <https://github.com/openedx/frontend-build#local-module-configuration-for-webpack>`_. Essentially, frontend package respositories can be placed anywhere in the host system, and each frontend's ``module.config.js`` can be pointed at those local respositories using a path relative to the frontend itself. For example:
3838

3939
* A frontend dev has ``frontend-app-profile`` within their home folder (``~``).
4040
* They would like to run a modified version of Paragon, located at ``~/paragon``.
@@ -108,4 +108,4 @@ A more radical alternative would be to explicitly mount certain local frontend p
108108

109109
This approach would have been the most compatible with the existing local frontend package strategy, but it would sharply differ from devstack's backend package strategy.
110110

111-
For reference, here is a draft implementation of this rejected approach: https://github.com/edx/devstack/pull/795.
111+
For reference, here is a draft implementation of this rejected approach: https://github.com/openedx/devstack/pull/795.

docs/developing_on_named_release_branches.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ images until you change or unset ``OPENEDX_RELEASE`` again. To work on the
1818
master branches and ``latest`` images, unset ``OPENEDX_RELEASE`` or set it to
1919
an empty string.
2020

21-
.. _README.rst: https://github.com/edx/devstack
22-
.. _getting started: https://github.com/edx/devstack#getting-started
21+
.. _README.rst: https://github.com/openedx/devstack
22+
.. _getting started: https://github.com/openedx/devstack#getting-started
2323

2424
How do I run multiple named Open edX releases on same machine?
2525
--------------------------------------------------------------

docs/pycharm_integration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ use the following options:
5050
- Optional Environment variables:
5151

5252
- ``OPENEDX_RELEASE=release.version`` (i.e.: appropriate image tag; "juniper.master")
53-
- ``COMPOSE_PROJECT_NAME=docker-compose.container`` (i.e.: "devstack-juniper.master"; appropriate docker-compose container project for devstack multiple release (same machine); ensures specific Docker containers get used based on release name; Ref: https://github.com/edx/devstack/pull/532)
53+
- ``COMPOSE_PROJECT_NAME=docker-compose.container`` (i.e.: "devstack-juniper.master"; appropriate docker-compose container project for devstack multiple release (same machine); ensures specific Docker containers get used based on release name; Ref: https://github.com/openedx/devstack/pull/532)
5454

5555
- Python interpreter path:
5656

docs/testing_and_debugging.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,5 +118,5 @@ and run the tests manually via paver:
118118
The browser running the tests can be seen and interacted with via VNC as
119119
described above (Firefox is used by default).
120120

121-
.. _edx-platform testing documentation: https://github.com/edx/edx-platform/blob/master/docs/guides/testing/testing.rst#running-python-unit-tests
121+
.. _edx-platform testing documentation: https://github.com/openedx/edx-platform/blob/master/docs/guides/testing/testing.rst#running-python-unit-tests
122122
.. _edx-e2e-tests README: https://github.com/edx/edx-e2e-tests/#how-to-run-lms-and-studio-tests

0 commit comments

Comments
 (0)