Move the release-1.6 branch to use release-1.6 common files. (#7491)

This commit is contained in:
Eric Van Norman 2020-06-09 08:48:12 -05:00 committed by GitHub
parent 9070ef187a
commit 5ce357cc2a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 13 additions and 29 deletions

View File

@ -78,7 +78,7 @@ documentation repo to track this:
1. Switch to the **master** branch of the istio/istio.io repo and make sure everything is up to date.
1. Edit the file `Makefile.core.mk` and change the `SOURCE_BRANCH_NAME` variable to the
1. Edit the file `Makefile.core.mk` and change the `SOURCE_BRANCH_NAME` variable to the
name of the newly created source branches (in this case `release-1.4`).
1. Edit the file `data/args.yml` and set the `source_branch_name` field to the name of the newly created source
@ -110,6 +110,8 @@ such branch for every release.
1. Edit the file `data/args.yml`. Set the `preliminary` field to `false`
and the the `doc_branch_name` field to the name of the release branch (in this case `release-1.4`).
1. Manually update the common/Makefile.common.mk UPDATE_BRANCH to point to the new release and then run 'make update-common'.
1. Commit the previous edits to your local git repo and push your **release** branch to GitHub.
#### Updating istio.io
@ -217,7 +219,7 @@ tells the Hugo site generator to process your content.
new content directory. This ensures that the linting rules apply to your new content.
- Edit the file `src/ts/lang.ts` and add your new language. This will add your language to the language toggle button that is
available on preliminary.istio.io and will make it so your language will be supported in the language selection menu.
available on preliminary.istio.io and will make it so your language will be supported in the language selection menu.
- Get an Istio GitHub administrator to create a new maintainer team for your language. For Franch, this would be
`WG - Docs Mintainers/French`.
@ -227,7 +229,7 @@ the translated content and translation table file.
You can then commit all of these changes and you can start translating the content and the translation file in a purely
incremental fashion. When you build the site, you'll find your content at `<url>/<language code>`. For example, once you've
checked everything in, you should be able to get to your content at `https://preliminary.istio.io/fr` if you were doing a
checked everything in, you should be able to get to your content at `https://preliminary.istio.io/fr` if you were doing a
French translation.
Once your translation is complete and you're ready to publish it to the world, there are a few other changes you need to make:
@ -243,14 +245,14 @@ For French, this would be:
- Edit fhe file `layouts/partials/headers.html`. Search for `switch-lang` and you'll find the definitions for the language selection
menu. Add a line for your new language.
And that's it.
And that's it.
## Regular maintenance
We have a number of checks in place to ensure a number of invariants are maintained in order to
help the site's overall quality. For example, we disallow checking in broken links and we do spell
checking. There are some things which are hard to systematically check through automation and instead
require a human to review on in a while to ensure everything's doing well.
require a human to review on in a while to ensure everything's doing well.
It's a good idea to run through this list before every major release of the site:

View File

@ -1 +1 @@
d1c990b8e308d92fe3a76db64f2c9ad11714b0ba
20a849f2370f3118628fd5352b994042adce3ce6

View File

@ -92,7 +92,7 @@ mirror-licenses:
@license-lint --mirror
TMP := $(shell mktemp -d -u)
UPDATE_BRANCH ?= "master"
UPDATE_BRANCH ?= "release-1.6"
update-common:
@mkdir -p $(TMP)

View File

@ -199,12 +199,3 @@ whitelisted_modules:
# Apache 2.0: https://github.com/garyburd/redigo/blob/master/LICENSE
- github.com/gomodule/redigo
# Apache 2.0: https://github.com/xdg/scram/blob/master/LICENSE
- github.com/xdg/scram
# Apache 2.0: https://github.com/xdg/stringprep/blob/master/LICENSE
- github.com/xdg/stringprep
# BSD-3: https://github.com/golang/tools/blob/master/LICENSE
- golang.org/x/tools

View File

@ -59,7 +59,7 @@ fi
# Build image to use
if [[ "${IMAGE_VERSION:-}" == "" ]]; then
export IMAGE_VERSION=master-2020-05-20T22-13-03
export IMAGE_VERSION=release-1.6-2020-05-08T22-06-04
fi
if [[ "${IMAGE_NAME:-}" == "" ]]; then
export IMAGE_NAME=build-tools
@ -90,25 +90,16 @@ do
unset -f "${f}"
done
# Set conditional host mounts
# Set up conditional host mounts for docker and kubernetes config
export CONDITIONAL_HOST_MOUNTS=${CONDITIONAL_HOST_MOUNTS:-}
# docker conditional host mount (needed for make docker push)
if [[ -d "${HOME}/.docker" ]]; then
CONDITIONAL_HOST_MOUNTS+="--mount type=bind,source=${HOME}/.docker,destination=/config/.docker,readonly "
fi
# gcloud conditional host mount (needed for docker push with the gcloud auth configure-docker)
if [[ -d "${HOME}/.config/gcloud" ]]; then
CONDITIONAL_HOST_MOUNTS+="--mount type=bind,source=${HOME}/.config/gcloud,destination=/config/.config/gcloud,readonly "
fi
# Conditional host mount if KUBECONFIG is set
if [[ -n "${KUBECONFIG}" ]]; then
CONDITIONAL_HOST_MOUNTS+="--mount type=bind,source=$(dirname "${KUBECONFIG}"),destination=/home/.kube,readonly "
elif [[ -f "${HOME}/.kube/config" ]]; then
# otherwise execute a conditional host mount if $HOME/.kube/config is set
CONDITIONAL_HOST_MOUNTS+="--mount type=bind,source=${HOME}/.kube,destination=/home/.kube,readonly "
if [[ -d "${HOME}/.kube" ]]; then
CONDITIONAL_HOST_MOUNTS+="--mount type=bind,source=${HOME}/.kube,destination=/home/.kube "
fi
# Avoid recursive calls to make from attempting to start an additional container