Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

These are the things that are not right about our templated repos going into the edx GitHub organization.

Python repos

I made a repo with the edx-cookiecutters repo to make a Python library, and found parts that would have to change for repos in the edx GitHub organization instead of the openedx organization. There are other repo types that can be created, I didn’t check all the types.

edx-cookiecutters has an issue for dealing with these organization differencesThis has been moved into the (private) 2U wiki: https://github.com/openedx/edx-cookiecutters/issues/308

README

  • Purpose

    • Includes a TODO: “It should be described in the context of other repositories under the ``openedx`` organization. It should make clear where this fits in to the overall Open edX codebase and should be oriented towards people who are new to the Open edX project.”

  • Deploying / Documentation

    • Both refer to docs.openedx.org

  • More Help

  • Contributing

    • edx repos are not currently accepting contributions.

  • Code of Conduct

    • It’s a little counter-intuitive, but I think it’s fine to keep the references to the Open edX code of conduct.

  • People

    • Links to backstage.openedx.org

  • Security

openedx.yaml

  • It should not have an openedx-release section.

setup.py

  • The author and author_email values need to be corrected to “edX” and “oscm@edx.org”

    • (that’s what’s in the cookiecutter now, but we have to fix that to be Axim-centric.)

No changes needed

  • catalog-info.yaml

  • CHANGELOG.rst

  • LICENSE.txt

  • Makefile

  • setup.cfg

  • tox.ini

MFE repos

MFE repos are templated from the frontend-template-application repo.

Throughout

  • Fix github.com URLs to have the correct GitHub organization.

README

openedx.yaml

...

2u-internal.atlassian.net/wiki/spaces/ENG/pages/493453499/Repo+deltas+for+edx+GitHub+repos