Skip to content

Latest commit

 

History

History
191 lines (121 loc) · 8.18 KB

README.md

File metadata and controls

191 lines (121 loc) · 8.18 KB
Raw

istio.github.io

This repository contains the source code for the istio.io, preliminary.istio.io and archive.istio.io sites.

Please see the main Istio README file to learn about the overall Istio project and how to get in touch with us. To learn how you can contribute to any of the Istio components, please see the Istio contribution guidelines.

Editing and testing content

We use Hugo to generate our sites. To build and test the site locally, we use a docker image that contains Hugo. To build and serve the site, simply go to the root of the tree and do:

$ make serve

This will build the site and start a web server hosting the site. You can then connect to the web server at http://localhost:1313.

All normal content for the site is located in the content directory, as well as in sibling translated directories such as content_zh.

Linting

We use linters to ensure some base quality to the site's content. We currently run 3 linters as a precommit requirement:

  • HTML proofing, which ensures all your links are valid along with other checks.

  • Spell checking.

  • Style checking, which makes sure your markdown files comply with our common style rules.

You can run these linters locally using:

$ make build
$ make gen
$ make lint

If you get spelling errors, you have three choices to address it:

  • It's a real typo, so fix your markdown.

  • It's a command/field/symbol name, so stick some backticks around it.

  • It's really valid, so go add the word to the .spelling file at the root of the repo.

Site infrastructure

Here's how things work:

  • Primary site content is in the content directory. This is mostly markdown files which Hugo processes into HTML.

  • Additional site content is in the static directory. These are files that Hugo directly copies to the site without any processing.

  • The src directory contains the source material for certain files from the static directory. You use

    $ make build

    to build the material from the src directory and refresh what's in the static directory.

Versions and releases

Istio maintains three variations of its public site.

  • istio.io is the main site, showing documentation for the current release of the product.

  • archive.istio.io contains snapshots of the documentation for previous releases of the product. This is useful for customers still using these older releases.

  • preliminary.istio.io contains the actively updated documentation for the next release of the product.

The user can trivially navigate between the different variations of the site using the gear menu in the top right of each page. All three sites are hosted on Netlify.

How versioning works

  • Documentation changes are primarily committed to the master branch of istio.github.io. Changes committed to this branch are automatically reflected on preliminary.istio.io.

  • The content of istio.io is taken from the latest release-XXX branch. The specific branch that is used is determined by the istio.io Netlify project's configuration.

  • 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

The above means that if you want to do a change to the main istio.io site, you will need to make the change in the master branch of istio.github.io and then merge that change into the current release branch.

Publishing content immediately

Checking in updates to the master branch will automatically update preliminary.istio.io, and will only be reflected on istio.io the next time a release is created, which can be several weeks in the future. If you'd like some changes to be immediately reflected on istio.io, you need to check your changes both to the master branch and to the current release branch (named release-XXX such as release-0.7).

Creating a version

Here are the steps necessary to create a new documentation version. Let's assume the current version of Istio is 0.6 and you wish to introduce 0.7 which has been under development.

Creating the release branch

  1. Switch to the istio/istio.github.io repo and make sure everything is up to date.

  2. 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.

  3. Push the new release branch to GitHub.

Updating preliminary.istio.io

  1. Switch to the istio/istio.github.io repo and make sure everything is up to date.

  2. In the master branch, edit the file data/releases.yml and add a new entry at the top of the file for version 0.8. You'll need to make sure the URLs are updated for the first few entries. The top entry (0.8) should point to preliminary.istio.io. The second entry (0.7) should point to istio.io. The third and subsequent entries should point to archive.istio.io.

  3. In the master branch, edit the file data/args.yml and update the version field to have the version of the next release of Istio. In this case, you would set the field to 0.8.

  4. In the master branch, add 2 placeholder markdown files for the next release's release notes as content/about/notes/<major>.<minor>/index.md and content_zh/about/notes/<major>.<minor>/index.md

  5. Commit the previous edits to your local git repo and push the master branch to GitHub.

  6. Wait a while (~2 minutes) and browse preliminary.istio.io to make sure everything looks good.

Updating istio.io

  1. Switch to the istio/istio.github.io repo and make sure everything is up to date.

  2. In the release branch you created, edit the file data/args.yml. Set the preliminary field to false and the branch_name field to the name of the branch, in this case release-0.7.

  3. Commit the previous edit to your local git repo and push your release branch to GitHub.

  4. Go to the istio.io project on Netlify

  5. Change the branch that is built from the previous release's branch to the new release branch, in this case release-0.7

  6. Select the option to trigger an immediate rebuild and redeployment.

  7. Once deployment is done, browse istio.io and make sure everything looks good.

Updating archive.istio.io

  1. Switch to the istio/istio.github.io repo and make sure everything is up to date.

  2. Go to the Google Custom Search Engine and create a new search engine that searches the archive.istio.io/V<major>.<minor> directory. This search engine will be used to perform version-specific searches on archive.istio.io.

  3. Once the search engine is created, download the CSE context XML file and set the nonprofit property from false to true. Upload the edited CSE context file back to the web site.

  4. In the previous release's branch (in this case release-0.6), edit the file data/args.yml. Set the archive field to true, the archive_date field to the current date, and the search_engine_id field to the ID of the search engine you created in the prior step.

  5. Commit the previous edit to your local git repo and push the *previous release's branch to GitHub.

  6. Switch to the istio/admin-sites repo.

  7. Edit the archive.istio.io/build.sh script to add the newest archive version (in this case release-0.6) to the TOBUILD variable.

  8. Commit the previous edit to your local git repo and push the change to GitHub.

  9. Wait a while (~10 minutes) and browse archive.istio and make sure everything looks good.