Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
C
course-discovery
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
edx
course-discovery
Commits
f2de3c5f
Commit
f2de3c5f
authored
Jun 16, 2016
by
Joyce Zhu
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Improve developer setup docs
parent
228912dd
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
16 additions
and
2 deletions
+16
-2
docs/course_metadata.rst
+6
-0
docs/getting_started.rst
+9
-1
docs/testing.rst
+1
-1
No files found.
docs/course_metadata.rst
View file @
f2de3c5f
...
...
@@ -22,6 +22,12 @@ The ``refresh_course_metadata`` command in :file:`course_discovery/apps/course_m
loaders should be idempotent -- that is, running this command once will populate the database, and if nothing has
changed upstream then running it again should not change the database.
For example, if you use the JWT access token "secret-ecommerce-key" to authenticate API calls, run the following:
.. code-block:: bash
$ ./manage.py refresh_course_metadata --access_token secret-ecommerce-key --token_type jwt
QuerySets
---------
...
...
docs/getting_started.rst
View file @
f2de3c5f
...
...
@@ -6,6 +6,14 @@ below is executed within the virtualenv.
.. _virtualenv: https://virtualenvwrapper.readthedocs.org/en/latest/
.. note:: Installing virtualenvwrapper with pip on OS X El Capitan may result
in a strange OSError due to `a compatibility issue with the six package
<https://github.com/pypa/pip/issues/3165>`_. In this case, instruct pip to
ignore six:
.. code-block:: bash
$ pip install virtualenvwrapper --upgrade --ignore-installed six
Install dependencies
--------------------
...
...
@@ -47,7 +55,7 @@ A new OAuth 2.0 client can be created at ``http://127.0.0.1:8000/admin/oauth2/cl
8. Click :guilabel:`Save`.
Now that you have the client credentials, you can update your settings (ideally in
:file:`course_discovery/settings/
local
.py`). The table below describes the relevant settings.
:file:`course_discovery/settings/
private
.py`). The table below describes the relevant settings.
+-----------------------------------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------+
| Setting | Description | Value |
...
...
docs/testing.rst
View file @
f2de3c5f
...
...
@@ -22,4 +22,4 @@ prevents us from using it in this repository. Were you to use `httpretty`, you w
mock an OAuth2 endpoint, `httpretty` blocks requests to Elasticsearch, leading to test failures.
Given our extensive use of Elasticsearch, and need to mock HTTP endpoints, we use the
`responses <https://github.com/getsentry/responses>`_ library. It
'
s API is practically the same as that of `httpretty.
`responses <https://github.com/getsentry/responses>`_ library. Its API is practically the same as that of `httpretty.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment