openedx / openedx/docs.openedx.org

Add a diagaram and words about the core services for the Open edX platform

Open
#334 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Update https://docs.openedx.org/en/latest/developers/concepts/platform_overview.html to include a diagram of what we consider the core services and what we consider additional serivces.

  • Core Deployment - Core Product Offering - Bare Bones
  • Extended Deployment - Slightly bigger

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.

Research direction

Start with developers/concepts/platform_overview.html and review the existing platform overview. Define the requested Core Deployment and Extended Deployment categories, then add a diagram and explanatory words distinguishing core from additional services. Done means the page clearly presents both deployment levels and their service boundaries.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.