Page tree
Skip to end of metadata
Go to start of metadata

Table of Contents

Introduction

As part of the FedX Initiative, we intend to produce comprehensive documentation for front end developers. At a minimum this should cover the two front end projects (the edX Pattern Library and the edX UI Toolkit), but ideally it would also bring together all of the existing front end documentation, as well as filling in any gaps.

Initial Thoughts

Note: to be turned into a real plan!

Use Cases

  1. new edX developer wants to come up to speed on front end development at edX
  2. edX developer needs to add a new page to the LMS
    • What background/skill set do they have?
      • Have already gone through front end onboarding
    • What do they need to learn?
      • How to implement a design using the pattern library
      • How to add a new page to the LMS
      • How to write tests for it
      • Examples of good page implementations
    • What materials do we already have?
  3. edX developer needs to create a new IDA with edX branding
    • What background/skill set do they have?
      • Have already gone through front end onboarding
    • What do they need to learn?
      • How to create a new IDA that uses the Pattern Library and the UI Toolkit
      • How to set up unit and acceptance testing
    • What materials do we already have?
  4. edX designer needs to create a design for a new LMS page
    • What background/skill set do they have?
    • What do they need to learn?
    • What materials do we already have?
  5. edX developer needs to add a new pattern to the pattern library
  6. Open edX developer needs to create a new XBlock
    • What background/skill set do they have?
      • Some amount of front end development
      • May not have used Backbone/RequireJS etc
      • Are not familiar with edX solutions
    • What do they need to learn?
    • What materials do we already have?
  7. Open edX organization needs to create a custom themed version of the LMS
    1. What background/skill set do they have?
      • Some amount of front end development
      • May not have used Backbone/RequireJS etc
      • Are not familiar with edX solutions
    2. What do they need to learn?
    3. What materials do we already have?

Plan Overview

  • Update Developer Guide with new FED section
  • Update http://ux.edx.org to have a home page and more guidance
  • Technical edit and revision of ux.edx.org
  • Create a high level front end overview in the Developer Guide
    • Start out with links to pre-existing materials, but consolidate into the Guide over time
    • Document best practices and coding guidelines
    • Document new pattern lifecycle
    • Document static asset pipeline
  • Document the UI Toolkit at a high level in the developer guide
    • Components are documented in detail in the pattern library
    • Auto-generate UI Toolkit API documentation at http://ui-toolkit.edx.org 
  • Document how to set up a new IDA
  • No labels

1 Comment

  1. Let's also take some time to get the bigger picture by asking questions like, what kinds of problems do people have that they will be able to solve by using the FED tools? (3+ examples) what background and skill set can we assume that they have?