From 2f16fce28b50d3de8e6a2ce80f1aa31d387bfaf0 Mon Sep 17 00:00:00 2001 From: Janet Kuo Date: Tue, 20 Dec 2016 14:48:13 -0800 Subject: [PATCH] Add script for verifying docs without entry --- .travis.yml | 1 + skip_toc_check.txt | 3 +++ verify-entry-toc.sh | 20 ++++++++++++++++++++ 3 files changed, 24 insertions(+) create mode 100644 skip_toc_check.txt create mode 100755 verify-entry-toc.sh diff --git a/.travis.yml b/.travis.yml index 61caa32130..ba509e32d0 100644 --- a/.travis.yml +++ b/.travis.yml @@ -14,3 +14,4 @@ install: script: - go test -v k8s.io/kubernetes.github.io/test - $GOPATH/bin/md-check --root-dir=$HOME/gopath/src/k8s.io/kubernetes.github.io +- ./verify-entry-toc.sh diff --git a/skip_toc_check.txt b/skip_toc_check.txt new file mode 100644 index 0000000000..eabcf6e724 --- /dev/null +++ b/skip_toc_check.txt @@ -0,0 +1,3 @@ +# Put files you want to skip table of contents entry check here: +docs/search.md +docs/sitemap.md diff --git a/verify-entry-toc.sh b/verify-entry-toc.sh new file mode 100755 index 0000000000..95ab757cda --- /dev/null +++ b/verify-entry-toc.sh @@ -0,0 +1,20 @@ +#!/bin/bash + +no_entry=false + +# Verify all docs/.../*.md files are referenced in at least one of _data/*.yml +# files. Skip checking files in skip_toc_check.txt +for file in `find docs -name "*.md" -type f`; do + if ! grep -q "${file}" skip_toc_check.txt; then + path=${file%.*} + if ! grep -q "${path}" _data/*.yml; then + echo "Error: ${file} doesn't have an entry in the table of contents under _data/*.yml" + no_entry=true + fi + fi +done + +if ${no_entry}; then + echo "Found files without entries. For how to fix it, see http://kubernetes.io/docs/contribute/write-new-topic/#creating-an-entry-in-the-table-of-contents" + exit 1 +fi