Skip to content

Commit 3b93c7f

Browse files
committed
fix links, tweaks
1 parent 21cebab commit 3b93c7f

File tree

3 files changed

+8
-9
lines changed

3 files changed

+8
-9
lines changed

contribute-docs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,9 @@ To learn more about the new docs UX, read [how to use the documentation](/get-st
2525

2626
|System|What it covers|Published at|Format|How to contribute
2727
|----|----|----|----|----|----|
28-
|Main docs|Guides, troubleshooting, release notes, etc.|[elastic.co/docs](https://www.elastic.co/docs)|Markdown|- [On the web](on-the-web.md) (quick edits) <br> - [Locally](locally.md) (complex changes) <br> - [Syntax guide](syntax/index.md)|
28+
|Main docs|Guides, troubleshooting, release notes, etc.|[elastic.co/docs](https://www.elastic.co/docs)|Markdown|- [On the web](on-the-web.md) (quick edits) <br> - [Locally](locally.md) (complex changes) <br> - [Syntax guide](syntax-quick-reference.md)|
2929
|API references|Elastic REST APIs|[elastic.co/docs/api](https://www.elastic.co/docs/api/)|[OpenAPI](https://swagger.io/specification/)|[Contribute to API docs](api-docs/index.md)|
3030

31-
:::{note}
32-
If you need to update documentation in both the MarkDown and Asciidoc systems, you'll need two separate PRs. Refer to [Updating docs in both systems](asciidoc-guide.md#updating-docs-in-both-systems).
33-
:::
34-
3531
## Report issues or request features
3632

3733
|Issue type|Where to report|
@@ -44,3 +40,7 @@ If you need to update documentation in both the MarkDown and Asciidoc systems, y
4440
|System|What it covers|Published at|Format/toolchain|How to contribute
4541
|----|----|----|----|----|----|
4642
|`elastic.co/guide` (Asciidoc)|Elastic docs & API references for 8.x and earlier|[elastic.co/guide](https://www.elastic.co/guide/index.html)|Asciidoc|[Contribute to the Asciidoc docs](./asciidoc-guide.md)|
43+
44+
:::{note}
45+
If you need to update documentation in both the MarkDown and Asciidoc systems, you'll need two separate PRs. Refer to [Updating docs in both systems](asciidoc-guide.md#updating-docs-in-both-systems).
46+
:::

contribute-docs/locally.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ git clone https://github.com/elastic/docs-content.git
104104

105105
## Write the docs [#write-docs]
106106

107-
We write docs in Markdown. Refer to our [syntax](syntax/index.md) guide for the flavor of Markdown we support and all of our custom directives that enable you to add a little extra pizzazz to your docs.
107+
We write docs in Markdown. Refer to our [syntax quick reference](syntax-quick-reference.md) for the flavor of Markdown we support and all of our custom directives that enable you to add a little extra pizzazz to your docs.
108108

109109
This documentation is **cumulative**. This means that a new set of docs is not published for every minor release. Instead, each page stays valid over time and incorporates version-specific changes directly within the content. [Learn how to write cumulative documentation](how-to/cumulative-docs/index.md).
110110

contribute-docs/syntax-quick-reference.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,11 @@ navigation_title: "Syntax quick reference"
66

77
Elastic documentation uses a custom implementation of [MyST Markdown](https://mystmd.org/) with extended syntax for directives, metadata, and tagging.
88

9-
:::{tip}
109
For the full syntax reference, go to [elastic.github.io/docs-builder/syntax/](https://elastic.github.io/docs-builder/syntax/).
11-
:::
10+
1211

1312
:::{tip}
14-
Contributing to `elastic.co/guide` (Asciidoc)? Refer to [Contribute to `elastic.co/guide` (Asciidoc)](asciidoc-guide.md).
13+
Contributing to `elastic.co/guide`? Refer to [Contribute to `elastic.co/guide` (Asciidoc)](asciidoc-guide.md).
1514
:::
1615

1716
This page offers quick guidance on commonly used syntax elements. Elements are in alphabetical order.

0 commit comments

Comments
 (0)