Skip to content

Commit 17a6c70

Browse files
author
Mak Ahmad
committed
updated guide based on comments
1 parent 27b5f90 commit 17a6c70

1 file changed

Lines changed: 7 additions & 11 deletions

File tree

aip/general/0008/aip.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ printed pages.
2222

2323
### File structure
2424

25-
AIPs **must** be written in Markdown, and **must** be named using their
26-
four-digit number (example: `0008.md`). AIPs that serve a specific scope
25+
AIPs **must** be written in Markdown, and **must** be placed in corresponding directory using their
26+
four-digit number (example: `0008/aip.md`). AIPs that serve a specific scope
2727
**must** be in the subdirectory for that scope.
2828

29-
AIPs **must** have appropriate front matter.
29+
AIPs **must** have appropriate front matter that lives in the `aip.yaml` file.
3030

3131
```yaml
3232
---
@@ -35,10 +35,6 @@ aip:
3535
state: reviewing
3636
created: 2019-05-28
3737
permalink: /8
38-
redirect_from:
39-
- /08
40-
- /008
41-
- /0008
4238
---
4339

4440
```
@@ -57,7 +53,7 @@ Front matter for AIPs **must** include:
5753
that scope. Required for AIPs with IDs >= 1000, prohibited otherwise.
5854
- The `permalink` key (required): This **must** be set to
5955
`/{aip.scope}/{aip.id}`. If there is no scope, use `/{aip.id}` instead.
60-
- The `redirect_from` key: This should include a list of any `/{aip.id}`
56+
- The `redirect_from` key: This should include a ist of any `/{aip.id}`
6157
permutations that a reader would be likely to enter, including:
6258
- `/{aip.id}` (for AIPs where the permalink includes the scope)
6359
- AIP IDs with zero-padding, for each level of zero-padding up to four digits
@@ -82,10 +78,10 @@ of the following after the guidance, in the following order:
8278
- "Changelog" is a bulleted list of changes made to the AIP since the first
8379
writing.
8480

85-
The guidance section **may** include subsections that elaborate further on
81+
The guidance section **should** include subsections that elaborate further on
8682
details. Subsections will automatically create an entry in the table of
8783
contents, and an anchor for citations.
88-
The guidance section **may** include abstract descriptions of structures and wherever possible these should use Typescript syntax. Typescript is easy to follow for anyone familiar with either dynamic languages (like JavaScript or Python) or static languages (like Java or C++). These descriptions are intended as pseudo-code and are not intended to represent the actual implementation of the API in a TypeScript library.
84+
The guidance section **may** include abstract descriptions of structures and wherever possible these should use TypeScript syntax. TypeScript is easy to follow for anyone familiar with either dynamic languages (like JavaScript or Python) or static languages (like Java or C++). These descriptions are intended as pseudo-code and are not intended to represent the actual implementation of the API in a TypeScript library.
8985

9086
Below is an example AIP shell that uses each major section:
9187

@@ -151,7 +147,7 @@ terms **must not** be used).
151147

152148
### Code examples
153149

154-
API design examples in AIPs **should** use both [OpenAPI]{} and [protocol buffers][]. Examples
150+
API design examples in AIPs **should** use both [OpenAPI]{} and [protocol buffers][] in tabs. Examples
155151
**should** cover only enough syntax to explain the concept. When using RPCs in
156152
examples, a `google.api.http` annotation **should** be included.
157153

0 commit comments

Comments
 (0)