openedx / openedx/docs.openedx.org

Omnibus: Check that Operator & Developer notes have this content once everything is migrated

Open
#160 0 comments 0 reactions 1 assignee View on GitHub

@jmakowski1123 is already working on this.

Since Oct 14, 2022.

developers operators
Dominant language
JavaScript
Stars
35
Forks
95
Avg merge
5d 15h
Merged PRs (30d)
3

Description

Developer

Quickstart

  • xBlock development tutorial

  • Django plugin app tutorial

  • MFE tutorial

  • IDA tutorial

How-tos

  • How to manage, organize, and test your plugin's dependencies from edx-platform

  • How to prepare my plugin/extension for the next open release

Concepts

  • Best practices for Open edX core and plugin development

  • Locators

  • MFEs

  • xBlock services

  • Using Open edX APIs with auth

  • How Open edX development is planned/managed/tracked using Confluence/JIRA

  • What do things like BD/DEPR/INCR/OSPR mean?

  • Understanding the AGPL license, and the implications for different types of extensions/integrations

Reference

  • Platform management commands

  • Settings reference

  • Features reference

  • xBlock API reference

  • Extension point reference (like events/filters)

Site Operator

How-tos

  • Add a course track to a course

Concepts

  • User management

  • Organizations, what are they and how do they work?

  • Course tracks

  • Course runs

References

  • Waffle switches

  • Django apps/models available in Django admin. (There are so many apps listed in the Django admin. What do they all do? Creating this reference could inspire a lot of ideas for more Concepts/How-Tos/Quickstarts.)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.