Open edX Developer's Guide
1. General Information
1.1. Read Me
1.2. Other edX Resources
1.2.1. Resources for edx.org Learners
1.2.2. The edX Partner Portal
1.2.3. The Open edX Portal
1.2.4. System Status
1.2.5. Resources for edx.org Course Teams
1.2.6. Resources for Researchers
1.2.7. Resources for Developers
1.2.8. Resources for Open edX
1.3. edX Browser Support
2. Open edX Architecture
2.1. Overview
2.2. Key Components
2.2.1. Learning Management System (LMS)
2.2.2. Studio
2.2.3. Discussions
2.2.4. Mobile Apps
2.2.5. Analytics
2.2.6. Background Work
2.2.7. Search
2.2.8. Other Components
3. Contributing to Open edX
3.1. Process for Contributing Code
3.1.1. Overview
3.1.2. General Guidelines
3.1.3. Roles
3.2. Contributor
3.2.1. Once A PR is Open
3.2.2. Further Information
3.3. Pull Request Cover Letter
3.3.1. Example Of A Good PR Cover Letter
3.4. Community Manager
3.5. Product Owner
3.6. Core Committer
3.6.1. Review Comments Terminology
3.7. Code Considerations
3.7.1. Operational Impact
3.7.2. Documentation/Training/Support
3.7.3. Development
3.7.4. Testing
3.7.5. Analytics
3.7.6. Collaboration
3.7.7. Open Source
3.7.8. UX/Design/Front End Development
3.7.9. Contributing to the Documentation for Your Open Source Feature
4. Extending the edX Platform
4.1. Options for Extending the edX Platform
4.2. Integrating XBlocks with edx-platform
4.2.1. LMS
4.2.2. Studio
4.2.3. Deploying Your XBlock
4.2.4. Rendering XBlocks with the XBlock URL
4.3. Custom JavaScript Applications
4.3.1. Overview
4.3.2. Grading Options for Custom JavaScript Applications
4.3.3. Use a JavaScript Application Without Grading
4.3.4. Use a JavaScript Application for a Summative Assessment
4.3.5. Grade the Student Response with Python
4.3.6. XML for Custom JavaScript Applications
4.4. The Custom JavaScript Display and Grading Example Template
4.4.1. Example getState() Function
4.4.2. Example setState() Function
4.4.3. Example getGrade() function
4.4.4. Grade the Student Response
4.4.5. XML Problem Structure
5. edX Modulestores
5.1. Overview of the edX Modulestores
5.1.1. XMLModuleStore
5.1.2. DraftModuleStore
5.1.3. Split Mongo
5.2. MixedModuleStore
5.3. Split Mongo Modulestore
5.3.1. Overview
5.3.2. Split Mongo Data Model
5.3.3. Split Mongo Capabilities
6. Testing
6.1. Jenkins
6.1.1. Kicking Off Builds
6.1.2. Failed Builds
6.1.3. Successful Builds
6.2. Code Coverage
6.3. Code Quality
6.3.1. Clean Code
6.3.2. Safe Code
6.4. Testing Open edX Features
6.4.1. Tests for the Open edX Platform
7. Paver
7.1. Paver Commands
7.1.1. Prereqs
7.1.2. Docs
7.1.3. Assets
7.1.4. Run Servers
8. Development Environment
8.1. Setting up PyCharm to Debug E-Commerce
8.2. Running Celery on Devstack
8.2.1. Starting the Processes
9. Developing User Interfaces
9.1. Getting Started
9.1.1. Language style guidelines should be followed
9.1.2. Use server-side rendering whenever possible
9.1.3. Front-ends should be self-contained
9.1.4. Designs should be built upon common patterns
9.1.5. Front-ends should consume and extract reusable UI components
9.1.6. Features should work equally well on mobile and web platforms
9.1.7. Designs should be accessible to all users
9.1.8. User interfaces should support internationalization
9.1.9. Front end implementations should support theming
9.1.10. Front end code should be safe from cross site scripting
9.2. Front End Technologies
9.2.1. Server-side content should be rendered with Django Templates
9.2.2. JavaScript libraries should be installed via npm
9.2.3. Use React and Redux when building new client-side applications
9.2.4. JavaScript should be bundled using Webpack
9.2.5. JavaScript dependencies should be managed with ES2015 Modules
9.2.6. CSS should be generated using Sass
9.2.7. Legacy Technologies
9.3. Working with Bootstrap
9.3.1. Getting Started
9.3.2. Developing Custom Designs
10. Analytics
10.1. Event Tracking
10.1.1. Emitting Events
10.1.2. Documenting Events
10.1.3. Request Context Middleware
10.1.4. Legacy Application Event Processor
10.2. Other Tracking Systems
10.2.1. Data Dog
10.2.2. Segment
10.2.3. Google Analytics
10.2.4. Deprecated APIs
11. Deploy a New Service
11.1. Intro
11.2. Considerations
11.2.1. What Does Your Service Do
11.2.2. Sizing and Resource Profile
11.2.3. Customers
11.2.4. Code
11.2.5. Settings
11.2.6. License
11.2.7. How does your service run
11.2.8. Persistence
11.2.9. Logging
11.2.10. Metrics
11.2.11. Messaging
11.2.12. Email
11.2.13. Access to Other Service
11.2.14. Service Monitoring
11.2.15. Fault Tolerance and Scalability
11.2.16. Network Access
11.2.17. Data Security
11.2.18. Testing
11.2.19. Additional Requirements
12. Writing Good Code
12.1. edX Accessibility Guidelines
12.1.1. Introduction
12.1.2. Accessibility Best Practices
12.1.3. Use semantic markup
12.1.4. Make images accessible
12.1.5. Avoid using CSS to add content
12.1.6. Include a descriptive
title
attribute for all
<iframe>
elements
12.1.7. Include link and control labels that make sense out of context
12.1.8. Make sure form elements have labels
12.1.9. Use WAI-ARIA to create accessible widgets or enhance native elements
12.1.10. Manage the focus for pop-ups
12.1.11. Inform users when content changes dynamically
12.1.12. Hide or expose content to targeted audiences
12.1.13. Choose colors that meet WCAG 2.0’s minimum contrast ratios
12.1.14. Test your code for accessibility
12.2. Preventing Cross Site Scripting Vulnerabilities
12.2.1. Philosophy and General Rules
12.2.2. Types of Context and Escaping
12.2.3. Editing Template Files
12.2.4. Making Legacy Mako Templates Safe by Default
12.2.5. XSS Linter
12.2.6. Advanced Topics
12.2.7. Additional Resources
12.3. Django Good Practices
12.3.1. Imports
13. Writing Code for Internationalization
13.1. Internationalization Coding Guidelines
13.1.1. General Internationalization Rules
13.1.2. Editing Source Files
13.1.3. Coverage Testing
13.1.4. Style Guidelines
13.1.5. Additional Resources
13.2. Guidelines for Translating the Open edX Platform
13.2.1. Getting Started with Transifex
13.2.2. Guidelines for Translators
14. Language Style Guidelines
14.1. EdX JavaScript Style Guide
14.1.1. JavaScript Version
14.1.2. Code Style
14.1.3. Testing
14.1.4. Documentation
14.2. EdX Objective-C Style Guide
14.2.1. Principles
14.2.2. Syntax and Organization
14.2.3. Writing Tests
14.3. EdX Python Style Guide
14.3.1. Principles
14.3.2. Syntax and Organization
14.3.3. Pylint Guidelines and Practices
14.3.4. Docstrings
14.3.5. References
14.4. EdX Sass Style Guide
14.4.1. Code Style
14.4.2. Use Variables
15. Glossary
15.1. A
15.2. C
15.3. D
15.4. E
15.5. F
15.6. G
15.7. H
15.8. I
15.9. K
15.10. L
15.11. M
15.12. N
15.13. O
15.14. P
15.15. Q
15.16. R
15.17. S
15.18. T
15.19. U
15.20. V
15.21. W
15.22. XYZ
Open edX Developer's Guide
Table of Contents
»
14. Language Style Guidelines
Get Help
or
Give Doc Feedback
14. Language Style Guidelines
¶
14.1. EdX JavaScript Style Guide
14.2. EdX Objective-C Style Guide
14.3. EdX Python Style Guide
14.4. EdX Sass Style Guide