Testing Studio Context-Sensitive Help
The Documentation team should be testing online help system throughout the development process. Whenever we make structural changes to the document "Building and Running and edX Course", we must test the online help using a draft RTD project built from our branch. We should not merge a PR until we have signed off that online help is working as expected.
In addition, both the Documentation team and the Manual Test team should test online help for each release candidate on staging.
If problems are found in a release candidate, contact the Documentation team. The solution is more likely to involve changes to documentation than to code.
The Documentation team must keep this page up-to-date as the UI and documentation changes, and as a versioned release strategy is implemented. (We will be updating to reflect additions of links to sidebar text, among other changes.)
For each production release, the Documentation team will test the help on stage. See the Release Notes Rotation.
Any issues found should be attached to the Documentation release notes story and resolved as an urgent priority.
Test the following pages.
| Studio Page | Test | Result of successful test opens these pages | Automation info |
|---|---|---|---|
| Welcome (not logged in) | Click Help | getting_started/index.html | .../cms/templates/howitworks.html |
| Sign Up | Click Help | getting_started/index.html | .../cms/templates/register.html |
| Sign In | Click Help | getting_started/index.html | .../cms/templates/login.html |
| Home > Courses (default) | Click Help | getting_started/index.html | .../cms/templates/index.html |
| Home > Courses | Click Getting Started with Studio in sidebar text | getting_started/index.html | .../cms/templates/index.html |
| In bottom panel ("Sock") click edX Documentation | http://docs.edx.org | An automated test already exists for the sock! .../cms/templates/sock.html | |
| Content > Outline | Click Help | developing_course/course_outline.html | .../cms/templates/course_outline.html |
| Content > Outline | Click Learn More in sidebar | developing_course/course_outline.html | .../cms/templates/course_outline.html |
| Unit page | Click Help | developing_course/course_units.html | .../cms/templates/container.html |
| Content > Updates | Click Help | course_assets/handouts_updates.html | .../cms/templates/course_info.html |
| Content > Pages | Click Help | course_assets/pages.html | .../cms/templates/edit-tabs.html |
| Content > Files & Uploads | Click Help | course_assets/course_files.html | .../cms/templates/asset_index.html |
| Files & Uploads | Click Learn More in sidebar text | course_assets/course_files.html | .../cms/templates/asset_index.html |
| Content > Textbooks | Click Help | course_assets/textbooks.html | .../cms/templates/textbooks.html |
| Textbooks | Click Learn More in sidebar text | course_assets/textbooks.html | .../cms/templates/textbooks.html |
Content > Video Uploads This menu item is not visible in all courses. Test this sample course: https://studio.stage.edx.org/course/edX/DemoX.1/2014 | Click Help | http://edx-partner-course-staff.readthedocs.org/en/latest/video/video_uploads.html | .../cms/templates/videos_index.html |
| Settings > Schedule & Details | Click Help | set_up_course/setting_up_student_view.html | .../cms/templates/settings.html |
| Settings > Grading | Click Help | grading/index.html | .../cms/templates/settings_graders.html |
| Settings > Course Team | Click Help | set_up_course/creating_new_course.html#add-course-team-members | .../cms/templates/manage_users.html |
| Settings > Group Configurations | Click Help | index.html | .../cms/templates/group_configurations.html |
| Group Configurations > Content Groups | Click Learn More in sidebar text in the Content Groups section | course_features/cohorts/cohorted_courseware.html | .../cms/templates/group_configurations.html |
Group Configurations or, test this sample course: https://studio.stage.edx.org/course/edX/DemoX.1/2014 | Click Learn More in sidebar text in the Experiment Group Configurations section | course_features/content_experiments/content_experiments_configure.html#set-up-group-configurations-in-edx-studio | .../cms/templates/group_configurations.html |
| Settings > Advanced Settings | Click Help | index.html | .../cms/templates/settings_advanced.html |
| Settings > Certificates | Click Help | set_up_course/creating_course_certificates.html | .../cms/templates/certificates.html |
| Settings > Certificates | Click Learn More in sidebar text | building_course/creating_course_certificates.html | .../cms/templates/certificates.html |
| Tools > Import | Click Help | releasing_course/export_import_course.html#import-a-course | .../cms/templates/import.html |
| Tools > Import | Click Learn More in sidebar text | releasing_course/export_import_course.html#import-a-course | .../cms/templates/import.html |
| Tools > Export | Click Help | releasing_course/export_import_course.html#export-a-course | .../cms/templates/export.html |
| Tools > Export | Click Learn More in sidebar text | releasing_course/export_import_course.html#export-a-course | .../cms/templates/export.html |
| Home > New Course | Click Help | 3 March 2016: Opened DOC-2754 to change this to set_up_course/creating_new_course.html | |
| Home > New Course | Click Getting Started in sidebar text | getting_started/index.html | |
| Home > New Library | Click Help | 3 March 2016: Opened DOC-2754 to change this to course_components/libraries.html#create-a-new-library 24 May 2016: The current link is http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/getting_started/get_started.html | |
| Home > New Library | Click Getting Started in sidebar text | getting_started/index.html | |
| Home > New Program | Click Help | index.html | |
| Home > Libraries (Library list page) | Click Help | 3 March 2016: Opened DOC-2754 to change this to course_components/libraries.html | |
| Content Library page (click a library on the Library list page) | Click Help | course_components/libraries.html | .../cms/templates/library.html |
| Content Library Page | Click Learn More about Content Libraries in sidebar text. | .../cms/templates/library.html | |
| Library: Settings > User Access | Click Help | creating_content/libraries.html#give-other-users-access-to-your-library | .../cms/templates/manage_users_lib.html |
| Library: Tools > Import | Click Help | creating_content/libraries.html#import-a-library | .../cms/templates/import.html |
| Library: Tools > Import | Click Learn More in sidebar text | creating_content/libraries.html#import-a-library | .../cms/templates/import.html |
| Library: Tools > Export | Click Help | creating_content/libraries.html#export-a-library | .../cms/templates/export.html |
| Library: Tools > Export | Click Learn More in sidebar text | creating_content/libraries.html#export-a-library | .../cms/templates/export.html |
| In LMS: Instructor Dashboard, Cohorts tab | Select Enable Cohorts checkbox. In the cohort, you see the UI text "Learners are added to this cohort only when..." followed by "What does this mean" link. | course_features/cohorts/cohort_config.html#assign-learners-to-cohorts-manually | .../lms/templates/instructor/instructor_dashboard_2/cohort-group-header.underscore |
| In LMS: Instructor Dashboard, Cohorts tab | Select Enable Cohorts checkbox. In the cohort, you see the UI text "Learners are added to this cohort automatically" followed by "What does this mean" link. | course_features/cohorts/cohorts_overview.html#all-automated-assignment | .../lms/templates/instructor/instructor_dashboard_2/cohort-group-header.underscore |
Notes (4 May 2016)
- .../cms/templates/course-create-rerun.html sets the online-help-token to course_rerun, but there is no token of that name defined in config.ini
- not sure how to interpret what the online-help-token setting is doing in .../cms/templates/base.html
- I suspect that the five new course/library/program pages all use .../cms/templates/index.html but I'm not sure (Ben Patterson (Deactivated) if you were to help me create one PoC test, doing it on .../cms/templates/index.html might instantly be a big win! From 2 to potentially 7 of our manual tests would become unnecessary...)