Skip to content
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
1 change: 1 addition & 0 deletions docs/source/contribute/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Whether you're a technical writer or you've only edited Elastic docs once or twi

* Simple bugs and enhancements --> [Contribute on the web](on-the-web.md)
* Complex or multi-page updates --> [Contribute locally](locally.md)
* Test migrated content --> [Migration guide](../migration/guide/index.md)

## Report a bug

Expand Down
50 changes: 49 additions & 1 deletion docs/source/migration/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,52 @@ How to migrate content from Asciidoc to V3.

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.

After running the migration tool, you can move, and manipulate files while viewing a live preview of the content with docs-builder.
After running the migration tool, you can move and manipulate files while viewing a live preview of the content with docs-builder.

## Building migrated content sets for the bug bash

Assuming the following directory structure:

```markdown
{GitHub_Repo_Dir}/
├── tools/
│ ├── docs-builder-mac-arm64.zip
│ └── docs-builder
├── elasticsearch.md
├── observability-docs.md
└── kibana.md
```

You can build migrated content sets on a Mac by running the following commands.

```{tip}
For other systems, see [Contribute locally](../../contribute/locally.md)
```

```bash
# move to GitHub dir
cd {GitHub_Repo_Dir}

# clone req'd repos
git clone https://github.com/elastic/elasticsearch.md.git
git clone https://github.com/elastic/observability-docs.md.git
git clone https://github.com/elastic/kibana.md.git

# move back to GitHub dir
cd {GitHub_Repo_Dir}
mkdir tools
cd tools

# mac-specific
curl -LO https://github.com/elastic/docs-builder/releases/latest/download/docs-builder-mac-arm64.zip
unzip docs-builder-mac-arm64.zip

# Build ES Guide
./docs-builder serve -p ../elasticsearch.md/docs

# Build Obs Guide
./docs-builder serve -p ../observability-docs.md/docs

# Build Kib Guide
./docs-builder serve -p ../kibana.md/docs
```
Loading