Skip to content

Commit f2af906

Browse files
authored
Migration and Syntax docs updates (#416)
* various internal docs improvements * fix bug; add mv docs * more bugs * last bug
1 parent 19d7505 commit f2af906

27 files changed

+340
-528
lines changed

docs/contribute/move.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Move files and folders
2+
3+
When you move a source file or folder, you must also update all inbound and outbound links to reflect the new file location. `docs-builder` provides tooling to handle this step for you.
4+
5+
## `docs-builder mv`
6+
7+
Move a file or folder from one location to another and update all links in the documentation. For example:
8+
9+
```
10+
docs-builder mv ./old-location/ia.md ./new-location/ia.md
11+
```
12+
13+
:::{important}
14+
The `docset.yml` and `toc.yml` files are not automatically updated when using this tool. You must update these references manually.
15+
:::
16+
17+
## `docs-builder mv --help`
18+
19+
```
20+
Usage: mv [arguments...] [options...] [-h|--help] [--version]
21+
22+
Move a file or folder from one location to another and update all links in the documentation
23+
24+
Arguments:
25+
[0] <string?> The source file or folder path to move from
26+
[1] <string?> The target file or folder path to move to
27+
28+
Options:
29+
--dry-run <bool?> Dry run the move operation (Default: null)
30+
-p|--path <string?> Defaults to the`{pwd}` folder (Default: null)
31+
```

docs/docset.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ external_hosts:
1818
- google.com
1919
- checkvist.com
2020
- commonmark.org
21+
- github.io
2122
exclude:
2223
- '_*.md'
2324
subs:
@@ -30,6 +31,7 @@ toc:
3031
- file: index.md
3132
- file: locally.md
3233
- file: on-the-web.md
34+
- file: move.md
3335
- folder: migration
3436
children:
3537
- file: index.md
@@ -44,10 +46,9 @@ toc:
4446
- folder: guide
4547
children:
4648
- file: index.md
49+
- file: working-in-docs-content.md
4750
- file: automated.md
4851
- file: tooling.md
49-
- file: bug-bash.md
50-
- file: file-structure.md
5152
- file: mapping.md
5253
- folder: configure
5354
children:
@@ -68,8 +69,8 @@ toc:
6869
- folder: syntax
6970
children:
7071
- file: index.md
71-
- file: md-extensions.md
7272
- file: admonitions.md
73+
- file: applies.md
7374
- file: automated_settings.md
7475
- file: code.md
7576
- file: comments.md
@@ -82,7 +83,6 @@ toc:
8283
- file: line_breaks.md
8384
- file: links.md
8485
- file: passthrough.md
85-
- file: applies.md
8686
- file: sidebars.md
8787
- file: substitutions.md
8888
- file: sundries.md

docs/migration/engineering.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Reference docs guidelines
1+
# New reference guidelines
22

33
## Engineering ownership of reference documentation
44

docs/migration/guide/automated.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Migrate Automated Content to V3
1+
# Migrate automated docs
22

33
If you have automated documentation in Asciidoc (or any other format) that you need to migrate to Elastic docs V3, this guide walks you through the essentials. Elastic docs V3 (powered by `docs-builder`) allows engineering teams to keep code and reference docs closely integrated for easier updates and greater accuracy.
44

@@ -15,8 +15,8 @@ Once you have these files, follow the [Contribute Locally guide](../../contribut
1515

1616
Elastic docs V3 fully supports [CommonMark](https://commonmark.org/) Markdown syntax. In addition, we support:
1717

18-
* Custom directives — our main extension point over markdown (learn more [here](../../syntax/md-extensions.md#directives))
19-
* A few GitHub flavored markdown extensions (see the list [here](../../syntax/md-extensions.md#github-flavored-markdown))
18+
* Custom directives — our main extension point over markdown (learn more [here](../../syntax/index.md))
19+
* A few GitHub flavored markdown extensions (see the list [here](../../syntax/index.md))
2020

2121
In most cases, plain Markdown covers basic needs, and directives add extra functionality as needed.
2222

@@ -43,4 +43,4 @@ For more information, see [Navigation](../../configure/content-set/navigation.md
4343

4444
## Next steps
4545

46-
That’s all you need to get started migrating automated docs to V3. As you add more pages or custom features, refer to the linked resources for details on configuring your docset, refining navigation, and leveraging the full power of V3 directives.
46+
That’s all you need to get started migrating automated docs to V3. As you add more pages or custom features, refer to the linked resources for details on configuring your docset, refining navigation, and leveraging the full power of V3 directives.

docs/migration/guide/bug-bash.md

Lines changed: 0 additions & 58 deletions
This file was deleted.

docs/migration/guide/file-structure.md

Lines changed: 0 additions & 59 deletions
This file was deleted.

docs/migration/guide/index.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# Migration Guide
22

3-
Migrate content from Asciidoc to V3
3+
How do I migrate content? How do I work with migrated content? What's actually moving?
44

5-
* [Migrate automated documentation](./automated.md) — for developers
6-
* [Migrate narrative content manually](./tooling.md) — handled by the docs team
7-
* [Build pre-migrated content sets](./bug-bash.md) — for the docs team bug bash
5+
_For writers_ --> [**How to work in `elastic/docs-content`**](./working-in-docs-content.md)
6+
7+
_For developers_ --> [**How to migrate automated documentation**](./automated.md)
8+
9+
_For the migration team_ --> [**How to migrate narrative content**](./tooling.md)
10+
11+
_For the generally curious_ --> [**What books were migrated?**](./mapping.md)

0 commit comments

Comments
 (0)