Andal.LND/edx-platform
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: updating some user retirement documents (#36649)

Browse Source 
* chore: updating some user retirement documents

* removing some Jenkins documentation which is specific to 2u's implementation, and links to the old org's wiki
* updating some markup that was preventing images from rendering. Tested locally with a docs  bill to make them render now.

FIXES: APER-3981

* chore: adding a filewith a revised image

*  another file with a revised image which didn't make it into the original commit
This commit is contained in:
Deborah Kaplan
2025-05-02 11:41:37 -04:00
committed by GitHub
parent 5b3caa93e2
commit ea98b2d65f
3 changed files with 18 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
scripts/user_retirement/docs/implementation_overview.rst
View File

@@ -49,27 +49,27 @@ possible states required by all members of the Open edX community.
This example state diagram outlines the pathways users follow throughout the
workflow:
.. digraph:: retirement_states_example
:align: center
.. graphviz::
digraph retirement_states_example {
ranksep = "0.3";
ranksep = "0.3";
node[fontname=Courier,fontsize=12,shape=box,group=main]
{ rank = same INIT[style=invis] PENDING }
INIT -> PENDING;
"..."[shape=none]
PENDING -> RETIRING_ENROLLMENTS -> ENROLLMENTS_COMPLETE -> RETIRING_FORUMS -> FORUMS_COMPLETE -> "..." -> COMPLETE;
node[fontname=Courier,fontsize=12,shape=box,group=main]
{ rank = same INIT[style=invis] PENDING }
INIT -> PENDING;
"..."[shape=none]
PENDING -> RETIRING_ENROLLMENTS -> ENROLLMENTS_COMPLETE -> RETIRING_FORUMS -> FORUMS_COMPLETE -> "..." -> COMPLETE;
node[group=""];
RETIRING_ENROLLMENTS -> ERRORED;
RETIRING_FORUMS -> ERRORED;
PENDING -> ABORTED;
node[group=""];
RETIRING_ENROLLMENTS -> ERRORED;
RETIRING_FORUMS -> ERRORED;
PENDING -> ABORTED;
subgraph cluster_terminal_states {
label = "Terminal States";
labelloc = b // put label at bottom
{rank = same ERRORED COMPLETE ABORTED}
}
subgraph cluster_terminal_states {
label = "Terminal States";
labelloc = b // put label at bottom
{rank = same ERRORED COMPLETE ABORTED}
}
}
Unless an error occurs internal to the user retirement tooling, a user's
retirement state should always land in one of the terminal states. At that