Skip to content

Commit

Permalink
Merge pull request openedx-unsupported#966 from openedx/tcril/fix-gh-…
Browse files Browse the repository at this point in the history
…org-url

Fix github url strings (org edx -> openedx)
  • Loading branch information
sarina authored Sep 15, 2022
2 parents 7e6b9df + 597e71b commit c8e8d98
Show file tree
Hide file tree
Showing 14 changed files with 162 additions and 84 deletions.
88 changes: 83 additions & 5 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,5 +1,71 @@
# This is a file to standardize editor settings: http://EditorConfig.org

# ***************************
# ** DO NOT EDIT THIS FILE **
# ***************************
#
# 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
# repo's file.
#
# 2. Run:
#
# $ edx_lint write .editorconfig
#
# 3. This will modify the local file. Submit a pull request to get it
# checked in so that others will benefit.
#
#
# CENTRAL CHANGE:
#
# 1. Edit the .editorconfig file in the edx-lint repo at
# 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):
#
# $ 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 and
# publish the new version.
#
# 5. In your local repo, install the newer version of edx-lint.
#
# 6. Run:
#
# $ edx_lint write .editorconfig
#
# 7. This will modify the local file. Submit a pull request to get it
# checked in so that others will benefit.
#
#
#
#
#
# STAY AWAY FROM THIS FILE!
#
#
#
#
#
# SERIOUSLY.
#
# ------------------------------
# Generated by edx-lint version: 5.2.5
# ------------------------------
[*]
end_of_line = lf
insert_final_newline = true
Expand All @@ -11,12 +77,24 @@ trim_trailing_whitespace = true

[{Makefile, *.mk}]
indent_style = tab
indent_size = 8

[*.{js,json,yml,yaml}]
[*.{yml,yaml,json}]
indent_size = 2

[*.rst]
max_line_length = 79
[*.js]
indent_size = 2

[*.diff]
trim_trailing_whitespace = false

