Merge pull request kubernetes#6510 from tengqm/frontmatter-workaround

tengqm · web-flow · commit a99a42fcd3e6 · 2017-12-01T11:22:06.000+08:00
Workaround for Jekyllr frontmatter
diff --git a/cn/docs/tutorials/stateful-application/web.yaml b/cn/docs/tutorials/stateful-application/web.yaml
@@ -1,4 +1,3 @@
----
 apiVersion: v1
 kind: Service
 metadata:
diff --git a/cn/docs/tutorials/stateful-application/webp.yaml b/cn/docs/tutorials/stateful-application/webp.yaml
@@ -1,4 +1,3 @@
----
 apiVersion: v1
 kind: Service
 metadata:
@@ -42,4 +41,4 @@ spec:
       accessModes: [ "ReadWriteOnce" ]
       resources:
         requests:
-          storage: 1Gi
+          storage: 1Gi
diff --git a/cn/docs/user-guide/multi-pod.yaml b/cn/docs/user-guide/multi-pod.yaml
@@ -1,4 +1,3 @@
----
 apiVersion: v1
 kind: Pod
 metadata:
diff --git a/docs/tasks/access-application-cluster/frontend.yaml b/docs/tasks/access-application-cluster/frontend.yaml
@@ -1,5 +1,5 @@
-kind: Service
 apiVersion: v1
+kind: Service
 metadata:
   name: frontend
 spec:
diff --git a/docs/tutorials/stateful-application/web.yaml b/docs/tutorials/stateful-application/web.yaml
@@ -1,4 +1,3 @@
----
 apiVersion: v1
 kind: Service
 metadata:
diff --git a/docs/tutorials/stateful-application/webp.yaml b/docs/tutorials/stateful-application/webp.yaml
@@ -1,4 +1,3 @@
----
 apiVersion: v1
 kind: Service
 metadata:
@@ -45,4 +44,4 @@ spec:
       accessModes: [ "ReadWriteOnce" ]
       resources:
         requests:
-          storage: 1Gi
+          storage: 1Gi
diff --git a/docs/tutorials/stateful-application/zookeeper.yaml b/docs/tutorials/stateful-application/zookeeper.yaml
@@ -1,4 +1,3 @@
----
 apiVersion: v1
 kind: Service
 metadata:
diff --git a/docs/user-guide/environment-guide/backend-rc.yaml b/docs/user-guide/environment-guide/backend-rc.yaml
@@ -1,4 +1,3 @@
----
 apiVersion: v1
 kind: ReplicationController
 metadata:
diff --git a/docs/user-guide/environment-guide/backend-srv.yaml b/docs/user-guide/environment-guide/backend-srv.yaml
@@ -1,4 +1,3 @@
----
 apiVersion: v1
 kind: Service
 metadata:
diff --git a/docs/user-guide/environment-guide/show-rc.yaml b/docs/user-guide/environment-guide/show-rc.yaml
@@ -1,4 +1,3 @@
----
 apiVersion: v1
 kind: ReplicationController
 metadata:
diff --git a/docs/user-guide/environment-guide/show-srv.yaml b/docs/user-guide/environment-guide/show-srv.yaml
@@ -1,4 +1,3 @@
----
 apiVersion: v1
 kind: Service
 metadata:
diff --git a/docs/user-guide/multi-pod.yaml b/docs/user-guide/multi-pod.yaml
@@ -1,4 +1,3 @@
----
 apiVersion: v1
 kind: Pod
 metadata:
diff --git a/test/examples_test.go b/test/examples_test.go
@@ -199,6 +199,10 @@ func walkConfigFiles(inDir string, fn func(name, path string, data [][]byte)) er
 			if err != nil {
 				return err
 			}
+			// workaround for Jekyllr limit
+			if bytes.HasPrefix(data, []byte("---\n")) {
+				return fmt.Errorf("YAML file cannot start with \"---\", please remove the first line")
+			}
 			name := strings.TrimSuffix(file, ext)
 
 			var docs [][]byte
@@ -217,7 +221,10 @@ func walkConfigFiles(inDir string, fn func(name, path string, data [][]byte)) er
 					if err != nil {
 						return fmt.Errorf("%s: %v", path, err)
 					}
-					docs = append(docs, out)
+					// deal with "empty" document (e.g. pure comments)
+					if string(out) != "null" {
+						docs = append(docs, out)
+					}
 				}
 			} else {
 				docs = append(docs, data)

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`----`
`2`	`1`	`apiVersion: v1`
`3`	`2`	`kind: Service`
`4`	`3`	`metadata:`