class LegacyDocMigrator extends java.lang.Object
Migrates gdoc-based user guides from the old style, in which the section numbers are included in the filenames, and the new style which uses a YAML-based TOC file to organise the sections. It doesn't do a perfect job but it does a lot of the hard work and you can fine tune the generated gdocs afterwards.
The migration will not only rename and restructure the gdoc files, but it will also generate a toc.yml file that reproduces the existing guide structure. Additional files include:
The names of the new sections are based on the old section names, so they may not be ideal. Also, the new style requires that every section has a unique name, although the documentation publishing will pick up and warn of duplicates.
Constructor and description |
---|
LegacyDocMigrator
(java.io.File guideSrcDir, java.lang.Object aliasMap) |
LegacyDocMigrator
(java.io.File guideSrcDir, java.io.File outDir, java.lang.Object aliasMap) |
Type Params | Return Type | Name and description |
---|---|---|
|
java.lang.Object |
migrate() |
Methods inherited from class | Name |
---|---|
class java.lang.Object |
java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |