Skip to content

Commit 67700e8

Browse files
authored
refactor: updated README file to reflect template changes (#592)
1 parent 1cb8ad3 commit 67700e8

File tree

1 file changed

+49
-13
lines changed

1 file changed

+49
-13
lines changed

README.rst

Lines changed: 49 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,42 @@
1+
########################
2+
frontend-app-discussions
3+
########################
4+
15
|Codecov| |license|
26

37
.. |Codecov| image:: https://codecov.io/gh/openedx/frontend-app-discussions/branch/master/graph/badge.svg?token=3z7XvuzTq3
48
:target: https://codecov.io/gh/openedx/frontend-app-discussions
59
.. |license| image:: https://img.shields.io/badge/license-AGPL-informational
610
:target: https://github.com/openedx/frontend-app-discussions/blob/master/LICENSE
711

8-
frontend-app-discussions
9-
========================
10-
11-
Introduction
12-
------------
12+
********
13+
Purpose
14+
********
1315

1416
This repository is a React-based micro frontend for the Open edX discussion forums.
1517

18+
***************
1619
Getting Started
17-
---------------
20+
***************
21+
22+
Prerequisites
23+
=============
24+
25+
The `devstack`_ is currently recommended as a development environment for your
26+
new MFE. If you start it with ``make dev.up.lms`` that should give you
27+
everything you need as a companion to this frontend.
28+
29+
Note that it is also possible to use `Tutor`_ to develop an MFE. You can refer
30+
to the `relevant tutor-mfe documentation`_ to get started using it.
31+
32+
.. _Devstack: https://github.com/openedx/devstack
33+
34+
.. _Tutor: https://github.com/overhangio/tutor
35+
36+
.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe#mfe-development
37+
38+
Cloning and Startup
39+
===================
1840

1941
1. Clone your new repo:
2042

@@ -31,7 +53,7 @@ Getting Started
3153
The dev server is running at `http://localhost:2002 <http://localhost:2002>`_.
3254

3355
Getting Help
34-
------------
56+
============
3557
Please tag **@openedx/edx-infinity ** on any PRs or issues. Thanks.
3658
3759
If you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.
@@ -44,7 +66,8 @@ For more information about these options, see the `Getting Help`_ page.
4466
.. _Getting Help: https://openedx.org/getting-help
4567

4668
How to Contribute
47-
-----------------
69+
=================
70+
4871
Details about how to become a contributor to the Open edX project may be found in the wiki at `How to contribute`_
4972

5073
.. _How to contribute: https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/process/index.html
@@ -55,32 +78,45 @@ can find it it at `PULL_REQUEST_TEMPLATE.md <https://github.com/openedx/frontend
5578
This project is currently accepting all types of contributions, bug fixes and security fixes
5679

5780
The Open edX Code of Conduct
58-
----------------------------
81+
============================
5982
All community members should familiarize themselves with the `Open edX Code of Conduct`_.
6083

6184
.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/
6285

6386
People
64-
------
87+
======
6588
The assigned maintainers for this component and other project details may be found in Backstage or from inspecting catalog-info.yaml.
6689

6790
Reporting Security Issues
6891
-------------------------
6992
Please do not report security issues in public. Please email security@openedx.org.
7093

7194
Project Structure
72-
-----------------
95+
=================
7396

7497
The source for this project is organized into nested submodules according to the ADR `Feature-based Application Organization <https://github.com/openedx/frontend-app-discussions/blob/master/docs/decisions/0002-feature-based-application-organization.rst>`_.
7598

7699
Build Process Notes
77-
-------------------
100+
===================
78101

79102
**Production Build**
80103

81104
The production build is created with ``npm run build``.
82105

106+
License
107+
=======
108+
109+
The code in this repository is licensed under the AGPLv3 unless otherwise
110+
noted.
111+
112+
Please see `LICENSE <LICENSE>`_ for details.
113+
83114
Internationalization
84-
--------------------
115+
====================
85116

86117
Please see `edx/frontend-platform's i18n module <https://edx.github.io/frontend-platform/module-Internationalization.html>`_ for documentation on internationalization. The documentation explains how to use it, and the `How To <https://github.com/openedx/frontend-i18n/blob/master/docs/how_tos/i18n.rst>`_ has more detail.
118+
119+
Reporting Security Issues
120+
=========================
121+
122+
Please do not report security issues in public. Please email security@openedx.org.

0 commit comments

Comments
 (0)