Skip to content

Commit dc7cbcd

Browse files
committed
add migration tooling docs
1 parent a8a0024 commit dc7cbcd

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/migration/guide/tooling.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,25 @@
22

33
Use the [adoc-to-md](https://github.com/elastic/adoc-to-md) conversion tool to migrate content sets from Asciidoc syntax to docs-builder syntax. Instructions to use the tool are in the readme file.
44

5+
6+
## Post-migration tooling
7+
8+
After migrating content from asciidoc to md, there is cleanup work to do. @colleen has created a script to handle this process for us. The script:
9+
10+
* Moves files to their new home in the new IA
11+
* Nests content at a pre-selected depth
12+
* shortens directory and file names
13+
* Adds frontmatter mapping files to their asciidoc equivalent
14+
15+
### File/Dir mappings
16+
17+
* [`shortened-slugs.js`](https://github.com/elastic/docs-helpers/blob/post-migration-sort/post-migration-sort/input/field-mapping/shortened-slugs.js)
18+
* [`word-replacement.js`](https://github.com/elastic/docs-helpers/blob/post-migration-sort/post-migration-sort/input/field-mapping/word-replacement.js)
19+
20+
## Post-migration manual work
21+
22+
* Being tracked in https://github.com/elastic/docs-builder/issues/261
23+
24+
## What's next?
25+
526
After running the migration tool, you can move and manipulate files while viewing a live preview of the content with docs-builder.

0 commit comments

Comments
 (0)