refactor: updated README file to reflect template changes (#353)

README.rst

@@ -1,12 +1,14 @@
-|Build Status| |Codecov| |license|
-
+###############################
 frontend-app-library-authoring
-==============================
+###############################
+
+|Build Status| |Codecov| |license|
 
 Please tag **@edx/fedx-team** on any PRs or issues.  Thanks.
 
-Introduction
-------------
+********
+Purpose
+********
 
 This is the Library Authoring micro-frontend, currently under joint development by `edX <https://www.edx.org>`_ and
 `OpenCraft <https://www.opencraft.com>`_ under the auspices of `BD-14
@@ -22,17 +24,45 @@ powered by the new `blockstore <https://github.com/openedx/blockstore>`_ storage
    in a content library can be integrated into a course, used as a problem bank for randomized exams, and/or shown to
    learners directly for à la carte learning.
 
+***************
+Getting Started
+***************
+
 Tutor Installation
-------------------
+===================
 
 Refer to the `tutor-contrib-library-authoring-mfe`_ plugin for instructions on how to deploy this using Tutor.
 
 .. _tutor-contrib-library-authoring-mfe: https://github.com/openedx/openedx-tutor-plugins/tree/main/plugins/tutor-contrib-library-authoring-mfe
 
+Cloning and Startup
+===================
+
+.. code-block::
+
+  1. Clone your new repo:
+
+    ``git clone https://github.com/openedx/frontend-app-library-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 <https://github.com/nvm-sh/nvm>`_.
+
+  3. Install npm dependencies:
+
+    ``cd frontend-app-library-authoring && npm ci``
+
+  4. Start the dev server:
+
+    ``npm start``
+
 Devstack Installation
----------------------
+=====================
 
-Follw these steps to provision, run, and enable an instance of the Library Authoring MFE for local development via the
+Follow these steps to provision, run, and enable an instance of the Library Authoring MFE for local development via the
 `official Open edX devstack
 <https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/installation/index.html>`_.
 
@@ -122,21 +152,21 @@ Follw these steps to provision, run, and enable an instance of the Library Autho
    .. image:: ./docs/images/screenshot_adding_components.png
 
 Project Structure
------------------
+=================
 
 The source for this project is organized into nested submodules according to the ADR `Feature-based Application
 Organization
 <https://github.com/openedx/frontend-template-application/blob/master/docs/decisions/0002-feature-based-application-organization.rst>`_.
 
 Build Process Notes
--------------------
+===================
 
 **Production Build**
 
 The production build is created with ``npm run build``.
 
 Internationalization
---------------------
+====================
 
 Please see `edx/frontend-platform's i18n module
 <https://edx.github.io/frontend-platform/module-Internationalization.html>`_ for documentation on internationalization.
@@ -151,7 +181,7 @@ The documentation explains how to use it, and the `How To
    :target: @edx/frontend-app-library-authoring
 
 Known Issues
-------------
+============
 
 * [SE-3989] There is a fatal blockstore integration test failure that is likely triggering search bugs, related to
   `edx/edx-search#104 <https://github.com/openedx/edx-search/pull/104>`_.
@@ -184,7 +214,7 @@ Known Issues
 * Test coverage can, and should, be improved.
 
 Development Roadmap
--------------------
+==================
 
 The following is a list of current short-term development targets, in (rough) descending order of priority:
 
@@ -196,3 +226,61 @@ The following is a list of current short-term development targets, in (rough) de
 * [MFE enhancement] Iteration and refinement of the library authoring/publishing flow.
 
 * [MFE bugfix] Fixing the `Known Issues <#known-issues>`_ that are not explicitly listed in this Roadmap.
+
+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-library-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
+
+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/
+
+License
+=======
+
+The code in this repository is licensed under the AGPLv3 unless otherwise
+noted.
+
+Please see `LICENSE <LICENSE>`_ for details.
+
+Reporting Security Issues
+=========================
+
+Please do not report security issues in public. Please email [email protected].