Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Feature

Requirements

Learning Site Selection Feature Configuration

Open edX app builds will be able to enable the learning site feature to:

  • Load the site selection screen on app launch

  • Show the learning site selection workflow from the app settings area

Info

This entire capability should be behind a feature flag / toggle.

Learning Site Selection Screen

Learners will see the site selection screen on app load when this feature is enabled and no learning site has been selected yet.

Can’t find your site - Help and Support

Link to page specifying how to find your learning site, with help / email link configured to open email in default email app for mobile OS with contact email linked.

Learning Site Directory - Configuration Load

For each learning site linked to an application, all necessary configuration should be retrieved (or already available in the mobile build.)

A directory of learning sites should be included in the application with all necessary configuration details for known learning sites enabled in that app.

As a nice to have, it would be nice to keep the latest version of this directory in a server (not just in the build of the app) so that the mobile application can receive updated information to account for configuration errors or updates from the latest directory, such as new sites.

A specific listing of which parameters will be necessary / enabled in the directory is still TBD.

…others TBD…

Directory Fields:

  • Learning Site Name

  • Learning Site URL

  • Learning Site OAuth Client id

  • Learning Site Logo - App

  • Learning Site Logo - Loading Page

  • Feature Configurations:

    • Courses

    • Programs

    • Discovery

    • Search

    • Edit Profile

    • Public catalog or gated by authorization (TBD)

  • Theme Details:
    Each color constant must be represented by a color for both light and dark themes.

    • Required colors:

    • Primary Color

    • Secondary Color

    • Background Color

    • Text Primary Color

    • Text Secondary Color

    • Text Dark Color

    • Button Background Color

    • Button Text Color

    • CardView Background Color

    • CardView Border

    • Nice to have colors:

    • Divider Color

    • Info Color

    • Warning Color

    • Error Color

    • Resources:

    • Logo - The image that is used on the login screen (w171:h48)

    • Header - An abstract image that is used for the background on Sign in and Sign up screens. (w750:h416)

  • Privacy policy URL

  • Terms of Use URL

  • Contact support email

  • Field Details moved to bottom of this Page.

    Private + Public Directory Listings

    We may want to account for sites that do not want to be listed in the search / discovery flow for this step. The only way to link your account to this type of learning site would be be via a deep link or some other kind of code entry?

    Learning Site - Cached Assets and Configuration

    When a learning site is selected, students should be taken to the main home page for their selected learning site.

    Application Navigation Changes

    As part of this change, we plan to separate profile details (who I am as a learner) with application settings (controls and configuration). The profile is elevated to being a main core navigation page along with Courses, Programs, Discovery, (plus Profile).

    The App Settings page in the top right will remain, but link to a full in-app page. The Learning Site selection setting will be shown at the top if this feature is enabled. (Additional notes for this in the next row.)

    App Settings - Learning Site Section

    When this feature is enabled, learners will be able to see the learning site they have enabled at the top of their app settings. Clicking on this row will take learners to the learning site switch screen.

    ...

    No notes included for this project.

    Workflow Documentation

    ...

    Directory Field Details

    Directory Fields:

    • Learning Site Name

    • Learning Site URL

    • Learning Site OAuth Client id

    • Learning Site Logo - App

    • Learning Site Logo - Loading Page

    • Feature Configurations:

      • Courses

      • Programs

      • Discovery

      • Search

      • Edit Profile

      • Public catalog or gated by authorization (TBD)

    • Theme Details:
      Each color constant must be represented by a color for both light and dark themes.

      • Required colors:

      • Primary Color

      • Secondary Color

      • Background Color

      • Text Primary Color

      • Text Secondary Color

      • Text Dark Color

      • Button Background Color

      • Button Text Color

      • CardView Background Color

      • CardView Border

      • Nice to have colors:

      • Divider Color

      • Info Color

      • Warning Color

      • Error Color

      • Resources:

      • Logo - The image that is used on the login screen (w171:h48)

      • Header - An abstract image that is used for the background on Sign in and Sign up screens. (w750:h416)

    • Privacy policy URL

    • Terms of Use URL

    • Contact support email

    • …others TBD…