Update E-Commerce testing instructions #1417

gsong · 2017-02-16T21:00:54Z

Update the E-Commerce testing instructions to provide step-by-step detail.

Date Needed (optional)

There's no specific urgency around this.

Reviewers

Possible roles follow. The PR submitter checks the boxes after each reviewer finishes and gives 👍.

Subject matter expert: @clintonb
Doc team review (sanity check, copy edit, or dev edit?): @edx/doc

Testing

Ran ./run_tests.sh without warnings or errors

HTML Version (optional)

Build an RTD draft for your branch and add a link here

Post-review

Add a comment with the description of this change or link this PR to the next release notes task.
Squash commits

clintonb · 2017-02-16T21:07:28Z

@gsong have a chat with @davec-edx. He is also looking at docs.

srpearce · 2017-02-16T21:10:11Z

@gsong I should be able to review this tomorrow.

gsong · 2017-02-16T21:15:09Z

@clintonb Will do. These are changes based on our working session to hook up LMS and E-Commerce while I was in town.

@davec-edx Take a look if this is of interest to you.

@srpearce Thanks!

davec-edx · 2017-02-17T15:08:50Z

LGTM - thanks

srpearce

Light copy editing pass finished. Let me know if you have any questions.

srpearce · 2017-02-17T16:53:16Z

en_us/install_operations/source/ecommerce/test_ecommerce.rst


-#. Verify that the following settings in ``lms.auth.json`` are correct.
+#. Login into the VM.


Our convention is "Sign in to"

srpearce · 2017-02-17T16:55:44Z

en_us/install_operations/source/ecommerce/test_ecommerce.rst


-   .. code-block:: bash
+#. Start LMS.


Start the LMS.

srpearce · 2017-02-17T18:55:15Z

en_us/install_operations/source/ecommerce/test_ecommerce.rst


 Configure E-Commerce
 ********************

-You use the CAT to finish configuring the two courses in your LMS instance.
+You use the Course Administration Tool ("**CAT**") to finish configuring the


No bold or quotation marks

srpearce · 2017-02-17T18:55:19Z

en_us/install_operations/source/ecommerce/test_ecommerce.rst

-   .. code-block:: bash
+#. Navigate to the `Oauth2 Clients section`_ of `Django adminstration`_, at
+   http://localhost:8000/admin/oauth2/client/.  Login using th staff account
+   designated in step 5.


Since these links won't work for all readers (which could cause confusion), I wouldn't make them appear live. We don't do this elsewhere in the guide.

