Skip to content

Commit e65b01c

Browse files
authored
API reference: use /api as path and config as redirect (#5272)
1 parent a34da4d commit e65b01c

File tree

4 files changed

+11
-17
lines changed

4 files changed

+11
-17
lines changed

.htmltest.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ IgnoreDirs:
1212
- zh/docs/contributing/pr-checks
1313
IgnoreInternalURLs: # list of paths
1414
IgnoreURLs: # list of regexs of paths or URLs to be ignored
15+
- ^/api$
1516
- ^((/..)?/docs/languages/\w+|\.\.)/(api|examples|registry)/$
1617
- ^(/..)?/docs/collector/registry/$
1718
- ^(/..)?/docs/languages/net/(metrics-api|traces-api)/

content/en/api-docs.md

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

content/en/api.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: API references
3+
linkTitle: API
4+
redirect: /docs/languages/#api-references
5+
manualLinkTarget: _blank
6+
_build: { render: link }
7+
aliases: [api-docs]
8+
---

content/en/docs/languages/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ references are available:
4848

4949
{{% apidocs %}}
5050

51-
{{% alert title="Tip" color="info" %}}
51+
{{% alert title="Note" color="info" %}}
5252

53-
You can find a list of available API references at </api-docs>.
53+
The list above is aliased to [`/api`](/api).
5454

5555
{{% /alert %}}
5656

0 commit comments

Comments
 (0)