Tune the archive_landing mode. (#4045)

This commit is contained in:
Martin Taillefer 2019-04-25 13:47:30 -07:00 committed by GitHub
parent aeabfeb00f
commit 5ca5a0bfc4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 70 additions and 61 deletions

View File

@ -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 * 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 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) [script](https://github.com/istio/istio.io/blob/master/scripts/gen_archive_site.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.
### Publishing content immediately ### Publishing content immediately
@ -72,12 +68,22 @@ 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. 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 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. 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` 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. 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. 1. Commit the previous edit to your local git repo and push your **release** branch to GitHub.
#### Updating preliminary.istio.io #### Updating preliminary.istio.io
@ -129,14 +135,13 @@ of the next Istio release. In this case, you would set the fields to "0.8" and "
1. Commit the previous edits to your local git repo and push the **previous release's* branch to GitHub. 1. Commit the previous edits to your local git repo and push the **previous release's* branch to GitHub.
1. Switch to the istio/admin-sites repo. 1. Go to the archive.istio.io project on [Netlify](https://netlify.com)
1. Edit the `archive.istio.io/build.sh` script to add the newest archive version (in this case 1. Change the branch that is built from the previous release's branch to the new release branch, in this case release-0.7.
release-0.6) to the `TOBUILD` variable.
1. Commit the previous edit to your local git repo and push the change to GitHub. 1. Select the option to trigger an immediate rebuild and redeployment.
1. Wait a while (~15 minutes) and browse archive.istio.io and make sure everything looks good. 1. Once deployment is done, browse archive.istio.io and make sure everything looks good.
### Creating a patch release ### Creating a patch release
@ -154,4 +159,6 @@ 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. 1. Edit the `data/args.yml` file and change the `full_version` field to the name of the release.
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. For the first three files, please look at existing files in the same locations for example content and layout.

View File

@ -7,10 +7,12 @@
{{- $release_url = printf "https://github.com/istio/istio/releases/tag/%s" .Site.Data.args.full_version -}} {{- $release_url = printf "https://github.com/istio/istio/releases/tag/%s" .Site.Data.args.full_version -}}
{{- end -}} {{- end -}}
{{- if not .Site.Data.args.archive_landing -}}
<a class="channel" title='{{ printf (i18n "download_desc") (strings.TrimSuffix ".0" .Site.Data.args.full_version) }}' href="{{- $release_url -}}" aria-label="Download Istio"> <a class="channel" title='{{ printf (i18n "download_desc") (strings.TrimSuffix ".0" .Site.Data.args.full_version) }}' href="{{- $release_url -}}" aria-label="Download Istio">
<span>download</span> <span>download</span>
{{ partial "icon.html" "download" }} {{ partial "icon.html" "download" }}
</a> </a>
{{- end -}}
<a class="channel" title='{{ i18n "discuss_istio_io_desc" }}' href="https://discuss.istio.io" aria-label="Istio discussion board"> <a class="channel" title='{{ i18n "discuss_istio_io_desc" }}' href="https://discuss.istio.io" aria-label="Istio discussion board">
<span>discuss</span> <span>discuss</span>

View File

@ -54,7 +54,6 @@
{{ end }} {{ end }}
{{ end }} {{ end }}
{{ if not .Site.Data.args.archive_landing }}
<div class="menu"> <div class="menu">
<button id="gearDropdownButton" class="menu-trigger" title='{{ i18n "options_menu" }}' <button id="gearDropdownButton" class="menu-trigger" title='{{ i18n "options_menu" }}'
aria-label="Options and Settings" aria-controls="gearDropdownContent"> aria-label="Options and Settings" aria-controls="gearDropdownContent">
@ -62,10 +61,12 @@
</button> </button>
<div id="gearDropdownContent" class="menu-content" aria-labelledby="gearDropdownButton" role="menu"> <div id="gearDropdownContent" class="menu-content" aria-labelledby="gearDropdownButton" role="menu">
{{ if not .Site.Data.args.archive_landing }}
<a tabindex="-1" role="menuitem" lang="en" id="switch-lang-en" {{ if eq $home.Lang "en" }}class="active"{{ end }}>English</a> <a tabindex="-1" role="menuitem" lang="en" id="switch-lang-en" {{ if eq $home.Lang "en" }}class="active"{{ end }}>English</a>
<a tabindex="-1" role="menuitem" lang="zh" id="switch-lang-zh" {{ if eq $home.Lang "zh" }}class="active"{{ end }}>中文</a> <a tabindex="-1" role="menuitem" lang="zh" id="switch-lang-zh" {{ if eq $home.Lang "zh" }}class="active"{{ end }}>中文</a>
<div role="separator"></div> <div role="separator"></div>
{{ end }}
<a tabindex="-1" role="menuitem" class="active" id="light-theme-item">{{ i18n "light_theme" }}</a> <a tabindex="-1" role="menuitem" class="active" id="light-theme-item">{{ i18n "light_theme" }}</a>
<a tabindex="-1" role="menuitem" id="dark-theme-item">{{ i18n "dark_theme" }}</a> <a tabindex="-1" role="menuitem" id="dark-theme-item">{{ i18n "dark_theme" }}</a>
@ -112,7 +113,6 @@
{{ end }} {{ end }}
</div> </div>
</div> </div>
{{ end }}
<button id="search-show" title='{{ i18n "search" }}' aria-label='{{ i18n "search_label" }}'>{{ partial "icon.html" "magnifier" }}</button> <button id="search-show" title='{{ i18n "search" }}' aria-label='{{ i18n "search_label" }}'>{{ partial "icon.html" "magnifier" }}</button>
</div> </div>