File tree 3 files changed +1103
-223
lines changed
3 files changed +1103
-223
lines changed Load Diff This file was deleted.
Original file line number Diff line number Diff line change
1
+ # Migration to Hugo docs toolchain
2
+
3
+ The migration script converts the Jekyll-specific Markdown files as well as
4
+ the DocuBlocks from the main repository to the Hugo-specific Markdown files
5
+ that are needed for the new documentation toolchain.
6
+
7
+ ## Prerequisites
8
+
9
+ - ** docker-compose**
10
+ - ** Python 3**
11
+
12
+ ## How to run the migration script
13
+
14
+ Create a dedicated folder for testing the migration process.
15
+
16
+ ** Setup**
17
+
18
+ ``` shell
19
+ .
> git clone
[email protected] :arangodb/docs-hugo.git
20
+ .> cd docs-hugo
21
+ docs-hugo> cd migration-tools
22
+ docs-hugo/migration-tools> pip3 install pyyaml commonmark python-frontmatter
23
+ ```
24
+
25
+ ** Execute migration**
26
+
27
+ ``` shell
28
+ docs-hugo/migration-tools> ./migration.sh migrate < docsOld> < docsNew> < docublocks> < version>
29
+ ```
30
+
31
+ - ` docsOld ` : input path to the old toolchain and content in Jekyll's format,
32
+ pointing to the root of the ` arangodb/docs ` working copy
33
+
34
+ - ` docsNew ` : output path for the new toolchain and content in Hugo's format,
35
+ pointing to the root of the ` arangodb/docs-hugo ` working copy
36
+ (not including ` /site/content ` )
37
+
38
+ - ` docublocks ` : input path to a working copy of the ` arangodb/arangodb `
39
+ repository, needed to read the old DocuBlocks
40
+
41
+ - ` version ` : the version of the old content to migrate to the new toolchain,
42
+ indicating a version folder like ` 3.11 `
You can’t perform that action at this time.
0 commit comments