diff --git a/.env.development b/.env.development index 10e112c..e71720d 100644 --- a/.env.development +++ b/.env.development @@ -17,9 +17,8 @@ SEGMENT_KEY=null SITE_NAME=localhost SUPPORT_URL='http://localhost:18000/support' USER_INFO_COOKIE_NAME='edx-user-info' -# Temporary, Remove this once we are ready to release the feature. -COACHING_ENABLED=true -ENABLE_DEMOGRAPHICS_COLLECTION=true +COACHING_ENABLED=false +ENABLE_DEMOGRAPHICS_COLLECTION=false LOGO_URL=https://edx-cdn.org/v3/default/logo.svg LOGO_TRADEMARK_URL=https://edx-cdn.org/v3/default/logo-trademark.svg LOGO_WHITE_URL=https://edx-cdn.org/v3/default/logo-white.svg diff --git a/README.rst b/README.rst index ceb8fb6..336efd8 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,7 @@ frontend-app-account ==================== -Please tag **@sarina** on any PRs or issues. Thanks! +Please tag **@edx/community-engineering** on any PRs or issues. Thanks! Introduction ------------ @@ -32,7 +32,7 @@ This MFE is bundled with `Devstack `_, see the 3. Log in to Devstack (http://localhost:18000/login ) 4. Within this project, install requirements and start the development server: - + .. code-block:: npm install @@ -45,7 +45,39 @@ This MFE is bundled with `Devstack `_, see the Environment Variables/Setup Notes --------------------------------- -This MFE is configured via node environment variables supplied at build time. See the `.env` file for the list of required environment variables. +This MFE is configured via environment variables supplied at build time. All micro-frontends have a shared set of required environment variables, as documented in the Open edX Developer Guide under `Required Environment Variables `__. + +The account settings micro-frontend also supports the following additional variable: + +``SUPPORT_URL`` + +Example: ``https://support.example.com`` + +The fully-qualified URL to the support page in the target environment. + +edX-specific Environment Variables +********************************** + +Furthermore, there are several edX-specific environment variables that enable integrations with closed-source services private to the edX organization, and are unsupported in Open edX. Enabling these environment variables will result in undefined behavior in Open edX installations: + +``COACHING_ENABLED`` + +Example: ``true`` | ``''`` (empty strings are falsy) + +Enables support for a section of the micro-frontend that helps users arrange for coaching sessions. Integrates with a private coaching plugin and is only used by edx.org. + +``ENABLE_DEMOGRAPHICS_COLLECTION`` + +Example: ``true`` | ``''`` (empty strings are falsy) + +Enables support for a section of the account settings page where a user can enter demographics information. Integrates with a private demographics service and is only used by edx.org. + +``DEMOGRAPHICS_BASE_URL`` + +Example: ``https://demographics.example.com`` + +Required only if ``ENABLE_DEMOGRAPHICS_COLLECTION`` is true. The fully-qualified URL to the private demographics service in the target environment. + Example build syntax with a single environment variable: .. code:: bash @@ -53,7 +85,7 @@ Example build syntax with a single environment variable: NODE_ENV=development ACCESS_TOKEN_COOKIE_NAME='edx-jwt-cookie-header-payload' npm run build For more information see the document: `Micro-frontend applications in Open -edX `__. +edX `__. Known Issues ------------