{"action":"created","issue":{"url":"https://api.github.com/repos/edx/edx-platform/issues/13215","repository_url":"https://api.github.com/repos/edx/edx-platform","labels_url":"https://api.github.com/repos/edx/edx-platform/issues/13215/labels{/name}","comments_url":"https://api.github.com/repos/edx/edx-platform/issues/13215/comments","events_url":"https://api.github.com/repos/edx/edx-platform/issues/13215/events","html_url":"https://github.com/edx/edx-platform/pull/13215","id":170520659,"number":13215,"title":"Add a help link to the LMS header - and configuration to select Open edX or edX partner doc","user":{"login":"pdesjardins","id":6510839,"avatar_url":"https://avatars.githubusercontent.com/u/6510839?v=3","gravatar_id":"","url":"https://api.github.com/users/pdesjardins","html_url":"https://github.com/pdesjardins","followers_url":"https://api.github.com/users/pdesjardins/followers","following_url":"https://api.github.com/users/pdesjardins/following{/other_user}","gists_url":"https://api.github.com/users/pdesjardins/gists{/gist_id}","starred_url":"https://api.github.com/users/pdesjardins/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pdesjardins/subscriptions","organizations_url":"https://api.github.com/users/pdesjardins/orgs","repos_url":"https://api.github.com/users/pdesjardins/repos","events_url":"https://api.github.com/users/pdesjardins/events{/privacy}","received_events_url":"https://api.github.com/users/pdesjardins/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":20,"created_at":"2016-08-10T21:15:12Z","updated_at":"2016-09-01T14:24:43Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/edx/edx-platform/pulls/13215","html_url":"https://github.com/edx/edx-platform/pull/13215","diff_url":"https://github.com/edx/edx-platform/pull/13215.diff","patch_url":"https://github.com/edx/edx-platform/pull/13215.patch"},"body":"## [DOC-2748](https://openedx.atlassian.net/browse/DOC-2748)\r\n\r\nThis PR adds a link to the LMS header that opens context-sensitive topics in the learner documentation. The label for the new link is \"help\" and it appears at the top of LMS pages. The mechanism is based on a similar function in Studio.\r\n\r\nWe added the base infrastructure for LMS online help in https://github.com/edx/edx-platform/pull/11703.\r\n\r\nBy default, the help links will lead to our Open edX learner documentation (http://edx.readthedocs.io/projects/open-edx-learner-guide/en/latest/). For edx.org, setting ``\"DOC_LINK_BASE_URL\": \"http://edx.readthedocs.io/projects/edx-guide-for-students\"`` in lms.env.json will switch the base URL so that the links lead to edX partner learner doc (http://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/).\r\n\r\nThis PR also adds matching configuration for Studio help links. By default, Studio links will lead to Open edX doc. Setting ``\"DOC_LINK_BASE_URL\": \"http://edx.readthedocs.org/projects/edx-partner-course-staff\"`` in cms.env.json will switch the links to edX partner documentation.\r\n\r\nThis changes the label of the link that opens the support modal on edx.org from \"help\" to \"feedback.\" @dhixonedx, please let me know if you prefer something else.\r\n\r\nWe need to make sure this will not affect white label sites. After discussion with @mattdrayer, I believe it will not, because those sites customize the lms/templates/navigation.html template.\r\n\r\n### Reviewers\r\nPossible roles follow. PR submitter checks the boxes after each reviewer finishes and gives :+1:. \r\n- [x] DevOps review: @fredsmith \r\n- [x] Development review: @sanfordstudent \r\n- [x] Doc team review (sanity check/copy edit/dev edit): @lamagnifica @catong @srpearce \r\n- [x] Product review: @sstack22 \r\n- [x] UX review: @alyssaboehm\r\n- [x] Accessibility review: @clrux \r\n- [ ] Support review: @dhixonedx \r\n\r\n \r\n### Sandbox (optional)\r\n- [x] https://pdesjardins.sandbox.edx.org\r\n\r\n### Post-review\r\n- [ ] Add description to release notes task as a comment\r\n- [ ] Squash commits"},"comment":{"url":"https://api.github.com/repos/edx/edx-platform/issues/comments/244095187","html_url":"https://github.com/edx/edx-platform/pull/13215#issuecomment-244095187","issue_url":"https://api.github.com/repos/edx/edx-platform/issues/13215","id":244095187,"user":{"login":"dhixonedx","id":16468180,"avatar_url":"https://avatars.githubusercontent.com/u/16468180?v=3","gravatar_id":"","url":"https://api.github.com/users/dhixonedx","html_url":"https://github.com/dhixonedx","followers_url":"https://api.github.com/users/dhixonedx/followers","following_url":"https://api.github.com/users/dhixonedx/following{/other_user}","gists_url":"https://api.github.com/users/dhixonedx/gists{/gist_id}","starred_url":"https://api.github.com/users/dhixonedx/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dhixonedx/subscriptions","organizations_url":"https://api.github.com/users/dhixonedx/orgs","repos_url":"https://api.github.com/users/dhixonedx/repos","events_url":"https://api.github.com/users/dhixonedx/events{/privacy}","received_events_url":"https://api.github.com/users/dhixonedx/received_events","type":"User","site_admin":false},"created_at":"2016-09-01T14:24:43Z","updated_at":"2016-09-01T14:24:43Z","body":"👍"}}
{"actor":{"display_login":"dhixonedx"}}