Skip to content

Commit

Permalink
docs: use v[x.y] instead of v[x.y.z] (#3836)
Browse files Browse the repository at this point in the history
* docs: use vx.y instead of vx.y.z

Signed-off-by: zirain <zirain2009@gmail.com>

* fix deadlink

Signed-off-by: zirain <zirain2009@gmail.com>

---------

Signed-off-by: zirain <zirain2009@gmail.com>
  • Loading branch information
zirain authored Jul 13, 2024
1 parent 762eb42 commit 467bf9d
Show file tree
Hide file tree
Showing 294 changed files with 29 additions and 28 deletions.
2 changes: 1 addition & 1 deletion site/content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Envoy Gateway
---

{{< blocks/cover title="Welcome to Envoy Gateway!" image_anchor="top" height="full" >}}
<a class="btn btn-lg btn-primary me-3 mb-4" href="/v1.0.2">
<a class="btn btn-lg btn-primary me-3 mb-4" href="/docs">
GET STARTED <i class="fas fa-arrow-alt-circle-right ms-2"></i>
</a>
<a class="btn btn-lg btn-secondary me-3 mb-4" href="/contributions">
Expand Down
14 changes: 7 additions & 7 deletions site/content/en/news/blogs/1.0-release/1.0-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ Today we’re ecstatic to announce the 1.0 release of Envoy Gateway (EG) for Kub
After nearly two years with contributions from over 90 engineers we are proud to say EG meets the goals that Matt outlined in the [original post](https://blog.envoyproxy.io/introducing-envoy-gateway-ad385cc59532) introducing the project, summarized here:
* Built around the (then emerging) [Kubernetes Gateway API](https://gateway-api.sigs.k8s.io)
* Addresses common needs with a solution that is simple to configure and understand
* Provides [great docs](/v1.0.2/tasks/) for common use cases to enable ease of adoption
* Provides [great docs](/v1.0/tasks/) for common use cases to enable ease of adoption
* Empowers the community and vendors to drive the project forward through an extensible API

Can’t wait to try it? Visit the EG [tasks](/v1.0.2/tasks/) to get started with Envoy Gateway 1.0
Can’t wait to try it? Visit the EG [tasks](/v1.0/tasks/) to get started with Envoy Gateway 1.0

## Envoy Gateway 1.0

The 1.0 release brings a lot of functionality. In addition to implementing the full Kubernetes Gateway API – including the awesome Envoy L7 features you love like per-request policy, load balancing, and best-in-class observability – it also goes further, Envoy Gateway 1.0:
* Provides support for common features such as Rate Limiting and OAuth2.0
* Deploys and upgrades Envoy on your behalf, easing operations and lifecycle management
* Introduces extensions to the Kubernetes Gateway API to address [Client](/v1.0.2/api/extension_types#clienttrafficpolicy), [Backend](/v1.0.2/api/extension_types#backendtrafficpolicy), and [Security](/v1.0.2/api/extension_types#securitypolicy) settings and features
* Is easily extensible through the [EnvoyPatchPolicy](/v1.0.2/tasks/extensibility/envoy-patch-policy/) API to allow you to configure any Envoy behavior (including stuff you build yourself!)
* Has a CLI, [egctl](/v1.0.2/tasks/operations/egctl/), for interacting with and debugging the system
* Introduces extensions to the Kubernetes Gateway API to address [Client](/v1.0/api/extension_types#clienttrafficpolicy), [Backend](/v1.0/api/extension_types#backendtrafficpolicy), and [Security](/v1.0/api/extension_types#securitypolicy) settings and features
* Is easily extensible through the [EnvoyPatchPolicy](/v1.0/tasks/extensibility/envoy-patch-policy/) API to allow you to configure any Envoy behavior (including stuff you build yourself!)
* Has a CLI, [egctl](/v1.0/tasks/operations/egctl/), for interacting with and debugging the system
* Comes with a large (and growing!) set of scenarios to make common use cases straightforward to implement

## What Does 1.0 Mean for the Project?
Expand Down Expand Up @@ -59,7 +59,7 @@ Following the 1.0 release, we’ll be focusing on:
* **Scale**: Building out a performance benchmarking tool into our CI
* **Extensibility**: We plan on providing a first-class API for data plane extensions such as Lua, Wasm, and Ext Proc to enable users to implement their custom use cases
* **Outside of Kubernetes**: Running Envoy Gateway in non-k8s environments - this has been an [explicit goal](/contributions/design/goals#all-environments) and we’d like to focus on this in the coming months. Envoy Proxy already supports running on bare metal environments, with Envoy Gateway users getting the added advantage of a simpler API
* **Debug**: And a lot of capabilities with the [egctl CLI](/v1.0.2/tasks/operations/egctl/)
* **Debug**: And a lot of capabilities with the [egctl CLI](/v1.0/tasks/operations/egctl/)

## Get Started
If you’ve been looking to use Envoy as a Gateway, check out our [quickstart guide](/v1.0.2/tasks/quickstart) and give it a try! If you’re interested in contributing, check out our [guide for getting involved](/contributions/)!
If you’ve been looking to use Envoy as a Gateway, check out our [quickstart guide](/v1.0/tasks/quickstart) and give it a try! If you’re interested in contributing, check out our [guide for getting involved](/contributions/)!
2 changes: 1 addition & 1 deletion site/content/en/news/releases/v0.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ release and future direction of the project.
[docs]: https://gateway.envoyproxy.io/index.html
[Download]: https://github.com/envoyproxy/gateway/releases/tag/v0.2.0
[conformance tests]: https://gateway-api.sigs.k8s.io/concepts/conformance/?h=conformance
[quickstart guide]: ../v0.2.0/user/quickstart
[quickstart guide]: ../v0.2/user/quickstart
[EnvoyCon NA]: https://events.linuxfoundation.org/envoycon-north-america/program/schedule/
[our talk]: https://sched.co/1AO5S
2 changes: 1 addition & 1 deletion site/content/en/news/releases/v1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,5 +196,5 @@ The release adds a ton of features and functionality. Here are some highlights:

[Release Notes]: ./notes/v1.0.0
[matrix]: ./matrix
[docs]: /v1.0.2/
[docs]: /v1.0/
[Download]: https://github.com/envoyproxy/gateway/releases/tag/v1.0.0
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion site/content/zh/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Envoy Gateway
---

{{< blocks/cover title="欢迎访问 Envoy Gateway!" image_anchor="top" height="full" >}}
<a class="btn btn-lg btn-primary me-3 mb-4" href="/v1.0.2">
<a class="btn btn-lg btn-primary me-3 mb-4" href="/docs">
开始使用 <i class="fas fa-arrow-alt-circle-right ms-2"></i>
</a>
<a class="btn btn-lg btn-secondary me-3 mb-4" href="/contributions">
Expand Down
22 changes: 11 additions & 11 deletions site/hugo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -278,25 +278,25 @@ enable = true
url = "/latest"

[[params.versions]]
version = "v1.0.2"
version = "v1.0"
url = "/docs"

[[params.versions]]
version = "v0.6.0"
url = "/v0.6.0"
version = "v0.6"
url = "/v0.6"

[[params.versions]]
version = "v0.5.0"
url = "/v0.5.0"
version = "v0.5"
url = "/v0.5"

[[params.versions]]
version = "v0.4.0"
url = "/v0.4.0"
version = "v0.4"
url = "/v0.4"

[[params.versions]]
version = "v0.3.0"
url = "/v0.3.0"
version = "v0.3"
url = "/v0.3"

[[params.versions]]
version = "v0.2.0"
url = "/v0.2.0"
version = "v0.2"
url = "/v0.2"
13 changes: 7 additions & 6 deletions tools/make/docs.mk
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
DOCS_OUTPUT_DIR := site/public
RELEASE_VERSIONS ?= $(foreach v,$(wildcard ${ROOT_DIR}/docs/*),$(notdir ${v}))
LINKINATOR_IGNORE := "github.com githubusercontent.com example.com github.io _print v0.6.0 v0.5.0 v0.4.0 v0.3.0 v0.2.0"
LINKINATOR_IGNORE := "github.com githubusercontent.com example.com github.io _print v0.6 v0.5 v0.4 v0.3 v0.2"
CLEAN_NODE_MODULES ?= true

##@ Docs
Expand All @@ -15,7 +15,7 @@ docs: docs.clean helm-readme-gen docs-api copy-current-release-docs ## Generate
.PHONY: copy-current-release-docs
copy-current-release-docs: ## Copy the current release docs to the docs folder
@$(LOG_TARGET)
@CURRENT_RELEASE=$(shell ls $(ROOT_DIR)/site/content/en | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+$$' | sort | tail -n 1); \
@CURRENT_RELEASE=$(shell ls $(ROOT_DIR)/site/content/en | grep -E '^v[0-9]+\.[0-9]+$$' | sort | tail -n 1); \
echo "Copying the current release $$CURRENT_RELEASE docs to the docs folder"; \
rm -rf $(ROOT_DIR)/site/content/en/docs; \
mkdir -p $(ROOT_DIR)/site/content/en/docs; \
Expand Down Expand Up @@ -101,8 +101,9 @@ docs-release-prepare:
.PHONY: docs-release-gen
docs-release-gen:
@$(LOG_TARGET)
@$(call log, "Added Release Doc: site/content/en/$(TAG)")
cp -r site/content/en/latest site/content/en/$(TAG)
$(eval DOC_VERSION := $(shell cat VERSION | cut -d "." -f 1,2))
@$(call log, "Added Release Doc: site/content/en/$(DOC_VERSION)")
cp -r site/content/en/latest/ site/content/en/$(DOC_VERSION)/
@for DOC in $(shell ls site/content/en/latest/user); do \
cp site/content/en/$(TAG)/user/$$DOC $(OUTPUT_DIR)/$$DOC ; \
cat $(OUTPUT_DIR)/$$DOC | sed "s;v0.0.0-latest;$(TAG);g" | sed "s;latest;$(TAG);g" > $(OUTPUT_DIR)/$(TAG)-$$DOC ; \
Expand All @@ -111,8 +112,8 @@ docs-release-gen:
done

@echo '[[params.versions]]' >> site/hugo.toml
@echo ' version = "$(TAG)"' >> site/hugo.toml
@echo ' url = "/$(TAG)"' >> site/hugo.toml
@echo ' version = "$(DOC_VERSION)"' >> site/hugo.toml
@echo ' url = "/$(DOC_VERSION)"' >> site/hugo.toml

.PHONY: docs-check-links
docs-check-links:
Expand Down

0 comments on commit 467bf9d

Please sign in to comment.