diff --git a/README.rst b/README.rst index 019db0396d..20f8d50c10 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,12 @@ -|Build Status| |ci-badge| |Codecov| |semantic-release| - +################## frontend-app-authn -==================== +################## -Please tag **@openedx/vanguards** on any PRs or issues. Thanks! +|Build Status| |ci-badge| |Codecov| |semantic-release| -Introduction ------------- +******** +Purpose +******** This is a micro-frontend application responsible for the login, registration and password reset functionality. @@ -22,9 +22,12 @@ This is a micro-frontend application responsible for the login, registration and - Progressive profiling page +*************** +Getting Started +*************** Installation ------------- +============ This MFE is bundled with `Devstack `_, see the `Getting Started `_ section for setup instructions. @@ -46,7 +49,7 @@ This MFE is bundled with `Devstack `_, see **Note:** Follow `Enable social auth locally `_ for enabling Social Sign-on Buttons (SSO) locally Environment Variables/Setup Notes ---------------------------------- +================================= 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 `__. @@ -114,7 +117,7 @@ The authentication micro-frontend also requires the following additional variabl 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 might be unsupported in Open edX. @@ -138,7 +141,8 @@ For more information see the document: `Micro-frontend applications in Open edX `__. How To Contribute ------------- +================= + Contributions are very welcome, and strongly encouraged! We've put together `some documentation that describes our contribution process `_. @@ -149,34 +153,58 @@ can find it it at `PULL_REQUEST_TEMPLATE.md `_. People ------- +====== The assigned maintainers for this component and other project details may be found in `Backstage `_. Backstage pulls this data from the ``catalog-info.yaml`` file in this repo. Reporting Security Issues -------------------------- +========================= Please do not report security issues in public. Please email security@openedx.org. Known Issues ------------- +============ None License -------- +======= The code in this repository is licensed under the GNU Affero General Public License v3.0, unless otherwise noted. Please see `LICENSE `_ for details. + ============================== .. |Build Status| image:: https://api.travis-ci.com/edx/frontend-app-authn.svg?branch=master