diff --git a/README.rst b/README.rst index f5326771e..69617f547 100644 --- a/README.rst +++ b/README.rst @@ -29,6 +29,8 @@ Environment Variables * ``AUTHN_MINIMAL_HEADER`` - A boolean flag which hides the main menu, user menu, and logged-out menu items when truthy. This is intended to be used in micro-frontends like frontend-app-authentication in which these menus are considered distractions from the user's task. +* ``ENABLE_ORG_LOGO`` - A boolean flag to enable the display of the org logo on the center of the + header nav bar. Defaults to **false** ************ Installation @@ -36,7 +38,7 @@ Installation To install this header into your Open edX micro-frontend, run the following command in your MFE: -``npm i --save @edx/frontend-component-header`` +``npm i --save @nauedu/frontend-component-header`` This will make the component available to be imported into your application. @@ -73,6 +75,30 @@ Build a production distribution:: npm run build +*********** +Publishing to npmjs.com +*********** + +Any changes to this library have to be pushed to npmjs.com to be reflected on the build. + +Publish to npm:: + + npm publish + + +*********** +Deploy in production +*********** +To replace the default edx header with the new one, use one of the following instructions: + +Add the necessary settings to the mfe_brand plugin:: + + RUN npm install '@edx/frontend-component-header@npm:@nauedu/frontend-component-header' + +Alternatively, you can specify the version:: + + RUN npm install '@edx/frontend-component-header@npm:@nauedu/frontend-component-header@1.0.0' + .. |Build Status| image:: https://api.travis-ci.com/edx/frontend-component-header.svg?branch=master :target: https://travis-ci.com/edx/frontend-component-header .. |Codecov| image:: https://img.shields.io/codecov/c/github/edx/frontend-component-header diff --git a/src/learning-header/LearningHeader.jsx b/src/learning-header/LearningHeader.jsx index f79768c33..9241e59b1 100644 --- a/src/learning-header/LearningHeader.jsx +++ b/src/learning-header/LearningHeader.jsx @@ -31,7 +31,7 @@ LinkedLogo.propTypes = { }; // this feature flag is not included on the frontend-platform, we have to get it directly from ENV -const enabledOrgLogo = !!process.env.ENABLED_ORG_LOGO || false; +const enabledOrgLogo = !!process.env.ENABLE_ORG_LOGO || false; function LearningHeader({ courseOrg, courseTitle, intl, showUserDropdown,