1 Star 0 Fork 0

Lockdown / istio.io

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0
Site Status
istio.io Netlify Status
preliminary.istio.io Netlify Status
archive.istio.io Netlify Status

istio.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 building

To learn how to edit and build this repo's content, please refer to Creating and Editing Pages.

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

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-1.4).

This process can be taken care of automatically by our infrastructure. If you submit a PR to the master branch and annotate the PR with the actions/merge-to-release-branch label, then as soon as your PR is merged into master, it will be merged into the current release branch.

Creating a version

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

When Istio source code is branched

The documentation repo pulls content from the Istio source repos for inclusion in the published site. When the source repos are branched in preparation for a release, a few changes are needed in the 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.

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

  3. Edit the file data/args.yml and set the source_branch_name field to the name of the newly created source branches (in this case release-1.4).

  4. Run make update_all in order to retrieve the latest material from the source repositories.

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

On the day of the release

Creating the release branch

The day of a major Istio release, assuming you've previously done the steps from the above section, you need to:

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

  2. Edit the file scripts/build_archive_site.sh and add the new archive version (in this case release-1.3) to the TOBUILD variable.

  3. Edit the file data/versions.yml. Set the preliminary field to the next Istio release (in this case 1.5) and the main field to the current release (in this case 1.4).

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

  5. Create a new release branch off of master, named as release-major.minor (in this case release-1.4). There is one such branch for every release.

  6. 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).

  7. Commit the previous edits to your local git repo and push your release branch to GitHub.

Updating istio.io

  1. Go to the istio.io project on Netlify

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

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

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

Updating archive.istio.io
  1. Go to the Google Custom Search Engine and do the following:

    • Download the archive.istio.io CSE context file from the Advanced tab.

    • Add a new FacetItem at the top of the file containing the previous release's version number. In this case, this would be "V1.3".

    • Upload the updated CSE context file to the site.

    • In the Setup section, add a new site that covers the previous release's archive directory. In this case, the site URL would be archive.istio.io/v1.3/*. Set the label of this site to the name of the facet item created above (V1.3 in this case).

  2. In the previous release's branch (in this case release-1.3), edit the file data/args.yml. Set the archive field to true and the archive_date field to the current date, and the rchive_search_refinement to the previous release version (in this case V1.3).

  3. In the previous release's branch (in this case release-1.3), edit the file config.toml. Set the disableAliases field to false.

  4. Commit the previous edits to your local git repo and push the previous release's branch to GitHub.

  5. In the archive branch, rebase the branch to have all changes from the current release. In this case, all changes from the release-1.4 branch.

  6. Commit the previous edits to your local git repo and push the archive branch to GitHub.

  7. Wait a while (~20 minutes) and browse archive.istio.io to make sure everything looks good.

Updating preliminary.istio.io
  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, and previous_version to be the version of the previous release. In this case, you would set the fields to "1.5", "1.5.0", and "1.4" respectively.

  2. In the master branch, edit the file data/args.yml. Set the source_branch_name and doc_branch_name fields to master.

  3. In the master branch, edit the file Makefile.core.mk. Set the variable SOURCE_BRANCH_NAKE to master.

  4. Run make update_all in order to retrieve the latest material from the source repositories.

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

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

Creating a patch release

Creating a new patch release involves modifying a few files:

  1. Create the release note for the release by adding a markdown file in content/en/news/<YEAR>/1.X.Y/index.md, where 1.X.Y is the name of the release. This is where you describe the changes in the release.

  2. Edit the data/args.yml file and change the full_version field to the name of the release.

  3. Run make update_ref_docs to get the latest reference docs.

For the release note file, please look at existing files in the same location for example content and layout.

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.

It's a good idea to run through this list before every major release of the site:

  • Ensure that references to the Istio repos on GitHub don't hardcode branch names. Search for any uses of /release-1 or /master throughout all the markdown files and replace those with {{< source_branch_name >}} instead, which produces a version-appropriate branch name.

  • Review the .spelling file for words thst shouldn't be in there. Type names in particular tend to creep in here. Type names should not be in the dictionary and should instead be shown with backticks. Remove the entries from the dictionary and fix any spell checking errors that emerge.

  • Ensure proper capitalization. Document titles need to be fully capitalized (e.g. "This is a Valid Title"), while section headings should use first letter capitalization only (e.g. "This is a valid heading").

  • Ensure that preformatted text blocks that reference files from the Istio GitHub repos use the @@ syntax to produce links to the content. See here for context.

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2016-2019 Istio 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.

简介

Source for the istio.io site 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/dugukuangshao/istio.io.git
git@gitee.com:dugukuangshao/istio.io.git
dugukuangshao
istio.io
istio.io
master

搜索帮助