You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/references/version.md
+3-8Lines changed: 3 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,7 @@
1
1
---
2
2
title: Document version
3
3
---
4
-
5
-
### Introduction
6
-
7
-
Each `.chk`, `.yaml` or `.yml` files containing *CHKware* YAML-dsl is a spec. or specification file. Each of these file **MUST** contain a YAML node called *version:*. E.g:
4
+
Each `.chk`, `.yaml` or `.yml`[specification files](./console-command#specification-files) or spec contains *CHKware* YAML-dsl. Each of these file **MUST** contain a YAML node called *version:*. E.g:
8
5
9
6
```yml
10
7
version: default:http:0.7.2
@@ -15,11 +12,9 @@ The version string contains a document version. Document version show which vers
15
12
16
13
The `chk` tool will exit with an error when unsupported document version found.
17
14
18
-
It's encouraged for user to write document version on the very top of a spec. document, so that it's clearly visible. However it can be written as a top-level key on any place of the document.
19
-
20
-
Supported document version can be found on corresponding specification reference.
15
+
Although `version:` can be written as a top-level key on any place of the spec, it's encouraged to write `version:` on the very top, so that it's clearly visible.
21
16
22
-
### Format
17
+
##Document version format
23
18
24
19
This version string have 3 parts: `<plugin>:<module>:<number>`, e.g: `default:http:0.8.0`
0 commit comments