Published
Wiki source code of Convert the Distribution Wizard documentation into the documentation tree
Last modified by Eleni Cojocariu on 2026/08/17 15:39
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | Converts the legacy [[Distribution Wizard>>doc:Documentation.UserGuide.Features.DistributionWizard]] page into a new **documentation.xs.admin.distribution-wizard** topic, without duplicating the flavor-upgrade How-to that already exists in the tree. | ||
| 2 | |||
| 3 | = What this change request contains = | ||
| 4 | |||
| 5 | **Eight new pages**, one Diataxis type each: | ||
| 6 | |||
| 7 | * **Distribution Wizard** (Explanation, the topic page): what the wizard is, that it drives the Extension Manager, and a decision diagram of when it starts and which mode it runs in. | ||
| 8 | * **Distribution Wizard Steps** (Reference): every step, when it appears and what it does, plus the "Continue" / "Later" / "Never" / "Replay recorded actions" options. | ||
| 9 | * **Install the Flavor Using the Distribution Wizard** (How-to). | ||
| 10 | * **Repair the Previously Installed Flavor** (How-to). | ||
| 11 | * **Replay a Recorded Install or Upgrade** (How-to). | ||
| 12 | * **Distribution Wizard Configuration** (Reference): the six ##xwiki.properties## properties, the four ##extension.xed## keys and their precedence, and the Job REST API route. | ||
| 13 | * **Distribution Wizard Does Not Appear at Startup** (Explanation). | ||
| 14 | * **Rerun the Distribution Wizard on an Empty Instance** (How-to). | ||
| 15 | |||
| 16 | **The existing [[Upgrade the Standard Flavor of the Wiki Using the Distribution Wizard>>doc:documentation.xs.admin.upgrade.flavor.upgrade-distribution-wizard.WebHome]] stays where it is** and is completed instead of being duplicated: its Welcome-step options move to the new Steps Reference, its screenshot is re-captured at 960px so its ##size## becomes ##extra##, and the **Flavor step it never showed** is added, which is the step the page is named after. | ||
| 17 | |||
| 18 | **The legacy page is stripped** to a pointer, keeping every anchor still in use (##HCleanInstall##, ##HUserInterface##, ##HUpgrade##, ##HUpgradewithRepair##, ##troubleshooting##) as explicit ~{~{id}} macros, since four of them were generated from headings this change removes. Its ten backlinks in the new tree are repointed, along with the FAQ entry that answered by linking into it. | ||
| 19 | |||
| 20 | = Corrections to the legacy content = | ||
| 21 | |||
| 22 | Established from the ##xwiki-platform## sources and reproduced on live 18.6.0 instances, not carried over from the legacy prose: | ||
| 23 | |||
| 24 | * The distribution job status file is at ##<permanent directory>/jobs/status/3/distribution/status.xml.zip##. The legacy troubleshooting text omits the store-version folder. | ||
| 25 | * The "Admin user" step is skipped when you are already logged in with an administrator, and "Orphaned dependencies" when nothing is orphaned. | ||
| 26 | * The "Extensions" step only appears when an installed extension is **invalid**; merely outdated ones do not bring it back, contrary to "in the last step you can upgrade the extensions". | ||
| 27 | * The "Wikis" step never appears in flavor mode. | ||
| 28 | * "Welcome" and "Report" exist in interactive mode only. | ||
| 29 | |||
| 30 | Dropped as obsolete: the ##META-INF/maven/org.xwiki.enterprise/...## fallback, and every ##[since 5.3]##...##[since 11.10]## badge together with the ##{{version before="13.7RC1"}}## block, all far below the LTS. | ||
| 31 | |||
| 32 | = Notes for the reviewer = | ||
| 33 | |||
| 34 | * **24 screenshots** were captured on 18.6.0 instances at the exact ##size## width, each with the red box on the element the step names. | ||
| 35 | * The **Replay** How-to ends on the Replay Plan and describes the status screen in prose: a truthful status screenshot needs a replay against a namespace other than the one it was recorded on, which has not been produced. | ||
| 36 | * **Technical ID is empty** on all eight pages, and the topic page carries no link to an Extensions-wiki page: there is none for the Distribution Wizard, as for the neighbouring ##upgrade## and ##installation## topic pages. | ||
| 37 | * **Highlights are empty**: seven children is well under the threshold where they help. | ||
| 38 | * The navigation order of the new topic will be pinned after the merge. |
