Skip to content

update discussion forum doc #1142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jzoldak merged 1 commit into from
Sep 27, 2013
Merged

update discussion forum doc #1142

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions docs/internal/discussion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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:
Expand Down