"of the Django administration console" (or "panel"—we're not very consistent about this)

Typo: th

Instead of referencing specific step numbers (which might change), say "the staff account that you have verified" or similar.

srpearce · 2017-02-17T18:56:00Z

en_us/install_operations/source/ecommerce/test_ecommerce.rst

-   Make note of this token; it is required to run the acceptance tests.
+#. Navigate to the `Edx\_Oauth2\_Provider Trusted clients section`_
+   of `Django administration`_, at
+   http://localhost:8000/admin/edx_oauth2_provider/trustedclient/.


Same comment here re: links.

srpearce · 2017-02-17T18:58:56Z

en_us/install_operations/source/ecommerce/test_ecommerce.rst

+   ``course-v1:edX+DemoX+Demo_Course``.
+
+#. Navigate to `E-Commerce Courses section`_ and add a new course. Leave
+   all fields at default, with the exception of the following.


Leave the default values in all fields

srpearce · 2017-02-17T18:59:04Z

en_us/install_operations/source/ecommerce/test_ecommerce.rst

+
+   ::
+
+       Course ID: The course key from LMS


srpearce · 2017-02-17T18:59:26Z

en_us/install_operations/source/ecommerce/test_ecommerce.rst

+       Course Type: Verified
+       Include Honor Seat: No
+
+#. Navigate to `LMS Dashboard`_ and verify the course you added in


Navigate to the learner dashboard

No link

srpearce · 2017-02-17T18:59:50Z

en_us/install_operations/source/ecommerce/test_ecommerce.rst

+   E-Commerce now has a green "Upgrade to Verified" badge, which you can
+   click on.
+
+#. In the CAT, add the second course present on your LMS instance to


Strike "present"

srpearce · 2017-02-17T19:00:04Z

en_us/install_operations/source/ecommerce/test_ecommerce.rst

+
+#. Navigate to `LMS Dashboard`_ and verify the course you added in
+   E-Commerce now has a green "Upgrade to Verified" badge, which you can
+   click on.


"click on" --> select

gsong · 2017-02-23T20:34:07Z

@srpearce I believe I addressed all your edit suggestions.

srpearce

A couple of nits.

srpearce · 2017-03-01T21:33:06Z

en_us/install_operations/source/ecommerce/test_ecommerce.rst

+       Course Type: Verified
+       Include Honor Seat: No
+
+#. Navigate to the learner Dashboard (e.g. http://localhost:8000/dashboard) and


Decap "Dashboard"

srpearce · 2017-03-01T21:33:23Z

en_us/install_operations/source/ecommerce/test_ecommerce.rst

-      Client ID: 'replace-me'
-      Client Secret: 'replace-me'
-      Client Type: Confidential
+#. Navigate to the Oauth2 Clients section of Django administration console


of the Django (here and line 211)

gsong · 2017-03-02T19:55:01Z

@srpearce Re:

Add a comment with the description of this change or link this PR to the next release notes task.

Do I need to do that?

srpearce · 2017-03-02T21:11:17Z

@gsong Do you want to announce this change in next week's release notes? (Are there any developers who will be particularly excited about it?)

gsong · 2017-03-02T22:56:50Z

@srpearce I think it's worthwhile if people ever want to get LMS and E-Commerce working together. It's certainly useful both for internal and open source developers.

srpearce · 2017-03-07T15:31:06Z

@gsong Meant to get back to this on Thursday. It sounds like this should be covered in release notes, in that case. I'm not sure what the process is these days, so I'd recommend contacting @marcotuts.

gsong force-pushed the george/test-ecommerce-update branch from ac4b0dc to 60dcc3e Compare February 16, 2017 21:09

srpearce reviewed Feb 17, 2017

View reviewed changes

gsong force-pushed the george/test-ecommerce-update branch 2 times, most recently from 6b02f57 to 353a319 Compare February 23, 2017 20:32

gsong force-pushed the george/test-ecommerce-update branch from 353a319 to fe600ed Compare February 28, 2017 18:54

srpearce approved these changes Mar 1, 2017

View reviewed changes

Update LMS setup instructions

234e788

gsong force-pushed the george/test-ecommerce-update branch from fe600ed to 234e788 Compare March 2, 2017 19:54

gsong merged commit f4d9111 into master Mar 2, 2017

gsong deleted the george/test-ecommerce-update branch March 2, 2017 20:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update E-Commerce testing instructions #1417

Update E-Commerce testing instructions #1417

gsong commented Feb 16, 2017 •

edited

clintonb commented Feb 16, 2017

srpearce commented Feb 16, 2017

gsong commented Feb 16, 2017

davec-edx commented Feb 17, 2017

srpearce left a comment

srpearce Feb 17, 2017

srpearce Feb 17, 2017

srpearce Feb 17, 2017 •

edited

srpearce Feb 17, 2017

srpearce Feb 17, 2017

srpearce Feb 17, 2017

srpearce Feb 17, 2017

srpearce Feb 17, 2017 •

edited

srpearce Feb 17, 2017

srpearce Feb 17, 2017

gsong commented Feb 23, 2017

srpearce left a comment

srpearce Mar 1, 2017

srpearce Mar 1, 2017

gsong commented Mar 2, 2017

srpearce commented Mar 2, 2017

gsong commented Mar 2, 2017

srpearce commented Mar 7, 2017


		#. Verify that the following settings in ``lms.auth.json`` are correct.
		#. Login into the VM.

Update E-Commerce testing instructions #1417

Update E-Commerce testing instructions #1417

Conversation

gsong commented Feb 16, 2017 • edited

Date Needed (optional)

Reviewers

Testing

HTML Version (optional)

Post-review

clintonb commented Feb 16, 2017

srpearce commented Feb 16, 2017

gsong commented Feb 16, 2017

davec-edx commented Feb 17, 2017

srpearce left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

srpearce Feb 17, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

srpearce Feb 17, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gsong commented Feb 23, 2017

srpearce left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gsong commented Mar 2, 2017

srpearce commented Mar 2, 2017

gsong commented Mar 2, 2017

srpearce commented Mar 7, 2017

gsong commented Feb 16, 2017 •

edited

srpearce Feb 17, 2017 •

edited

srpearce Feb 17, 2017 •

edited