-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migration and Syntax docs updates (#416)
* various internal docs improvements * fix bug; add mv docs * more bugs * last bug
- Loading branch information
1 parent
19d7505
commit f2af906
Showing
27 changed files
with
340 additions
and
528 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Move files and folders | ||
|
||
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. | ||
|
||
## `docs-builder mv` | ||
|
||
Move a file or folder from one location to another and update all links in the documentation. For example: | ||
|
||
``` | ||
docs-builder mv ./old-location/ia.md ./new-location/ia.md | ||
``` | ||
|
||
:::{important} | ||
The `docset.yml` and `toc.yml` files are not automatically updated when using this tool. You must update these references manually. | ||
::: | ||
|
||
## `docs-builder mv --help` | ||
|
||
``` | ||
Usage: mv [arguments...] [options...] [-h|--help] [--version] | ||
Move a file or folder from one location to another and update all links in the documentation | ||
Arguments: | ||
[0] <string?> The source file or folder path to move from | ||
[1] <string?> The target file or folder path to move to | ||
Options: | ||
--dry-run <bool?> Dry run the move operation (Default: null) | ||
-p|--path <string?> Defaults to the`{pwd}` folder (Default: null) | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Reference docs guidelines | ||
# New reference guidelines | ||
|
||
## Engineering ownership of reference documentation | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,11 @@ | ||
# Migration Guide | ||
|
||
Migrate content from Asciidoc to V3 | ||
How do I migrate content? How do I work with migrated content? What's actually moving? | ||
|
||
* [Migrate automated documentation](./automated.md) — for developers | ||
* [Migrate narrative content manually](./tooling.md) — handled by the docs team | ||
* [Build pre-migrated content sets](./bug-bash.md) — for the docs team bug bash | ||
_For writers_ --> [**How to work in `elastic/docs-content`**](./working-in-docs-content.md) | ||
|
||
_For developers_ --> [**How to migrate automated documentation**](./automated.md) | ||
|
||
_For the migration team_ --> [**How to migrate narrative content**](./tooling.md) | ||
|
||
_For the generally curious_ --> [**What books were migrated?**](./mapping.md) |
Oops, something went wrong.