diff --git a/scripts/user_retirement/docs/driver_setup.rst b/scripts/user_retirement/docs/driver_setup.rst index c6d7b8e6f2..d699d73ae8 100644 --- a/scripts/user_retirement/docs/driver_setup.rst +++ b/scripts/user_retirement/docs/driver_setup.rst @@ -109,26 +109,5 @@ several INI files, each containing a single line in the form of ``USERNAME --username= -************************************************** -Using the Driver Scripts in an Automated Framework -************************************************** - -At edX, we call the user retirement scripts from -`Jenkins `_ jobs on one of our internal Jenkins -services. The user retirement driver scripts are intended to be agnostic -about which automation framework you use, but they were only fully tested -from Jenkins. - -For more information about how we execute these scripts at edX, see the -following wiki articles: - -* `User Retirement Jenkins Implementation `_ -* `How to: retirement Jenkins jobs development and testing `_ - -And check out the Groovy DSL files we use to seed these jobs: - -* `platform/jobs/RetirementJobs.groovy in edx/jenkins-job-dsl `_ -* `platform/jobs/RetirementJobEdxTriggers.groovy in edx/jenkins-job-dsl `_ - .. include:: ../../../../links/links.rst diff --git a/scripts/user_retirement/docs/implementation_overview.rst b/scripts/user_retirement/docs/implementation_overview.rst index 37a814c1d5..0f5e6ee85a 100644 --- a/scripts/user_retirement/docs/implementation_overview.rst +++ b/scripts/user_retirement/docs/implementation_overview.rst @@ -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 diff --git a/scripts/user_retirement/docs/special_cases.rst b/scripts/user_retirement/docs/special_cases.rst index bded2d76bc..9367aa8979 100644 --- a/scripts/user_retirement/docs/special_cases.rst +++ b/scripts/user_retirement/docs/special_cases.rst @@ -20,8 +20,6 @@ retirement errored during forums retirement, so we manually reset their state from ``ERRORED`` to ``ENROLLMENTS_COMPLETE``. .. graphviz:: - :align: center - digraph G { //rankdir=LR; // Rank Direction Left to Right ranksep = "0.3";