openedx / openedx/openedx-aspects

Add documentation around the Altinity operator

Open
#233 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Makefile
Stars
8
Forks
12
Avg merge
16h 13m
Merged PRs (30d)
4

Description

We're running into a few places where we need specific configuration options in the Altinity operator to make it behave the way things do in Altinity Cloud / CH Cloud. See here for more info:

https://github.com/openedx/tutor-contrib-aspects/pull/767

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 by reading the linked tutor-contrib-aspects pull request 767 and compare its discussion with the current openedx-aspects documentation. Identify the Altinity operator configuration options needed to match Altinity Cloud or CH Cloud behavior, then document those options and verify the requested behavior is covered.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.