[.git/*]
trim_trailing_whitespace = false

[COMMIT_EDITMSG]
max_line_length = 72

[*.rst]
max_line_length = 79

# 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
56 changes: 28 additions & 28 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ platform. Use it to get up and running quickly with Open edX services.
Documentation is on `Read the Docs`_. Code repository is on `GitHub`_.

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

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

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

.. _credentials: https://github.com/edx/credentials
.. _discovery: https://github.com/edx/course-discovery
.. _ecommerce: https://github.com/edx/ecommerce
.. _edx_notes_api: https://github.com/edx/edx-notes-api
.. _forum: https://github.com/edx/cs_comments_service
.. _frontend-app-payment: https://github.com/edx/frontend-app-payment
.. _frontend-app-publisher: https://github.com/edx/frontend-app-publisher
.. _frontend-app-gradebook: https://github.com/edx/frontend-app-gradebook
.. _lms: https://github.com/edx/edx-platform
.. _frontend-app-program-console: https://github.com/edx/frontend-app-program-console
.. _registrar: https://github.com/edx/registrar
.. _studio: https://github.com/edx/edx-platform
.. _lms: https://github.com/edx/edx-platform
.. _frontend-app-learning: https://github.com/edx/frontend-app-learning
.. _frontend-app-library-authoring: https://github.com/edx/frontend-app-library-authoring
.. _frontend-app-course-authoring: https://github.com/edx/frontend-app-course-authoring
.. _frontend-app-account: https://github.com/edx/frontend-app-account
.. _credentials: https://github.com/openedx/credentials
.. _discovery: https://github.com/openedx/course-discovery
.. _ecommerce: https://github.com/openedx/ecommerce
.. _edx_notes_api: https://github.com/openedx/edx-notes-api
.. _forum: https://github.com/openedx/cs_comments_service
.. _frontend-app-payment: https://github.com/openedx/frontend-app-payment
.. _frontend-app-publisher: https://github.com/openedx/frontend-app-publisher
.. _frontend-app-gradebook: https://github.com/openedx/frontend-app-gradebook
.. _lms: https://github.com/openedx/edx-platform
.. _frontend-app-program-console: https://github.com/openedx/frontend-app-program-console
.. _registrar: https://github.com/openedx/registrar
.. _studio: https://github.com/openedx/edx-platform
.. _lms: https://github.com/openedx/edx-platform
.. _frontend-app-learning: https://github.com/openedx/frontend-app-learning
.. _frontend-app-library-authoring: https://github.com/openedx/frontend-app-library-authoring
.. _frontend-app-course-authoring: https://github.com/openedx/frontend-app-course-authoring
.. _frontend-app-account: https://github.com/openedx/frontend-app-account
.. _frontend-app-profile: https://github.com/openedx/frontend-app-profile
.. _frontend-app-authn: https://github.com/openedx/frontend-app-authn
.. _xqueue: https://github.com/edx/xqueue
.. _coursegraph: https://github.com/edx/edx-platform/tree/master/openedx/core/djangoapps/coursegraph
.. _xqueue: https://github.com/openedx/xqueue
.. _coursegraph: https://github.com/openedx/edx-platform/tree/master/cms/djangoapps/coursegraph#coursegraph-support
.. _frontend-app-ora-grading: https://github.com/edx/frontend-app-ora-grading
.. _insights: https://github.com/edx/edx-analytics-dashboard
.. _analyticsapi: https://github.com/edx/edx-analytics-data-api
.. _insights: https://github.com/openedx/edx-analytics-dashboard
.. _analyticsapi: https://github.com/openedx/edx-analytics-data-api


Known Issues
Expand Down Expand Up @@ -407,18 +407,18 @@ As a specific example, if ``OPENEDX_RELEASE`` is set in your environment as ``ju
.. _licensing terms: https://www.docker.com/pricing/faq
.. _Docker for Windows: https://docs.docker.com/docker-for-windows/
.. _configuring Docker for Mac: https://docs.docker.com/docker-for-mac/#/advanced
.. _feature added in Docker 17.05: https://github.com/edx/configuration/pull/3864
.. _feature added in Docker 17.05: https://github.com/openedx/configuration/pull/3864
.. _edx-e2e-tests README: https://github.com/edx/edx-e2e-tests/#how-to-run-lms-and-studio-tests
.. _edxops Docker image: https://hub.docker.com/r/edxops/
.. _Docker Hub: https://hub.docker.com/
.. _Pycharm Integration documentation: docs/pycharm_integration.rst
.. _devpi documentation: docs/devpi.rst
.. _edx-platform testing documentation: https://github.com/edx/edx-platform/blob/master/docs/guides/testing/testing.rst#running-python-unit-tests
.. |Build Status provisioning| image:: https://github.com/edx/devstack/actions/workflows/provisioning-tests.yml/badge.svg?branch=master
:target: https://github.com/edx/devstack/actions/workflows/provisioning-tests.yml
.. _edx-platform testing documentation: https://github.com/openedx/edx-platform/blob/master/docs/guides/testing/testing.rst#running-python-unit-tests
.. |Build Status provisioning| image:: https://github.com/openedx/devstack/actions/workflows/provisioning-tests.yml/badge.svg?branch=master
:target: https://github.com/openedx/devstack/actions/workflows/provisioning-tests.yml
:alt: Provisioning tests
.. |Build Status CLI| image:: https://github.com/edx/devstack/actions/workflows/cli-tests.yml/badge.svg?branch=master
:target: https://github.com/edx/devstack/actions/workflows/cli-tests.yml
.. |Build Status CLI| image:: https://github.com/openedx/devstack/actions/workflows/cli-tests.yml/badge.svg?branch=master
:target: https://github.com/openedx/devstack/actions/workflows/cli-tests.yml
:alt: CLI tests
.. |docs| image:: https://readthedocs.org/projects/docs/badge/?version=latest
:alt: Documentation Status
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ services:
container_name: "edx.${COMPOSE_PROJECT_NAME:-devstack}.coursegraph"
hostname: coursegraph.devstack.edx
# Try to keep this in sync with the NEO4J_VERSION declared within
# https://github.com/edx/configuration/blob/master/playbooks/roles/neo4j
# https://github.com/openedx/configuration/blob/master/playbooks/roles/neo4j
image: neo4j:3.5.28
networks:
default:
Expand Down
2 changes: 1 addition & 1 deletion docs/decisions/0004-backends-depend-on-frontends.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Consequences
* 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``.


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

Rejected Alternatives
Expand Down
4 changes: 2 additions & 2 deletions docs/decisions/0005-frontend-package-mounts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Current SOA: Local packages for frontends

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.

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:
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:

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

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.

For reference, here is a draft implementation of this rejected approach: https://github.com/edx/devstack/pull/795.
For reference, here is a draft implementation of this rejected approach: https://github.com/openedx/devstack/pull/795.
4 changes: 2 additions & 2 deletions docs/developing_on_named_release_branches.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ images until you change or unset ``OPENEDX_RELEASE`` again. To work on the
master branches and ``latest`` images, unset ``OPENEDX_RELEASE`` or set it to
an empty string.

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

How do I run multiple named Open edX releases on same machine?
--------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/pycharm_integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ use the following options:
- Optional Environment variables:

- ``OPENEDX_RELEASE=release.version`` (i.e.: appropriate image tag; "juniper.master")
- ``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)
- ``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)

- Python interpreter path:

Expand Down
2 changes: 1 addition & 1 deletion docs/testing_and_debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,5 +118,5 @@ and run the tests manually via paver:
The browser running the tests can be seen and interacted with via VNC as
described above (Firefox is used by default).

.. _edx-platform testing documentation: https://github.com/edx/edx-platform/blob/master/docs/guides/testing/testing.rst#running-python-unit-tests
.. _edx-platform testing documentation: https://github.com/openedx/edx-platform/blob/master/docs/guides/testing/testing.rst#running-python-unit-tests
.. _edx-e2e-tests README: https://github.com/edx/edx-e2e-tests/#how-to-run-lms-and-studio-tests
2 changes: 1 addition & 1 deletion docs/troubleshoot_general_tips.rst
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ Alternatively, if you are at a roadblock and
then you can always delete the repository and start over again::

rm -rf ./<repository>
git clone [email protected]:edx/<repository>
git clone [email protected]:openedx/<repository>

Finally, if you regularly find yourself mystified by git, consider reading
through `Understanding Git Conceptually`_. It explains core Git principles in way
Expand Down
76 changes: 38 additions & 38 deletions repo.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,59 +21,59 @@ fi
# (or non_release_repos and non_release_ssh_repos if they are not part
# of Open edX releases).
repos=(
"https://github.com/edx/course-discovery.git"
"https://github.com/edx/credentials.git"
"https://github.com/edx/cs_comments_service.git"
"https://github.com/edx/ecommerce.git"
"https://github.com/openedx/course-discovery.git"
"https://github.com/openedx/credentials.git"
"https://github.com/openedx/cs_comments_service.git"
"https://github.com/openedx/ecommerce.git"
"https://github.com/edx/edx-e2e-tests.git"
"https://github.com/edx/edx-notes-api.git"
"https://github.com/edx/edx-platform.git"
"https://github.com/edx/xqueue.git"
"https://github.com/edx/edx-analytics-dashboard.git"
"https://github.com/edx/frontend-app-gradebook.git"
"https://github.com/edx/frontend-app-payment.git"
"https://github.com/edx/frontend-app-publisher.git"
"https://github.com/edx/edx-analytics-dashboard.git"
"https://github.com/edx/edx-analytics-data-api.git"
"https://github.com/openedx/edx-notes-api.git"
"https://github.com/openedx/edx-platform.git"
"https://github.com/openedx/xqueue.git"
"https://github.com/openedx/edx-analytics-dashboard.git"
"https://github.com/openedx/frontend-app-gradebook.git"
"https://github.com/openedx/frontend-app-payment.git"
"https://github.com/openedx/frontend-app-publisher.git"
"https://github.com/openedx/edx-analytics-dashboard.git"
"https://github.com/openedx/edx-analytics-data-api.git"
)

non_release_repos=(
"https://github.com/openedx/frontend-app-authn.git"
"https://github.com/edx/frontend-app-course-authoring.git"
"https://github.com/edx/frontend-app-learning.git"
"https://github.com/edx/frontend-app-library-authoring.git"
"https://github.com/edx/registrar.git"
"https://github.com/edx/frontend-app-program-console.git"
"https://github.com/edx/frontend-app-account.git"
"https://github.com/openedx/frontend-app-course-authoring.git"
"https://github.com/openedx/frontend-app-learning.git"
"https://github.com/openedx/frontend-app-library-authoring.git"
"https://github.com/openedx/registrar.git"
"https://github.com/openedx/frontend-app-program-console.git"
"https://github.com/openedx/frontend-app-account.git"
"https://github.com/openedx/frontend-app-profile.git"
"https://github.com/edx/frontend-app-ora-grading.git"
)

ssh_repos=(
"[email protected]:edx/course-discovery.git"
"[email protected]:edx/credentials.git"
"[email protected]:edx/cs_comments_service.git"
"[email protected]:edx/ecommerce.git"
"[email protected]:openedx/course-discovery.git"
"[email protected]:openedx/credentials.git"
"[email protected]:openedx/cs_comments_service.git"
"[email protected]:openedx/ecommerce.git"
"[email protected]:edx/edx-e2e-tests.git"
"[email protected]:edx/edx-notes-api.git"
"[email protected]:edx/edx-platform.git"
"[email protected]:edx/xqueue.git"
"[email protected]:edx/edx-analytics-dashboard.git"
"[email protected]:edx/frontend-app-gradebook.git"
"[email protected]:edx/frontend-app-payment.git"
"[email protected]:edx/frontend-app-publisher.git"
"[email protected]:edx/edx-analytics-dashboard.git"
"[email protected]:edx/edx-analytics-data-api.git"
"[email protected]:openedx/edx-notes-api.git"
"[email protected]:openedx/edx-platform.git"
"[email protected]:openedx/xqueue.git"
"[email protected]:openedx/edx-analytics-dashboard.git"
"[email protected]:openedx/frontend-app-gradebook.git"
"[email protected]:openedx/frontend-app-payment.git"
"[email protected]:openedx/frontend-app-publisher.git"
"[email protected]:openedx/edx-analytics-dashboard.git"
"[email protected]:openedx/edx-analytics-data-api.git"
)

non_release_ssh_repos=(
"[email protected]:openedx/frontend-app-authn.git"
"[email protected]:edx/frontend-app-course-authoring.git"
"[email protected]:edx/frontend-app-learning.git"
"[email protected]:edx/frontend-app-library-authoring.git"
"[email protected]:edx/registrar.git"
"[email protected]:edx/frontend-app-program-console.git"
"[email protected]:edx/frontend-app-account.git"
"[email protected]:openedx/frontend-app-course-authoring.git"
"[email protected]:openedx/frontend-app-learning.git"
"[email protected]:openedx/frontend-app-library-authoring.git"
"[email protected]:openedx/registrar.git"
"[email protected]:openedx/frontend-app-program-console.git"
"[email protected]:openedx/frontend-app-account.git"
"[email protected]:openedx/frontend-app-profile.git"
"[email protected]:edx/frontend-app-ora-grading.git"
)
Expand Down
2 changes: 1 addition & 1 deletion scripts/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Windows
it from "devstack_snapshot/Docker for Windows Installer.exe".

4. Follow the instructions at
https://github.com/edx/devstack/blob/master/README-windows.rst
https://github.com/openedx/devstack/blob/master/README-windows.rst
(Unlike the macOS and Linux installations above, this will require
a network connection).

Expand Down
2 changes: 1 addition & 1 deletion scripts/make_warn_default_large.sh
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ You may prefer to use something like "make $target.lms" to
target a smaller set of services. Learn more about the commands you
can run at:
https://github.com/edx/devstack/blob/master/docs/devstack_interface.rst
https://github.com/openedx/devstack/blob/master/docs/devstack_interface.rst
Without an explicit list of services, many devstack Make targets pull
down Docker images you don't need or take up extra memory and CPU. You
Expand Down

0 comments on commit c8e8d98

Please sign in to comment.