diff --git a/.generated_files b/.generated_files index 74d5477ab1f4b..ac3b191ad4eee 100644 --- a/.generated_files +++ b/.generated_files @@ -27,4 +27,4 @@ path-prefix vendor/ path-prefix api/swagger-spec/ path-prefix pkg/generated/ -paths-from-repo .generated_docs +paths-from-repo docs/.generated_docs diff --git a/.generated_docs b/docs/.generated_docs similarity index 99% rename from .generated_docs rename to docs/.generated_docs index 2a84cbedb4ed7..7be6b168c6f7c 100644 --- a/.generated_docs +++ b/docs/.generated_docs @@ -1,4 +1,4 @@ -.generated_docs +docs/.generated_docs docs/admin/federation-apiserver.md docs/admin/federation-controller-manager.md docs/admin/kube-apiserver.md diff --git a/docs/OWNERS b/docs/OWNERS index 0f4d3337522ed..0f42f79ac8cb0 100644 --- a/docs/OWNERS +++ b/docs/OWNERS @@ -6,3 +6,4 @@ approvers: - brendandburns - smarterclayton - thockin + - pwittrock \ No newline at end of file diff --git a/hack/generate-docs.sh b/hack/generate-docs.sh index 1fdd8fa20a9cc..c2ba698115861 100755 --- a/hack/generate-docs.sh +++ b/hack/generate-docs.sh @@ -44,7 +44,7 @@ kube::util::gen-docs "${KUBE_TEMP}" kube::util::remove-gen-docs # copy fresh docs into the repo. -# the shopt is so that we get .generated_docs from the glob. +# the shopt is so that we get docs/.generated_docs from the glob. shopt -s dotglob cp -af "${KUBE_TEMP}"/* "${KUBE_ROOT}" shopt -u dotglob diff --git a/hack/lib/util.sh b/hack/lib/util.sh index 3702cec394051..dec32e8a215d5 100755 --- a/hack/lib/util.sh +++ b/hack/lib/util.sh @@ -228,14 +228,14 @@ kube::util::gen-docs() { # create the list of generated files pushd "${dest}" > /dev/null - touch .generated_docs - find . -type f | cut -sd / -f 2- | LC_ALL=C sort > .generated_docs + touch docs/.generated_docs + find . -type f | cut -sd / -f 2- | LC_ALL=C sort > docs/.generated_docs popd > /dev/null } # Puts a placeholder for every generated doc. This makes the link checker work. kube::util::set-placeholder-gen-docs() { - local list_file="${KUBE_ROOT}/.generated_docs" + local list_file="${KUBE_ROOT}/docs/.generated_docs" if [ -e ${list_file} ]; then # remove all of the old docs; we don't want to check them in. while read file; do @@ -243,7 +243,7 @@ kube::util::set-placeholder-gen-docs() { cp "${KUBE_ROOT}/hack/autogenerated_placeholder.txt" "${KUBE_ROOT}/${file}" fi done <"${list_file}" - # The .generated_docs file lists itself, so we don't need to explicitly + # The docs/.generated_docs file lists itself, so we don't need to explicitly # delete it. fi } @@ -251,12 +251,12 @@ kube::util::set-placeholder-gen-docs() { # Removes previously generated docs-- we don't want to check them in. $KUBE_ROOT # must be set. kube::util::remove-gen-docs() { - if [ -e "${KUBE_ROOT}/.generated_docs" ]; then + if [ -e "${KUBE_ROOT}/docs/.generated_docs" ]; then # remove all of the old docs; we don't want to check them in. while read file; do rm "${KUBE_ROOT}/${file}" 2>/dev/null || true - done <"${KUBE_ROOT}/.generated_docs" - # The .generated_docs file lists itself, so we don't need to explicitly + done <"${KUBE_ROOT}/docs/.generated_docs" + # The docs/.generated_docs file lists itself, so we don't need to explicitly # delete it. fi } diff --git a/hack/update-generated-docs.sh b/hack/update-generated-docs.sh index 149d81e7b2063..38595ff71b03a 100755 --- a/hack/update-generated-docs.sh +++ b/hack/update-generated-docs.sh @@ -44,7 +44,7 @@ kube::util::gen-docs "${KUBE_TEMP}" kube::util::remove-gen-docs # Copy fresh docs into the repo. -# the shopt is so that we get .generated_docs from the glob. +# the shopt is so that we get docs/.generated_docs from the glob. shopt -s dotglob cp -af "${KUBE_TEMP}"/* "${KUBE_ROOT}" shopt -u dotglob diff --git a/hack/verify-generated-docs.sh b/hack/verify-generated-docs.sh index 8ca70334c879f..e2d1899ffddc0 100755 --- a/hack/verify-generated-docs.sh +++ b/hack/verify-generated-docs.sh @@ -37,7 +37,7 @@ kube::util::ensure-temp-dir kube::util::gen-docs "${KUBE_TEMP}" # Verify the list matches the expected list (diff should be empty) -if [[ "$(diff ${KUBE_ROOT}/.generated_docs ${KUBE_TEMP}/.generated_docs)" != "" ]]; then +if [[ "$(diff ${KUBE_ROOT}/docs/.generated_docs ${KUBE_TEMP}/docs/.generated_docs)" != "" ]]; then echo "List of generated docs doesn't match a freshly built list. Please run hack/update-generated-docs.sh" exit 1 fi @@ -45,8 +45,8 @@ fi # Verify the files in the repo all contain the boilerplate instead of the actual # content. while read file; do - # Ignore .generated_docs-- it should not have the boilerplate! - [[ "${file}" == ".generated_docs" ]] && continue + # Ignore docs/.generated_docs-- it should not have the boilerplate! + [[ "${file}" == "docs/.generated_docs" ]] && continue # Search for "hack/generate-docs.sh" as a proxy for the boilerplate content, # since the munger adds a bunch of other stuff. @@ -55,4 +55,4 @@ while read file; do echo "Please run hack/update-generated-docs.sh" exit 1 fi -done <"${KUBE_ROOT}/.generated_docs" +done <"${KUBE_ROOT}/docs/.generated_docs"