diff --git a/README.md b/README.md index 77a2b8c0c5..4605173867 100644 --- a/README.md +++ b/README.md @@ -50,11 +50,7 @@ is used is determined by the istio.io [Netlify](https://netlify.com) project's c * The content of archive.istio.io is taken from the older release-XXX branches. The set of branches that are included on archive.istio.io is determined by the `TOBUILD` variable in this -[script](https://github.com/istio/admin-sites/blob/master/archive.istio.io/build.sh) - -> The above means that if you want to do a change to the main istio.io site, you need -to make the change in the master branch of https://github.com/istio/istio.io and then merge that change into the -current release branch. +[script](https://github.com/istio/istio.io/blob/master/scripts/gen_archive_site.sh). ### Publishing content immediately @@ -72,23 +68,33 @@ version of Istio is 0.6 and you wish to introduce 0.7 which has been under devel 1. Switch to the istio/istio.io repo and make sure everything is up to date. +1. Run `scripts/grab_reference_docs.sh` in order to get the latest reference docs. + +1. Edit the file `scripts/gen_archive_site.sh` and add the new archive version +(in this case release-0.6) to the `TOBUILD` variable. + +1. Commit the previous edits to your local git repo and push your **master** branch to GitHub. + 1. Create a new release branch off of master, named as release-*major*.*minor*, which in this case would be release-0.7. There is one such branch for every release. 1. In the **release** branch you created, edit the file `data/args.yml`. Set the `preliminary` field to `false` and the `source_branch_name` and `doc_branch_name` fields to the name of the branch, in this case release-0.7. +1. In the **release** branch you created, edit the file `scripts/grab_reference_docs.sh`. Update the branch +name for `istio.git` and `api.git` to point to the release branch. In this case release-0.7. + 1. Commit the previous edit to your local git repo and push your **release** branch to GitHub. #### Updating preliminary.istio.io 1. Switch to the istio/istio.io repo and make sure everything is up to date. -1. In the **master** branch, edit the file `data/versions.yml`. Set preliminary to the next Istio release -("0.8") and main to the current release ("0.7"). +1. In the **master** branch, edit the file `data/versions.yml`. Set the `preliminary` field to the next Istio release +("0.8") and the `main` field to the current release ("0.7"). -1. In the **master** branch, edit the file `data/args.yml` and update the `version` and `full_version` fields to have the version -of the next Istio release. In this case, you would set the fields to 0.8 and 0.8.0 respectively. +1. In the **master** branch, edit the file `data/args.yml`. Set the `version` and `full_version` fields to have the version +of the next Istio release. In this case, you would set the fields to "0.8" and "0.8.0" respectively. 1. Commit the previous edits to your local git repo and push the **master** branch to GitHub. @@ -124,16 +130,18 @@ of the next Istio release. In this case, you would set the fields to 0.8 and 0.8 1. In the **previous release's** branch (in this case release-0.6), edit the file `data/args.yml`. Set the `archive` field to true and the `archive_date` field to the current date. -1. Commit the previous edit to your local git repo and push the **previous release's* branch to GitHub. +1. In the **previous release's** branch (in this case release-0.6), edit the file `config.toml`. Set the +`disableAliases` field to `false`. -1. Switch to the istio/admin-sites repo. +1. Commit the previous edits to your local git repo and push the **previous release's* branch to GitHub. -1. Edit the `archive.istio.io/build.sh` script to add the newest archive version (in this case -release-0.6) to the `TOBUILD` variable. +1. Go to the archive.istio.io project on [Netlify](https://netlify.com) -1. Commit the previous edit to your local git repo and push the change to GitHub. +1. Change the branch that is built from the previous release's branch to the new release branch, in this case release-0.7. -1. Wait a while (~10 minutes) and browse archive.istio.io and make sure everything looks good. +1. Select the option to trigger an immediate rebuild and redeployment. + +1. Once deployment is done, browse archive.istio.io and make sure everything looks good. ### Creating a patch release @@ -146,9 +154,11 @@ you describe the changes in the release. 1. Create a release note page in `content/about/notes/1.X.Y/index.md`, where `1.X.Y` is the name of the release. -1. Create an announcement blog post in `content/blog/YYYY/announcing-1.X.Y`, where `YYYY` is the current year +1. Create an announcement blog post in `content/blog/YYYY/announcing-1.X.Y/index.md`, where `YYYY` is the current year and `1.x.Y` is the name of the release. 1. Edit the `data/args.yml` file and change the `full_version` field to the name of the release. -For the first three files, please look at existing files in the same location for example content and layout. +1. Run `scripts/grab_reference_docs.sh` to get the latest reference docs. + +For the first three files, please look at existing files in the same locations for example content and layout. diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html index f2f86107ae..a553f888c0 100644 --- a/layouts/partials/footer.html +++ b/layouts/partials/footer.html @@ -7,10 +7,12 @@ {{- $release_url = printf "https://github.com/istio/istio/releases/tag/%s" .Site.Data.args.full_version -}} {{- end -}} - - download - {{ partial "icon.html" "download" }} - + {{- if not .Site.Data.args.archive_landing -}} + + download + {{ partial "icon.html" "download" }} + + {{- end -}} discuss diff --git a/layouts/partials/header.html b/layouts/partials/header.html index 54fb48d7fa..30edffe8b8 100644 --- a/layouts/partials/header.html +++ b/layouts/partials/header.html @@ -54,65 +54,65 @@ {{ end }} {{ end }} - {{ if not .Site.Data.args.archive_landing }} -
- +
+ - - {{ end }} +