mirror of https://github.com/istio/istio.io.git
Replace references from istio.github.io to istio.io (#2686)
This commit is contained in:
Martin Taillefer
GitHub
parent
cfd8124766
commit
3acfe3fe40
12
README.md
12
README.md
|
|
@ -1,4 +1,4 @@
|
|||
## istio.github.io
|
||||
## istio.io
|
||||
|
||||
This repository contains the source code for the [istio.io](https://istio.io),
|
||||
[preliminary.istio.io](https://preliminary.istio.io) and [archive.istio.io](https://archive.istio.io) sites.
|
||||
|
|
@ -94,7 +94,7 @@ of each page. All three sites are hosted on [Netlify](https://netlify.com).
|
|||
|
||||
### How versioning works
|
||||
|
||||
* Documentation changes are primarily committed to the master branch of istio.github.io. Changes committed to this branch
|
||||
* 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
|
||||
|
|
@ -105,7 +105,7 @@ 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 istio.github.io and then merge that change into the
|
||||
to make the change in the master branch of istio.io and then merge that change into the
|
||||
current release branch.
|
||||
|
||||
### Publishing content immediately
|
||||
|
|
@ -122,7 +122,7 @@ version of Istio is 0.6 and you wish to introduce 0.7 which has been under devel
|
|||
|
||||
#### Creating the release branch
|
||||
|
||||
1. Switch to the istio/istio.github.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. 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.
|
||||
|
|
@ -134,7 +134,7 @@ and the `branch_name` field to the name of the branch, in this case release-0.7.
|
|||
|
||||
#### Updating preliminary.istio.io
|
||||
|
||||
1. Switch to the istio/istio.github.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. 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
|
||||
|
|
@ -160,7 +160,7 @@ of the next Istio release. In this case, you would set the fields to 0.8 and 0.8
|
|||
|
||||
#### Updating archive.istio.io
|
||||
|
||||
1. Switch to the istio/istio.github.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. Go to the [Google Custom Search Engine](https://cse.google.com) and do the following:
|
||||
|
||||
|
|
|
|||
|
|
@ -25,4 +25,4 @@ Tons of people are using Istio. Maybe you should too?
|
|||
{{< company_logo link="https://www.ibm.com/watson" logo="./watson.png" alt="IBM Watson" >}}
|
||||
</div>
|
||||
|
||||
Want your logo up there? Just submit a [pull request](https://github.com/istio/istio.github.io/pulls).
|
||||
Want your logo up there? Just submit a [pull request](https://github.com/istio/istio.io/pulls).
|
||||
|
|
|
|||
|
|
@ -30,4 +30,4 @@ Istio benefits from an ecosystem of great partners. Check 'em out and learn how
|
|||
{{< company_logo link="https://www.vmware.com" logo="./vmware.svg" alt="VMware" >}}
|
||||
</div>
|
||||
|
||||
Want your logo up there? Just submit a [pull request](https://github.com/istio/istio.github.io/pulls).
|
||||
Want your logo up there? Just submit a [pull request](https://github.com/istio/istio.io/pulls).
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ To work on Istio documentation, you need to:
|
|||
Agreement](https://github.com/istio/community/blob/master/CONTRIBUTING.md#contributor-license-agreements).
|
||||
|
||||
The documentation is published under the [Apache
|
||||
2.0](https://github.com/istio/istio.github.io/blob/master/LICENSE) license.
|
||||
2.0](https://github.com/istio/istio.io/blob/master/LICENSE) license.
|
||||
|
||||
## How to contribute
|
||||
|
||||
|
|
@ -44,7 +44,7 @@ There are two ways you can contribute to the Istio documentation:
|
|||
fork, and click **New Pull Request** to let us know about it.
|
||||
|
||||
<a class="btn btn-istio"
|
||||
href="https://github.com/istio/istio.github.io/">Browse this site's source
|
||||
href="https://github.com/istio/istio.io/">Browse this site's source
|
||||
code</a>
|
||||
|
||||
Once your changes are merged, they show up immediately on
|
||||
|
|
@ -61,5 +61,5 @@ pull request also use this staging site to make sure everything looks good.
|
|||
|
||||
If you created a fork of the repository, you can preview your changes locally.
|
||||
See this
|
||||
[README](https://github.com/istio/istio.github.io/blob/master/README.md) for
|
||||
[README](https://github.com/istio/istio.io/blob/master/README.md) for
|
||||
instructions.
|
||||
|
|
|
|||
|
|
@ -25,4 +25,4 @@ skip_seealso: true
|
|||
{{< company_logo link="https://www.ibm.com/watson" logo="/about/community/customers/watson.png" alt="IBM Watson" >}}
|
||||
</div>
|
||||
|
||||
想要您的 logo 也出现在这里吗？只需要提交一个 [pull request](https://github.com/istio/istio.github.io/pulls)。
|
||||
想要您的 logo 也出现在这里吗？只需要提交一个 [pull request](https://github.com/istio/istio.io/pulls)。
|
||||
|
|
|
|||
|
|
@ -30,4 +30,4 @@ Istio 受益强大的合作伙伴生态。了解下他们是如何使 Istio 变
|
|||
{{< company_logo link="https://www.vmware.com" logo="/about/community/partners/vmware.svg" alt="VMware" >}}
|
||||
</div>
|
||||
|
||||
想要您的 logo 也出现在这里吗？只需要提交一个 [pull request](https://github.com/istio/istio.github.io/pulls)。
|
||||
想要您的 logo 也出现在这里吗？只需要提交一个 [pull request](https://github.com/istio/istio.io/pulls)。
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ keywords: [贡献]
|
|||
|
||||
1. 签署[贡献者证书协议](https://github.com/istio/community/blob/master/CONTRIBUTING.md#contributor-license-agreements)。
|
||||
|
||||
该文档是在 [Apache 2.0](https://github.com/istio/istio.github.io/blob/master/LICENSE) 许可下发布的。
|
||||
该文档是在 [Apache 2.0](https://github.com/istio/istio.io/blob/master/LICENSE) 许可下发布的。
|
||||
|
||||
## 如何贡献
|
||||
|
||||
|
|
@ -23,7 +23,7 @@ keywords: [贡献]
|
|||
* 如果您希望修改网站源码，则必须创建存储库分支。单击下面的按钮以访问 GitHub 存储库。然后，您必须单击屏幕右上角的 **Fork** 按钮，在 GitHub 帐户中创建我们的存储库副本。创建 fork 的克隆并进行任何需要的更改。当您准备将这些更改发送给我们时，将更改推送到您的 fork，转到 fork 的索引页面，然后单击 **New Pull Request** 以告知我们。
|
||||
|
||||
<a class="btn btn-istio"
|
||||
href="https://github.com/istio/istio.github.io/">浏览该站点的源码</a>
|
||||
href="https://github.com/istio/istio.io/">浏览该站点的源码</a>
|
||||
|
||||
一旦您的更改被合并后，它们会立即显示在 [preliminary.istio.io](https://preliminary.istio.io/) 上。但是，这些更改只会在下次我们生成新版本时显示在 [istio.io](https://istio.io) 上，该版本每月发布一次。
|
||||
|
||||
|
|
@ -31,4 +31,4 @@ href="https://github.com/istio/istio.github.io/">浏览该站点的源码</a>
|
|||
|
||||
当您提交 pull request 时，GitHub 上的 PR 页面会显示一个链接，指向您的 PR 自动构建的临时站点。这有助于您查看面向最终用户的页面。审核您 pull request 的人也使用此临时站点，当一切看起来没有问题时才准许合并。
|
||||
|
||||
如果您创建了存储库的分支，则可以在本地预览更改。有关说明，请参阅 [README](https://github.com/istio/istio.github.io/blob/master/README.md)。
|
||||
如果您创建了存储库的分支，则可以在本地预览更改。有关说明，请参阅 [README](https://github.com/istio/istio.io/blob/master/README.md)。
|
||||
|
|
@ -58,10 +58,10 @@
|
|||
{{ if not .Site.Data.args.archive }}
|
||||
<div class="dropdown-divider"></div>
|
||||
|
||||
<a class="dropdown-item" href="https://github.com/istio/istio.github.io/issues/new?title=Issue%20with%20{{ .Path}}">{{ i18n "report_site_bugs" }}</a>
|
||||
<a class="dropdown-item" href="https://github.com/istio/istio.io/issues/new?title=Issue%20with%20{{ .Path}}">{{ i18n "report_site_bugs" }}</a>
|
||||
|
||||
{{ if not .Params.generator }}
|
||||
<a class="dropdown-item" href="https://github.com/istio/istio.github.io/edit/master/content/{{ .Path }}">{{ i18n "edit_on_github" }}</a>
|
||||
<a class="dropdown-item" href="https://github.com/istio/istio.io/edit/master/content/{{ .Path }}">{{ i18n "edit_on_github" }}</a>
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ check_content() {
|
|||
then
|
||||
# remove the tmp dir prefix from error messages
|
||||
sed s!${TMP}/!! ${OUT}
|
||||
echo "To learn how to address spelling errors, please see https://github.com/istio/istio.github.io#linting"
|
||||
echo "To learn how to address spelling errors, please see https://github.com/istio/istio.io#linting"
|
||||
FAILED=1
|
||||
fi
|
||||
|
||||
|
|
@ -75,7 +75,7 @@ then
|
|||
FAILED=1
|
||||
fi
|
||||
|
||||
htmlproofer ./public --assume-extension --check-html --check-external-hash --check-opengraph --timeframe 2d --storage-dir .htmlproofer --url-ignore "/localhost/,/github.com/istio/istio.github.io/edit/master/,/github.com/istio/istio/issues/new/choose/,/groups.google.com/forum/"
|
||||
htmlproofer ./public --assume-extension --check-html --check-external-hash --check-opengraph --timeframe 2d --storage-dir .htmlproofer --url-ignore "/localhost/,/github.com/istio/istio.io/edit/master/,/github.com/istio/istio/issues/new/choose/,/groups.google.com/forum/"
|
||||
if [ "$?" != "0" ]
|
||||
then
|
||||
FAILED=1
|
||||
|
|
|
|||
Loading…
Reference in New Issue