diff --git a/README.rst b/README.rst index 56f96938..84787bca 100644 --- a/README.rst +++ b/README.rst @@ -42,7 +42,7 @@ To check what the current value of `MFE_HOST` is actually set to, run:: Authn ~~~~~ -.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/authn.png +.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/media/authn.png :alt: Authn MFE screenshot This is a micro-frontend application responsible for the login, registration and password reset functionality. @@ -50,7 +50,7 @@ This is a micro-frontend application responsible for the login, registration and Account ~~~~~~~ -.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/account.png +.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/media/account.png :alt: Account MFE screenshot An MFE to manage account-specific information for every LMS user. Each user's account page is available at ``http(s)://{{ MFE_HOST }}/account``. For instance, when running locally: https://apps.local.edly.io/account. @@ -58,7 +58,7 @@ An MFE to manage account-specific information for every LMS user. Each user's ac Communications ~~~~~~~~~~~~~~ -.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/communications.png +.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/media/communications.png :alt: Communications MFE screenshot The Communications micro-frontend exposes an interface for course teams to communicate with learners. It achieves this by allowing instructors to send out emails in bulk, either by scheduling them or on demand. @@ -66,7 +66,7 @@ The Communications micro-frontend exposes an interface for course teams to commu Course Authoring ~~~~~~~~~~~~~~~~ -.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/course-authoring.png +.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/media/course-authoring.png :alt: Course Authoring MFE screenshot This MFE is meant for course authors and maintainers. For a given course, it exposes a "Pages & Resources" menu in Studio where one can enable or disable a variety of features, including, for example, the Wiki and Discussions. Optionally, it allows authors to replace the legacy HTML, Video, and Problem authoring tools with experimental React-based versions, as well as exposing a new proctoring interface that can be enabled if the `edx-exams `_ service is available. @@ -74,7 +74,7 @@ This MFE is meant for course authors and maintainers. For a given course, it exp Discussions ~~~~~~~~~~~ -.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/discussions.png +.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/media/discussions.png :alt: Discussions MFE screenshot The Discussions MFE updates the previous discussions UI with a new look and better features. @@ -82,7 +82,7 @@ The Discussions MFE updates the previous discussions UI with a new look and bett Gradebook ~~~~~~~~~ -.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/gradebook.png +.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/media/gradebook.png :alt: Gradebook MFE screenshot This instructor-only MFE is for viewing individual and aggregated grade results for a course. To access this MFE, go to a course → Instructor tab → Student Admin → View gradebook. The URL should be: ``http(s)://{{ MFE_HOST }}/gradebook/{{ course ID }}``. When running locally, the gradebook of the demo course is available at: http://apps.local.edly.io/gradebook/course-v1:edX+DemoX+Demo_Course @@ -90,7 +90,7 @@ This instructor-only MFE is for viewing individual and aggregated grade results Learner Dashboard ~~~~~~~~~~~~~~~~~ -.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/learner-dashboard.png +.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/media/learner-dashboard.png :alt: Learner Dashboard MFE screenshot The Learner Dashboard MFE provides a clean and functional interface to allow learners to view all of their open enrollments, as well as take relevant actions on those enrollments. @@ -98,7 +98,7 @@ The Learner Dashboard MFE provides a clean and functional interface to allow lea Learning ~~~~~~~~ -.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/learning.png +.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/media/learning.png :alt: Learning MFE screenshot The Learning MFE replaces the former courseware, which is the core part of the LMS where students follow courses. @@ -106,7 +106,7 @@ The Learning MFE replaces the former courseware, which is the core part of the L ORA Grading ~~~~~~~~~~~ -.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/ora-grading.png +.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/media/ora-grading.png :alt: ORA Grading MFE screenshot When enabled, Open Response Assessments ("ORA") that have a staff grading step will link to this new MFE, either when clicking "Grade Available Responses" from the exercise itself, or via a link in the Instructor Dashboard. It is meant to streamline the grading process with better previews of submitted content. @@ -114,7 +114,7 @@ When enabled, Open Response Assessments ("ORA") that have a staff grading step w Profile ~~~~~~~ -.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/profile.png +.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/media/profile.png :alt: Profile MFE screenshot Edit and display user-specific profile information. The profile page of every user is visible at ``http(s)://{{ MFE_HOST }}/profile/u/{{ username }}``. For instance, when running locally, the profile page of the "admin" user is: http://apps.local.edly.io/profile/u/admin. @@ -538,7 +538,7 @@ When there is a need to customize the ``@edx/frontend-component-header`` or ``@e 6. Install the customized header/footer components into your MFEs. This will resolve any npm dependency conflict issues. 7. All the steps outlined above need to be followed for the footer as well, if you have followed them for the header or vice versa. -.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/screenshots/npm-conflict-deps.png +.. image:: https://raw.githubusercontent.com/overhangio/tutor-mfe/master/media/npm-conflict-deps.png :alt: Observation of MFE header and footer versions From the above image, it can be observed that ``master`` branch of Learning MFE uses ``@edx/platform@5.6.1`` and Discussions MFE uses ``@edx/platform@7.1.0``. If customized header is created from ``master`` branch, it ensures compatibility with the Discussions MFE as header module supports ``@edx/platform@^7.0.0``. However, the customized header triggers npm dependencies conflit error for learning MFE. diff --git a/screenshots/account.png b/media/account.png similarity index 100% rename from screenshots/account.png rename to media/account.png diff --git a/screenshots/authn.png b/media/authn.png similarity index 100% rename from screenshots/authn.png rename to media/authn.png diff --git a/screenshots/communications.png b/media/communications.png similarity index 100% rename from screenshots/communications.png rename to media/communications.png diff --git a/screenshots/course-authoring.png b/media/course-authoring.png similarity index 100% rename from screenshots/course-authoring.png rename to media/course-authoring.png diff --git a/screenshots/discussions.png b/media/discussions.png similarity index 100% rename from screenshots/discussions.png rename to media/discussions.png diff --git a/screenshots/gradebook.png b/media/gradebook.png similarity index 100% rename from screenshots/gradebook.png rename to media/gradebook.png diff --git a/screenshots/learner-dashboard.png b/media/learner-dashboard.png similarity index 100% rename from screenshots/learner-dashboard.png rename to media/learner-dashboard.png diff --git a/screenshots/learning.png b/media/learning.png similarity index 100% rename from screenshots/learning.png rename to media/learning.png diff --git a/screenshots/npm-conflict-deps.png b/media/npm-conflict-deps.png similarity index 100% rename from screenshots/npm-conflict-deps.png rename to media/npm-conflict-deps.png diff --git a/screenshots/ora-grading.png b/media/ora-grading.png similarity index 100% rename from screenshots/ora-grading.png rename to media/ora-grading.png diff --git a/screenshots/profile.png b/media/profile.png similarity index 100% rename from screenshots/profile.png rename to media/profile.png