Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

update discussion forum doc

Browse Source
This commit is contained in:
Jay Zoldak
2013-09-26 16:30:35 -04:00
parent 2379e7c3fc
commit 94c74b5c80
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/internal/discussion.md
View File

@@ -22,11 +22,11 @@ For debugging, it's often more convenient to have elasticsearch running in a ter
## Setting up the discussion service
First, make sure that you have access to the [github repository](https://github.com/rll/cs_comments_service). If this were not the case, send an email to dementrock@gmail.com.
You can retrieve the source code from the [github repository](https://github.com/edx/cs_comments_service).
First go into the mitx_all directory. Then type
First go into the edx_all directory. Then type
git clone git@github.com:rll/cs_comments_service.git
git clone https://github.com/edx/cs_comments_service.git
cd cs_comments_service/
If you see a prompt asking "Do you wish to trust this .rvmrc file?", type "y"
@@ -52,6 +52,13 @@ It's done! Launch the app now:
ruby app.rb
## Integrating with the edx platform
The API key must match on both sides. It is configured here:
* edx-platform: COMMENTS_SERVICE_KEY in your dev.py file (dev environment) or ENV_TOKENS (prod environment)
* cs_comments_service: api_key in the application.yml file (dev environment) or ENV variable (prod environment)
## Running the delayed job worker
In the discussion service, notifications are handled asynchronously using a third party gem called delayed_job. If you want to test this functionality, run the following command in a separate tab: