Skip to content

Commit a9425a9

Browse files
authored
Add content for bug bash tomorrow (#203)
1 parent 2254d10 commit a9425a9

File tree

2 files changed

+50
-1
lines changed

2 files changed

+50
-1
lines changed

docs/source/contribute/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Whether you're a technical writer or you've only edited Elastic docs once or twi
1111

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

1516
## Report a bug
1617

docs/source/migration/guide/index.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,52 @@ How to migrate content from Asciidoc to V3.
88

99
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.
1010

11-
After running the migration tool, you can move, and manipulate files while viewing a live preview of the content with docs-builder.
11+
After running the migration tool, you can move and manipulate files while viewing a live preview of the content with docs-builder.
12+
13+
## Building migrated content sets for the bug bash
14+
15+
Assuming the following directory structure:
16+
17+
```markdown
18+
{GitHub_Repo_Dir}/
19+
├── tools/
20+
│ ├── docs-builder-mac-arm64.zip
21+
│ └── docs-builder
22+
├── elasticsearch.md
23+
├── observability-docs.md
24+
└── kibana.md
25+
```
26+
27+
You can build migrated content sets on a Mac by running the following commands.
28+
29+
```{tip}
30+
For other systems, see [Contribute locally](../../contribute/locally.md)
31+
```
32+
33+
```bash
34+
# move to GitHub dir
35+
cd {GitHub_Repo_Dir}
36+
37+
# clone req'd repos
38+
git clone https://github.com/elastic/elasticsearch.md.git
39+
git clone https://github.com/elastic/observability-docs.md.git
40+
git clone https://github.com/elastic/kibana.md.git
41+
42+
# move back to GitHub dir
43+
cd {GitHub_Repo_Dir}
44+
mkdir tools
45+
cd tools
46+
47+
# mac-specific
48+
curl -LO https://github.com/elastic/docs-builder/releases/latest/download/docs-builder-mac-arm64.zip
49+
unzip docs-builder-mac-arm64.zip
50+
51+
# Build ES Guide
52+
./docs-builder serve -p ../elasticsearch.md/docs
53+
54+
# Build Obs Guide
55+
./docs-builder serve -p ../observability-docs.md/docs
56+
57+
# Build Kib Guide
58+
./docs-builder serve -p ../kibana.md/docs
59+
```

0 commit comments

Comments
 (0)