versionize-docs is dead

build-tools/versionize-docs.sh

-#!/bin/bash
-
-# Copyright 2015 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.
-
-# Updates the docs to be ready to be used as release docs for a particular
-# version.
-# Example usage:
-# ./versionize-docs.sh release-1.1
-
-set -o errexit
-set -o nounset
-set -o pipefail
-
-KUBE_ROOT=$(dirname "${BASH_SOURCE}")/..
-
-RELEASE_BRANCH=${1-}
-
-# MAJOR_AND_MINOR_VERSION is expected to be something like "v1.1"
-MAJOR_AND_MINOR_VERSION="v${RELEASE_BRANCH#release-}"
-
-if [ "$#" -lt 1 ]; then
-    echo "Usage: versionize-docs.sh <release-branch>, e.g., versionize-docs.sh release-1.1."
-    echo "The <release-branch> is used to rewrites link URL, which should always point to a release branch, NOT a tag like v1.1.1."
-    exit 1
-fi
-
-SED=sed
-if which gsed &>/dev/null; then
-  SED=gsed
-fi
-if ! ($SED --version 2>&1 | grep -q GNU); then
-  echo "!!! GNU sed is required.  If on OS X, use 'brew install gnu-sed'."
-  exit 1
-fi
-
-echo "+++ Versioning documentation and examples"
-
-# Update the docs to match this version.
-HTML_PREVIEW_PREFIX="https://htmlpreview.github.io/\?https://github.com/kubernetes/kubernetes/blob"
-# Update the include directory in definitions.md and operations.md.
-DIRECTORY_KEY_WORDS="<REPLACE-WITH-RELEASE-VERSION>"
-
-md_dirs=(docs examples)
-md_files=()
-for dir in "${md_dirs[@]}"; do
-  md_files+=($( find "${dir}" -name "*.md" -type f ))
-done
-for doc in "${md_files[@]}"; do
-  $SED -ri \
-      -e '/<!-- BEGIN STRIP_FOR_RELEASE -->/,/<!-- END STRIP_FOR_RELEASE -->/d' \
-      -e "s|(releases.k8s.io)/[^/]+|\1/${RELEASE_BRANCH}|g" \
-      "${doc}"
-
-  # Replace /HEAD in html preview links with /RELEASE_BRANCH
-  $SED -ri -e "s|(${HTML_PREVIEW_PREFIX})/HEAD|\1/${RELEASE_BRANCH}|g" "${doc}"
-
-  # Replace <REPLACE-WITH-RELEASE-VERSION> with MAJOR_AND_MINOR_VERSION.
-  $SED -ri -e "s|${DIRECTORY_KEY_WORDS}|${MAJOR_AND_MINOR_VERSION}|g" "${doc}"
-
-  is_versioned_tag="<!-- BEGIN MUNGE: IS_VERSIONED -->
-<!-- TAG IS_VERSIONED -->
-<!-- END MUNGE: IS_VERSIONED -->"
-  if ! grep -q "${is_versioned_tag}" "${doc}"; then
-    echo -e "\n\n${is_versioned_tag}\n\n" >> "${doc}"
-  fi
-done
-
-# Update kubectl cmd files so that kubectl docs generated from them are as
-# expected.
-go_dirs=(pkg/kubectl/cmd)
-go_files=()
-for dir in "${go_dirs[@]}"; do
-  go_files+=($( find "${dir}" -name "*.go" -type f ))
-done
-# Update API descriptions as well
-go_files+=(pkg/api/v[0-9]*/types.go)
-go_files+=(pkg/api/unversioned/types.go)
-go_files+=(pkg/apis/*/v[0-9]*/types.go)
-go_files+=(pkg/apis/*/types.go)
-
-for file in "${go_files[@]}"; do
-  $SED -ri \
-      -e "s|(releases.k8s.io)/[^/]+|\1/${RELEASE_BRANCH}|g" \
-      -e "s|(${HTML_PREVIEW_PREFIX})/HEAD|\1/${RELEASE_BRANCH}|g" \
-      "${file}"
-done
-
-${KUBE_ROOT}/hack/update-munge-docs.sh
-${KUBE_ROOT}/hack/update-generated-swagger-docs.sh
-${KUBE_ROOT}/hack/update-swagger-spec.sh
-${KUBE_ROOT}/hack/update-openapi-spec.sh
-${KUBE_ROOT}/hack/update-generated-protobuf.sh
-./hack/update-api-reference-docs.sh

docs/devel/cherry-picks.md

@@ -42,24 +42,6 @@ label.
 There is an [issue](https://github.com/kubernetes/kubernetes/issues/23347) open
 tracking the tool to automate the batching procedure.
 
-#### Cherrypicking a doc change
-
-If you are cherrypicking a change which adds a doc, then you also need to run
-`build-tools/versionize-docs.sh` in the release branch to versionize that doc.
-Ideally, just running `hack/cherry_pick_pull.sh` should be enough, but we are
-not there yet: [#18861](https://github.com/kubernetes/kubernetes/issues/18861)
-
-To cherrypick PR 123456 to release-3.14, run the following commands after
-running `hack/cherry_pick_pull.sh` and before merging the PR:
-
-```
-$ git checkout -b automated-cherry-pick-of-#123456-upstream-release-3.14
-origin/automated-cherry-pick-of-#123456-upstream-release-3.14
-$ ./build-tools/versionize-docs.sh release-3.14
-$ git commit -a -m "Running versionize docs"
-$ git push origin automated-cherry-pick-of-#123456-upstream-release-3.14
-```
-
 ## Cherry Pick Review
 
 Cherry pick pull requests are reviewed differently than normal pull requests. In

docs/devel/how-to-doc.md

@@ -19,7 +19,6 @@ for Kubernetes.*
     - [Headings](#headings)
   - [What Are Mungers?](#what-are-mungers)
   - [Auto-added Mungers](#auto-added-mungers)
-    - [Is Versioned](#is-versioned)
     - [Generate Analytics](#generate-analytics)
 - [Generated documentation](#generated-documentation)
 
@@ -181,18 +180,6 @@ your md file that are auto-added. You don't have to add them manually. It's
 recommended to just read this section as a reference instead of messing up with
 the following mungers.
 
-
-### Is Versioned
-
-IS_VERSIONED munger inserts `IS_VERSIONED` tag in documents in each release,
-which stops UNVERSIONED_WARNING munger from inserting warning messages.
-
-```
-<!-- BEGIN MUNGE: IS_VERSIONED -->
-<!-- TAG IS_VERSIONED -->
-<!-- END MUNGE: IS_VERSIONED -->
-```
-
 ### Generate Analytics
 
 ANALYTICS munger inserts a Google Anaylytics link for this page.

examples/volumes/nfs/README.md

@@ -160,11 +160,6 @@ nfs-busybox-w3s4t
 
 
 
-<!-- BEGIN MUNGE: IS_VERSIONED -->
-<!-- TAG IS_VERSIONED -->
-<!-- END MUNGE: IS_VERSIONED -->
-
-
 <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
 [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/examples/volumes/nfs/README.md?pixel)]()
 <!-- END MUNGE: GENERATED_ANALYTICS -->