Skip to content

DOC-516 | Extend new toolchain README #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
155 changes: 0 additions & 155 deletions BUILD.md

This file was deleted.

42 changes: 42 additions & 0 deletions MIGRATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Migration to Hugo docs toolchain

The migration script converts the Jekyll-specific Markdown files as well as
the DocuBlocks from the main repository to the Hugo-specific Markdown files
that are needed for the new documentation toolchain.

## Prerequisites

- **docker-compose**
- **Python 3**

## How to run the migration script

Create a dedicated folder for testing the migration process.

**Setup**

```shell
.> git clone [email protected]:arangodb/docs-hugo.git
.> cd docs-hugo
docs-hugo> cd migration-tools
docs-hugo/migration-tools> pip3 install pyyaml commonmark python-frontmatter
```

**Execute migration**

```shell
docs-hugo/migration-tools> ./migration.sh migrate <docsOld> <docsNew> <docublocks> <version>
```

- `docsOld`: input path to the old toolchain and content in Jekyll's format,
pointing to the root of the `arangodb/docs` working copy

- `docsNew`: output path for the new toolchain and content in Hugo's format,
pointing to the root of the `arangodb/docs-hugo` working copy
(not including `/site/content`)

- `docublocks`: input path to a working copy of the `arangodb/arangodb`
repository, needed to read the old DocuBlocks

- `version`: the version of the old content to migrate to the new toolchain,
indicating a version folder like `3.11`
Loading