Skip to content
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.

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

Updated documentation to reflect edX changes #570

Merged
merged 1 commit into from
Jun 22, 2016

Conversation

gsidebo
Copy link
Contributor

@gsidebo gsidebo commented Jun 17, 2016

What are the relevant tickets?

Closes #450

What's this PR do?

Updates our README to reflect updated edX docs, the new auth process, and a couple other minor details

How should this be manually tested?

If you feel particularly enterprising, you can run through the entire README to confirm the accuracy of these instructions

@bdero bdero temporarily deployed to micromasters-ci-pr-570 June 17, 2016 20:24 Inactive
- **Redirect uris**: The URL where MicroMaster’s will be running, followed by "/complete/edxorg/".
If you're running it via Docker, run ``docker-machine ip`` from the host machine to get the
container IP. MicroMaster’s runs on port ``8079`` by default, so this value should be something
like ``http://192.168.99.100:8079/complete/edxorg/``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this IP is only correct if you're on a Mac and using docker-machine?

@aliceriot @noisecapella do you use localhost for the redirect uri?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I use http://localhost:8079/complete/edxorg/ for the redirect uri on micromasters.d.

@pdpinch
Copy link
Member

pdpinch commented Jun 19, 2016

A couple of questions. Only the first one needs to be answered in these docs, I think.

@bdero bdero temporarily deployed to micromasters-ci-pr-570 June 20, 2016 14:46 Inactive
@gsidebo gsidebo force-pushed the 450_update_edx_documentation branch from 929939b to 4527a3c Compare June 20, 2016 14:50
@bdero bdero temporarily deployed to micromasters-ci-pr-570 June 20, 2016 14:50 Inactive
@bdero bdero temporarily deployed to micromasters-ci-pr-570 June 20, 2016 14:51 Inactive
@gsidebo
Copy link
Contributor Author

gsidebo commented Jun 20, 2016

@pdpinch ready to review again. i shoe-horned in an addition to .gitignore. we never check in the release-notes-checklist file when we run a release

like ``http://192.168.99.100:8079/complete/edxorg/``
**Linux users:** the MicroMaster’s URL will be `localhost:8079`. **OSX users:** In a terminal window on the
host machine where the proper Docker environment has been set up (`eval "$(docker-machine env mm)"`), the
MicroMaster's IP can be found by running ``docker-machine ip`` from the host machine. MicroMaster’s runs on
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you need to specify the name of the machine, so it is docker-machine ip <machine_name>

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still do not see the <machine_name> (or whatever you want to use)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed again :)

@giocalitri giocalitri self-assigned this Jun 20, 2016
@bdero bdero temporarily deployed to micromasters-ci-pr-570 June 21, 2016 13:45 Inactive
@bdero bdero temporarily deployed to micromasters-ci-pr-570 June 21, 2016 15:02 Inactive
@giocalitri
Copy link
Contributor

👍

@gsidebo gsidebo force-pushed the 450_update_edx_documentation branch from e2268c3 to 97af64b Compare June 22, 2016 16:09
@bdero bdero temporarily deployed to micromasters-ci-pr-570 June 22, 2016 16:09 Inactive
@gsidebo gsidebo force-pushed the 450_update_edx_documentation branch from 97af64b to e3f9bc0 Compare June 22, 2016 16:11
@gsidebo gsidebo merged commit ca84e3f into master Jun 22, 2016
@gsidebo gsidebo deleted the 450_update_edx_documentation branch June 22, 2016 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants