Migration progress
The numbers below are computed when this page is displayed, by querying the search index. Nothing is stored.
A legacy page counts as done when it carries the done tag. It counts as started when it holds a MigratedPageClass object listing its replacements but has not been tagged yet. It counts as unconvertable when it carries the unconvertable tag: its content is deprecated and has no place in the new documentation, so there is nothing to convert and nothing to map it to. Both tags take a page out of the Left column, which is the work that is still ahead.
Legacy Pages on the Main wiki (this wiki)
| Tree | Pages | Done | Unconvertable | In progress | Left | Page by page |
|---|---|---|---|---|---|---|
| Documentation.UserGuide | 44 | 35 | 2 | 1 | 7 | View detailed info |
| Documentation.AdminGuide | 65 | 30 | 2 | 3 | 33 | View detailed info |
| Documentation.DevGuide | 316 | 9 | 155 | 4 | 152 | View detailed info |
| Total | 425 | 74 | 159 | 8 | 192 |
Pages on extension.xwiki.org
An extension page needs no tag: its website field is filled when the page has been converted, and points at the extension's generated documentation listing (/bin/view/DocApp/Code/ExtensionLD?id=...).
Pages are not extensions, though. A page can carry an empty id, and the same id can be carried by several pages, so what a ratio can honestly be computed against is the number of distinct ids: that is the set of things there is to document. Both are counted below, the distinct ids by faceting the index on the id field.
The last row counts a different population, and one the three above miss entirely:
- a project page carries an ExtensionCode.ProjectClass object and no ExtensionClass one - it groups the modules of a single project under one page (for instance Extension.Documentation), so it is not an extension page and none of the rows above sees it;
- a pom page carries an ExtensionCode.ExtensionProxyClass object: its metadata is imported from a Maven repository rather than typed on the wiki, so its website comes from the pom.
The two sets overlap, so the row counts their union and not their sum.
| Scope | Number | Done | View detailed |
|---|---|---|---|
| All pages on extensions.xwiki.org | 979 | 81 | |
| Pages without id | 106 | 0 | View detailed |
| Pages with id | 873 | 81 | View detailed |
| Project page or pom page | 591 | 63 | View detailed |
Pages on rendering.xwiki.org
rendering.xwiki.org is a wiki of the same farm, so the same index answers for it. The number below is a number of pages: hidden pages and per-space preference pages are left out, and so are translations - the index holds one document per locale, which on this wiki is the difference between 119 documents and 66 pages (Main.WebHome alone is translated 19 times). No page there carries a done tag or a mapping object yet, so there is nothing to count as done.
| Scope | Number | View detailed |
|---|---|---|
| All pages on rendering.xwiki.org | 66 | View detailed |
| Main | 20 | View detailed |
FAQ Pages
A FAQ is a page of the FAQ space carrying a FAQCode.FAQClass object - the set its home page lists. Pages of that space without the object are not counted here.
| Scope | Number | View detailed |
|---|---|---|
| Pages carrying a FAQ object | 134 | View detailed |
The queries
They are in the source of this page. A few things they all depend on:
- Scope by wiki:. The index covers the whole farm, so an unscoped query also counts the cristal wiki, which has pages under the same space paths. That alone inflated the User Guide count from 44 to 54.
- Exclude hidden pages with hidden:false. They are technical pages, not documentation, and they are numerous: 12 in the User Guide, 39 in the Admin Guide, 126 in the Dev Guide. A query run through /rest/wikis/query excludes them for you, which makes the two disagree if only one of them says so.
- Match the extension id on property.ExtensionCode.ExtensionClass.id_string, not on property.ExtensionCode.ExtensionClass.id. The unsuffixed name is the analyzed text field, so *org.xwiki.platform* also matches an id that merely contains it: surli:org.xwiki.platform:xwiki-platform-store, someone's own copy of the Store module, counts as a platform extension for that query and not for id_string:org.xwiki.platform*. The string field is also the only one that can be faceted, which is how the distinct ids are counted.
- Count pages, not documents, with doclocale:"". The index holds one document per translation, so a wiki whose pages are translated counts high: wiki:rendering answers 119 for 66 pages. The three trees above and the extension pages have no translations, which is why the difference only shows on the rendering wiki.
- website:* is not an "is it set" test - it matches extension pages whose website is an empty string. Match ExtensionLD instead.
The metadata behind the numbers
- MigratedPageClass - one field, newPages: the references of the pages that replace this one, one per line. Set it on the legacy page while converting it.
- MigratedPageSheet - renders those references as a "this content has moved to ..." box on the legacy page, above its remaining content.
- The unconvertable tag, added when the page documents something deprecated: there is no place for that content in the new documentation, so the page is neither converted nor mapped, and it leaves the Left column without ever becoming done.
- The done tag, added when the content has been entirely moved. The index matches the whole tag value, not the words in it, so a tag such as done, reviewed does not count and a page tagged knowledge base is not found by knowledge. Case is the one thing that does not matter: Done counts.
