Skip to content

docs: add LP-1148 ulmo.4+ upgrade plan and merge audit - #504

Closed
robrap wants to merge 1 commit into
release-ulmofrom
robrap/lp1148-plan-docs
Closed

robrap wants to merge 1 commit into
release-ulmofrom
robrap/lp1148-plan-docs

Conversation

@robrap

@robrap robrap commented Oct 6, 2026

Copy link
Copy Markdown

Ticket: LP-1148. Documentation only, with no code or settings changes.

What

Adds docs/plans/, a home for temporary plans for in-flight work, following the pattern in edx-internal#14972:

  • docs/plans/README.rst sets the lifecycle rule: a plan is deleted when the work it describes is done.
  • docs/plans/LP-1148-ulmo4-upgrade.md is the plan for landing the ulmo.4+ upgrade (Django 5.2) on release-ulmo: context, decisions, current state and next steps.
  • docs/plans/LP-1148-ulmo4-merge-audit.md is the merge audit of the upgrade branch robrap/lp1148-ulmo4-continue, with the scripts used so it can be re-run.

The plan is the single source of truth, so it isn't repeated here.

Review requests

  • The PDF textbook viewer choice. See the commit message of fc8f1f0a8c and the plan's "Open items for owning teams".
  • The forum bulk-delete permission. This upgrade doesn't change it, but it is flagged for the discussions owners.
  • Whether release-ulmo is the right place for temporary plan docs. They will be deleted once the upgrade is in production and stable.

Sphinx

The plans are Markdown, which the Sphinx build ignores (source_suffix is .rst only). The README is marked :orphan:, so it needs no toctree entry. RepositoryDocs skips docs/, so nothing is copied into the generated reference tree.

🤖 Generated with Claude Code

Adds docs/plans/, a home for temporary in-flight plans, with a README
setting the lifecycle rule (a plan is deleted when the work it describes
is done), and two LP-1148 documents:

- LP-1148-ulmo4-upgrade.md: context, decisions, current state of the
  upgrade branch robrap/lp1148-ulmo4-continue, and next steps.
- LP-1148-ulmo4-merge-audit.md: the merge audit of that branch, with the
  scripts used, so it can be re-run after re-syncing.

Plans are Markdown, which the Sphinx build ignores; the README is
:orphan: so it needs no toctree entry.

Co-Authored-By: Claude <noreply@anthropic.com>
@robrap

robrap commented Oct 6, 2026

Copy link
Copy Markdown
Author

Superseded by #505: the plan and merge audit now ship in the upgrade PR itself, under docs/plans/.

@robrap robrap closed this Oct 6, 2026
@robrap
robrap deleted the robrap/lp1148-plan-docs branch October 6, 2026 23:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant