54e8d73920
The placeholder documentation introduces a couple of problems: - it complicates the contributor-experience (forces the CI to run N times before the contributor finds out that they need to call an .sh script and include certain files from docs/) - it forces CLI related pull requests for tools like kubeadm and kubectl to require top level approval from docs/OWNERS as such PRs still need to touch the .generated_docs file Stop tracking the placeholder documentation by applying the following actions: - remove the utility set-placeholder-gen-docs() - make verify-generated-docs.sh only generate in a temporary folder and not match .generated_docs - mark generate-docs.sh as an alias for update-generated-docs.sh - remove all current placeholder files in docs folders admin, man, user-guide, yaml - ignore the above folders and .generated_docs in a .gitignore file
50 lines
1.3 KiB
Bash
Executable File
50 lines
1.3 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
# Copyright 2014 The Kubernetes Authors.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
# This file is not intended to be run automatically. It is meant to be run
|
|
# immediately before exporting docs. We do not want to check these documents in
|
|
# by default.
|
|
|
|
set -o errexit
|
|
set -o nounset
|
|
set -o pipefail
|
|
|
|
KUBE_ROOT=$(dirname "${BASH_SOURCE}")/..
|
|
source "${KUBE_ROOT}/hack/lib/init.sh"
|
|
|
|
kube::golang::setup_env
|
|
|
|
BINS=(
|
|
cmd/gendocs
|
|
cmd/genkubedocs
|
|
cmd/genman
|
|
cmd/genyaml
|
|
)
|
|
make -C "${KUBE_ROOT}" WHAT="${BINS[*]}"
|
|
|
|
kube::util::ensure-temp-dir
|
|
|
|
kube::util::gen-docs "${KUBE_TEMP}"
|
|
|
|
# remove all of the old docs
|
|
kube::util::remove-gen-docs
|
|
|
|
# Copy fresh docs into the repo.
|
|
# 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
|