diff --git a/.github/workflows/lockfileversion-check.yml b/.github/workflows/lockfileversion-check.yml index 901adddf67..42312e8cbf 100644 --- a/.github/workflows/lockfileversion-check.yml +++ b/.github/workflows/lockfileversion-check.yml @@ -10,4 +10,4 @@ on: jobs: version-check: - uses: edx/.github/.github/workflows/lockfileversion-check.yml@master + uses: openedx/.github/.github/workflows/lockfileversion-check.yml@master diff --git a/.gitignore b/.gitignore index 61935e238e..b7f6e6614e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,5 @@ # local dev related -# https://github.com/edx/frontend-build#local-module-configuration-for-webpack +# https://github.com/openedx/frontend-build#local-module-configuration-for-webpack .env.private module.config.js diff --git a/README.md b/README.md index c334e737d6..4adde0daba 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # frontend-app-learner-portal-enterprise -![Build Status](https://github.com/edx/frontend-app-learner-portal-enterprise/actions/workflows/ci.yml/badge.svg) +![Build Status](https://github.com/openedx/frontend-app-learner-portal-enterprise/actions/workflows/ci.yml/badge.svg) ## Overview The edX learning platform's frontend for enterprise learners. @@ -35,9 +35,9 @@ Now quickly check the .env.development file for which services are used by the a An enterprise portal will need a couple of roles: The Enterprise customer, and at least one learner account. -Next we will setup a `test-enterprise` customer who will have learners associated with it (Details at [The Enterprise management commands](https://github.com/edx/edx-enterprise/blob/master/enterprise/management/commands/seed_enterprise_devstack_data.py#L47)): +Next we will setup a `test-enterprise` customer who will have learners associated with it (Details at [The Enterprise management commands](https://github.com/openedx/edx-enterprise/blob/master/enterprise/management/commands/seed_enterprise_devstack_data.py#L47)): - - Ensure the Enterprise Integration flag is enabled in devstack [see this link](https://github.com/edx/edx-platform/blob/0e2b612c1fb4f3e385f3004801aa5b5ed0221eda/lms/envs/devstack.py#L331). Set the flag `ENABLE_ENTERPRISE_INTEGRATION` to True if it isn't already + - Ensure the Enterprise Integration flag is enabled in devstack [see this link](https://github.com/openedx/edx-platform/blob/0e2b612c1fb4f3e385f3004801aa5b5ed0221eda/lms/envs/devstack.py#L331). Set the flag `ENABLE_ENTERPRISE_INTEGRATION` to True if it isn't already - From the devstack directory, restart lms using `make lms-restart` for applying changes - Seed test data: - Go into the lms shell: @@ -96,7 +96,7 @@ For this, an easy way is to use the Studio! Usually at http://localhost:18010 You need this, if you need to make changes to the API endpoints or anything else in edx-enterprise project -We have edx-enterprise Django module running inside of the LMS (which is started by devstack). Refer to [Devstack Doc](https://github.com/edx/devstack) for details. This is what serves endpoints used by the application. To make changes, you will replace that available install of edx-enterprise with your local version +We have edx-enterprise Django module running inside of the LMS (which is started by devstack). Refer to [Devstack Doc](https://github.com/openedx/devstack) for details. This is what serves endpoints used by the application. To make changes, you will replace that available install of edx-enterprise with your local version * Setup devstack if not already and at least have the `lms` service running. Typically cd'ing to the devstack folder, and running `make dev.up` or `make dev.nfs.up` will do it * Ensure you can browse to LMS at least, http://localhost:18000 @@ -104,7 +104,7 @@ We have edx-enterprise Django module running inside of the LMS (which is started * Sync edx-enterprise into the src/ folder of your work folder (e.g. ~/work/src/edx-enterprise) * Ensure this env var is set in your env for the docker mount to be located correctly, e.g.,: `DEVSTACK_WORKSPACE=/Users/$USER/work` , in your shell config file * Either start new shell or run `exec "$SHELL"` for changes to take effect in the shell -* Start backend services needed (refer to .env.development file). Refer to [Devstack Doc](https://github.com/edx/devstack) for details +* Start backend services needed (refer to .env.development file). Refer to [Devstack Doc](https://github.com/openedx/devstack) for details If all worked you should be able to navigate to http://localhost:18000/admin/enterprise/ But wait, it won't work yet. As long as you get some reasonable response here, you are good (probably a login page). @@ -207,7 +207,7 @@ TODO/WIP * edX * [Onboarding for devs](https://openedx.atlassian.net/wiki/spaces/ENG/pages/12550298/Developer+Onboarding) - * [Devstack Doc](https://github.com/edx/devstack) + * [Devstack Doc](https://github.com/openedx/devstack) * [Enterprise docs](https://openedx.atlassian.net/wiki/spaces/SOL/pages/997654609/Hitchhiker+s+Engineer+s+Guide+to+the+Enterprise+Ecosystem) * * External diff --git a/docs/decisions/0003-static-builds-to-client-side-react.rst b/docs/decisions/0003-static-builds-to-client-side-react.rst index 398c90b0fc..9858af1e73 100644 --- a/docs/decisions/0003-static-builds-to-client-side-react.rst +++ b/docs/decisions/0003-static-builds-to-client-side-react.rst @@ -35,7 +35,7 @@ Decision While it would be great if the Enterprise learner portal could take advantage of the benefits for using Gatsby (e.g., faster page loads), it does not make as much sense given the tradeoffs mentioned above. This is because the Enterprise learner portal relies mostly on dynamic data in such a way that would not allow us to realize the advantage of a statically rendered app. Additionally, the Enterprise learner portal does not have a requirement for supporting SEO best practices since it is used by existing customers (presumably with direct access to the URL) as opposed to a marketing site that will be crawled by search engine bots. -That said, we will be migrating the Enterprise learner portal off of Gatsby and its multi-site build process / infrastructure. Instead, the Enterprise learner portal will become a standard client-side React application (microfrontend) that utilizes many of the recent advancements in the frontend ecosystem at edX (e.g., ``@edx/frontend-build``, ``@edx/frontend-platform``). In addition, the Enterprise learner portal will no longer rely on the shared UI components in ``@edx/frontend-learner-portal-base``. +That said, we will be migrating the Enterprise learner portal off of Gatsby and its multi-site build process / infrastructure. Instead, the Enterprise learner portal will become a standard client-side React application (microfrontend) that utilizes many of the recent advancements in the frontend ecosystem at edX (e.g., ``@openedx/frontend-build``, ``@openedx/frontend-platform``). In addition, the Enterprise learner portal will no longer rely on the shared UI components in ``@openedx-unsupported/frontend-learner-portal-base``. ************ Consequences @@ -45,8 +45,8 @@ Consequences * That said, we will want to be intentional about how we do client-side data fetching to reduce the amount of perceived loading time for the user. * Additionally, any updates to the data by internal admins (e.g., the ECS team) will propogate immediately instead of needing to trigger a rebuild/redeploy. * The Enterprise learner portal will no longer use multi-site build process / infrastructure. Rather, the Enterprise learner portal will use the same build process and infrastructure as other standard microfrontends at edX. -* The Enterprise learner portal will begin using ``@edx/frontend-build`` and ``@edx/frontend-platform`` to be in line with other microfrontends at edX and reduce common boilerplate. -* Ownership of the ``gatsby-source-portal-designer`` Gatsby plugin and the ``@edx/frontend-learner-portal-base`` NPM package will be transitioned to the Programs engineering team(s). +* The Enterprise learner portal will begin using ``@openedx/frontend-build`` and ``@openedx/frontend-platform`` to be in line with other microfrontends at edX and reduce common boilerplate. +* Ownership of the ``gatsby-source-portal-designer`` Gatsby plugin and the ``@openedx-unsupported/frontend-learner-portal-base`` NPM package will be transitioned to the Programs engineering team(s). ********** References @@ -54,8 +54,8 @@ References * https://www.gatsbyjs.org/ * https://github.com/edx/gatsby-source-portal-designer -* https://github.com/edx/frontend-learner-portal-base +* https://github.com/openedx-unsupported/frontend-learner-portal-base * https://dev.to/maniekm/when-not-to-use-gatsbyjs-oic * https://blog.jakoblind.no/gatsby-vs-next/ -* https://github.com/edx/frontend-platform -* https://github.com/edx/frontend-build +* https://github.com/openedx/frontend-platform +* https://github.com/openedx/frontend-build diff --git a/package.json b/package.json index 26bf0c4ea8..f4c95bd05c 100644 --- a/package.json +++ b/package.json @@ -92,6 +92,6 @@ }, "repository": { "type": "git", - "url": "https://github.com/edx/frontend-app-learner-portal-enterprise.git" + "url": "https://github.com/openedx/frontend-app-learner-portal-enterprise.git" } }