Skip to content

Commit e0c70bd

Browse files
committed
further improvements
1 parent 5b03b2c commit e0c70bd

File tree

4 files changed

+10
-13
lines changed

4 files changed

+10
-13
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,4 @@ ClickHouse/
6262
# Ignore table of contents files
6363
docs/cloud/reference/release-notes-index.md
6464
docs/whats-new/changelog/index.md
65+
docs/cloud/manage/api/api-reference-index.md

contribute/style-guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# ClickHouse docs style guide
22

3-
In this document, you will find a number of style guidelines for writing documentation.
4-
The rules in this guide are intended to assist in helping us to create a high
5-
quality documentation offering on par with the quality of ClickHouse itself.
3+
In this document, you will find a number of style guidelines for writing ClickHouse
4+
documentation. As documentation is a collective effort, these guidelines are
5+
intended to help all of us ensure quality and consistency across our documentation.
66

77
## YAML front matter
88

9-
Begin every new markdown document with YAML front-matter:
9+
Begin every new Markdown document with YAML front-matter:
1010

1111
```markdown
1212
---

docs/cloud/manage/api/api-reference-index.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,7 @@ slug: /cloud/manage/api/
44
description: 'Landing page for Cloud API'
55
---
66

7-
| Page | Description |
8-
|----------------------------------------------------------------|----------------------------------|
9-
| [Invitations](/cloud/manage/api/invitations-api-reference) | API reference for invitations. |
10-
| [Keys](/cloud/manage/api/keys-api-reference) | API reference for keys. |
11-
| [Members](/cloud/manage/api/members-api-reference) | API reference for requests. |
12-
| [Organizations](/cloud/manage/api/organizations-api-reference) | API reference for organizations. |
13-
| [Services](/cloud/manage/api/services-api-reference) | API reference for services. |
14-
| [Usage cost](/cloud/manage/api/usageCost-api-reference) | API reference for services. |
7+
<!-- The table on this page is autogenerated by the script at https://github.com/ClickHouse/clickhouse-docs/blob/main/scripts/autogenerate-table-of-contents.sh
8+
if you've spotted an error or want to change something, please edit the YAML
9+
frontmatter of the files themselves.
10+
-->

docs/cloud/manage/api/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ This section contains reference documentation for Cloud API and contains the fol
1010
|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
1111
| [Overview](/cloud/manage/api/api-overview)| Provides an overview of rate limits, Terraform Provider, Swagger (OpenAPI) Endpoint and UI and available support. |
1212
| [Managing API Keys](/cloud/manage/openapi) | Learn more about Cloud's API utilizing OpenAPI that allows you to programmatically manage your account and aspects of your services. |
13-
| [API Reference](/cloud/manage/api) | API reference documentation. |
13+
| [API Reference](/cloud/manage/api) | API reference documentation. |

0 commit comments

Comments
 (0)