From 1d95af5a313c853bbb5a5642088c91a35905d090 Mon Sep 17 00:00:00 2001 From: Jhon Vente <134975835+johnvente@users.noreply.github.com> Date: Thu, 24 Aug 2023 08:16:27 -0500 Subject: [PATCH] [DOCS] Readme updated according OEP-55 (#526) --- README.rst | 160 +++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 137 insertions(+), 23 deletions(-) diff --git a/README.rst b/README.rst index 0b2fcbc708..7b0dfcec30 100644 --- a/README.rst +++ b/README.rst @@ -1,19 +1,65 @@ -|Build Status| |Codecov| |license| - -############################# frontend-app-course-authoring ############################# -Please tag `@edx/teaching-and-learning `_ on any PRs or issues. Thanks. +|license-badge| |status-badge| |codecov-badge| -************ -Introduction -************ + +Purpose +******* This is the Course Authoring micro-frontend, currently under development by `2U `_. Its purpose is to provide both a framework and UI for new or replacement React-based authoring features outside ``edx-platform``. You can find the current set described below. + +************ +Getting Started +************ + +Prerequisites +============= + +The `devstack`_ is currently recommended as a development environment for your +new MFE. If you start it with ``make dev.up.lms`` that should give you +everything you need as a companion to this frontend. + +Note that it is also possible to use `Tutor`_ to develop an MFE. You can refer +to the `relevant tutor-mfe documentation`_ to get started using it. + +.. _Devstack: https://github.com/openedx/devstack + +.. _Tutor: https://github.com/overhangio/tutor + +.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe#mfe-development + +Cloning and Startup +=================== + + +1. Clone the repo: + + ``git clone https://github.com/openedx/frontend-app-course-authoring.git`` + +2. Use node v18.x. + + The current version of the micro-frontend build scripts support node 18. + Using other major versions of node *may* work, but this is unsupported. For + convenience, this repository includes an .nvmrc file to help in setting the + correct node version via `nvm use`_. + +3. Install npm dependencies: + + ``cd frontend-app-course-authoring && npm install`` + + +4. Start the dev server: + + ``npm start`` + + +The dev server is running at `http://localhost:2001 `_. +or whatever port you setup. + ******** Features ******** @@ -151,22 +197,6 @@ Developing `Devstack `_. If you start Devstack with ``make dev.up.studio`` that should give you everything you need as a companion to this frontend. -Installation and Startup -======================== - -1. Clone the repo: - - ``git clone https://github.com/openedx/frontend-app-course-authoring.git`` - -2. Install npm dependencies: - - ``cd frontend-app-course-authoring && npm install`` - -3. Start the dev server: - - ``npm start`` - -The dev server is running at `http://localhost:2001 `_. If your devstack includes the default Demo course, you can visit the following URLs to see content: @@ -197,3 +227,87 @@ The production build is created with ``npm run build``. :target: https://codecov.io/gh/edx/frontend-app-course-authoring .. |license| image:: https://img.shields.io/npm/l/@edx/frontend-app-course-authoring.svg :target: @edx/frontend-app-course-authoring + +Internationalization +==================== + +Please see refer to the `frontend-platform i18n howto`_ for documentation on +internationalization. + +.. _frontend-platform i18n howto: https://github.com/openedx/frontend-platform/blob/master/docs/how_tos/i18n.rst + +Getting Help +************ + +If you're having trouble, we have discussion forums at +https://discuss.openedx.org where you can connect with others in the community. + +Our real-time conversations are on Slack. You can request a `Slack +invitation`_, then join our `community Slack workspace`_. Because this is a +frontend repository, the best place to discuss it would be in the `#wg-frontend +channel`_. + +For anything non-trivial, the best path is to open an issue in this repository +with as many details about the issue you are facing as you can provide. + +https://github.com/openedx/frontend-app-course-authoring/issues + +For more information about these options, see the `Getting Help`_ page. + +.. _Slack invitation: https://openedx.org/slack +.. _community Slack workspace: https://openedx.slack.com/ +.. _#wg-frontend channel: https://openedx.slack.com/archives/C04BM6YC7A6 +.. _Getting Help: https://openedx.org/community/connect + +License +******* + +The code in this repository is licensed under the AGPLv3 unless otherwise +noted. + +Please see `LICENSE `_ for details. + +Contributing +************ + +Contributions are very welcome. Please read `How To Contribute`_ for details. + +.. _How To Contribute: https://openedx.org/r/how-to-contribute + +This project is currently accepting all types of contributions, bug fixes, +security fixes, maintenance work, or new features. However, please make sure +to have a discussion about your new feature idea with the maintainers prior to +beginning development to maximize the chances of your change being accepted. +You can start a conversation by creating a new issue on this repo summarizing +your idea. + +The Open edX Code of Conduct +**************************** + +All community members are expected to follow the `Open edX Code of Conduct`_. + +.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/ + +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. + +.. _Backstage: https://open-edx-backstage.herokuapp.com/catalog/default/component/frontend-app-course-authoring + +Reporting Security Issues +************************* + +Please do not report security issues in public, and email security@openedx.org instead. + +.. |license-badge| image:: https://img.shields.io/github/license/openedx/frontend-app-course-authoring.svg + :target: https://github.com/openedx/frontend-app-course-authoring/blob/master/LICENSE + :alt: License + +.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen + +.. |codecov-badge| image:: https://codecov.io/github/openedx/frontend-app-course-authoring/coverage.svg?branch=master + :target: https://codecov.io/github/openedx/frontend-app-course-authoring?branch=master + :alt: Codecov \ No newline at end of file