Skip to content
代码片段 群组 项目
未验证 提交 ab9eb597 编辑于 作者: Evan Read's avatar Evan Read 提交者: GitLab
浏览文件

Add to documentation style guide

- Guidance for handling offerings in REST API docs.
- Require periods on full sentences in tables.
上级 ba98ffa0
No related branches found
No related tags found
无相关合并请求
......@@ -31,9 +31,11 @@ In the Markdown doc for a resource (AKA endpoint):
- Every method must have a cURL example.
- Every method must have a detailed [description of the response body](#response-body-description).
- Every method must have a response body example (in JSON format).
- If an attribute is available only to higher level tiers than the other
attributes, add the appropriate tier to the description. If an attribute is
- If an attribute is available only to higher level subscription tiers, add the appropriate tier to the **Description**. If an attribute is
for Premium, include that it's also available for Ultimate.
- If an attribute is available only in certain offerings, add the offerings to the **Description**. If the attribute's
description also has both offering and tier, combine them. For
example: _Self-managed, Premium and Ultimate only._
After a new API documentation page is added, [add an entry in the global navigation](site_architecture/global_nav.md#add-a-navigation-entry). [Example](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests/3497).
......
......@@ -399,7 +399,7 @@ Follow these guidelines for punctuation.
<!-- vale gitlab.Repetition = NO -->
- End full sentences with a period.
- End full sentences with a period, including full sentences in tables.
- Use serial (Oxford) commas before the final **and** or **or** in a list of three or more items. (Tested in [`OxfordComma.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/OxfordComma.yml).)
<!-- vale gitlab.Repetition = YES -->
......
0% 加载中 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册