1- Part of `edX code `__.
2-
3- __ http://code.edx.org/
4-
51edX Student Notes API |build-status |
6- ====================================
2+ ####################################
73
84This is a backend store for edX Student Notes.
95
106Overview
11- --------
7+ ********
128
139The edX Notes API is designed to be compatible with the `Annotator <http://annotatorjs.org/ >`__.
1410
1511Getting Started
16- ---------------
12+ ***************
1713
18141. Install `ElasticSearch 7.8.0 <https://www.elastic.co/blog/elasticsearch-7-8-0-released >`__.
1915
20162. Install the requirements:
2117
22- ::
18+ .. code-block :: bash
2319
24- $ make develop
20+ make develop
2521
2622 3. Create index and put mapping:
2723
28- ::
24+ .. code-block :: bash
2925
30- $ make create-index
26+ make create-index
3127
3228 4. Run the server:
3329
34- ::
30+ .. code-block :: bash
3531
36- $ make run
32+ make run
3733
38- Configuration:
39- --------------
34+ Configuration
35+ *************
4036
4137``CLIENT_ID `` - OAuth2 Client ID, which is to be found in ``aud `` field of IDTokens which authorize users
4238
@@ -49,40 +45,41 @@ Configuration:
4945``ELASTICSEARCH_DSL['default']['hosts'] `` - Your ElasticSearch host
5046
5147Running Tests
52- -------------
48+ *************
5349
5450Run ``make validate `` install the requirements, run the tests, and run
5551lint.
5652
5753How To Resync The Index
58- -----------------------
54+ ***********************
55+
5956edX Notes Store uses `Django elasticsearch DSL <https://django-elasticsearch-dsl.readthedocs.io/ >`_ which comes with several management commands.
6057
6158Please read more about ``search_index `` management commands
6259`here <https://django-elasticsearch-dsl.readthedocs.io/en/latest/management.html >`_.
6360
6461License
65- -------
62+ *******
6663
6764The code in this repository is licensed under version 3 of the AGPL unless
6865otherwise noted.
6966
7067Please see ``LICENSE.txt `` for details.
7168
7269How To Contribute
73- -----------------
70+ *****************
7471
7572Contributions are very welcome.
7673
7774Please read `How To Contribute <https://github.com/openedx/.github/blob/master/CONTRIBUTING.md >`_ for details.
7875
7976Reporting Security Issues
80- -------------------------
77+ *************************
8178
8279Please do not report security issues in public. Please email security@openedx.org
8380
8481Mailing List and IRC Channel
85- ----------------------------
82+ ****************************
8683
8784You can discuss this code on the `edx-code Google Group `__ or in the
8885``edx-code `` IRC channel on Freenode.
0 commit comments