Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: move contribution out of version #3176

Merged
merged 6 commits into from
Apr 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Kubernetes-based application gateway.

* [Blog][blog] introducing Envoy Gateway.
* [Goals](GOALS.md)
* [Quickstart](https://gateway.envoyproxy.io/latest/user/quickstart/) to use Envoy Gateway in a few simple steps.
* [Roadmap](https://gateway.envoyproxy.io/latest/contributions/roadmap/)
* [Quickstart](https://gateway.envoyproxy.io/latest/tasks/quickstart/) to use Envoy Gateway in a few simple steps.
* [Roadmap](https://gateway.envoyproxy.io/contributions/roadmap/)

## Contact

Expand All @@ -22,9 +22,9 @@ Kubernetes-based application gateway.

## Contributing

* [Code of conduct](https://gateway.envoyproxy.io/latest/contributions/code_of_conduct/)
* [Contributing guide](https://gateway.envoyproxy.io/latest/contributions/contributing/)
* [Developer guide](https://gateway.envoyproxy.io/latest/contributions/develop/)
* [Code of conduct](/CODE_OF_CONDUCT)
* [Contributing guide](https://gateway.envoyproxy.io/contributions/contributing/)
* [Developer guide](https://gateway.envoyproxy.io/contributions/develop/)

## Community Meeting

Expand Down
4 changes: 2 additions & 2 deletions site/content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Envoy Gateway
<a class="btn btn-lg btn-primary me-3 mb-4" href="/v1.0.1">
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="/v1.0.1/contributions">
<a class="btn btn-lg btn-secondary me-3 mb-4" href="/contributions">
CONTRIBUTING <i class="fa fa-heartbeat ms-2 "></i>
</a>
<p class="lead mt-5">Manages Envoy Proxy as a Standalone or Kubernetes-based API Gateway</p>
Expand Down Expand Up @@ -66,7 +66,7 @@ Try Envoy Gateway in GitHub Releases
{{% /blocks/feature %}}

{{% blocks/feature icon="fab fa-github" title="Contributions Welcome!"
url="/latest/contributions/" %}}
url="/contributions/" %}}
We do a [Pull Request](https://github.com/envoyproxy/gateway/pulls)
contributions workflow on **GitHub**.
{{% /blocks/feature %}}
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/announcements/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,5 @@ In order to align with the Envoy Proxy [release schedule][], Envoy Gateway relea
| 0.6.0 | 2023/10/22 | 2023/11/02 | +10 days | 2024/05/02 |

[v2.0.0 spec]: https://semver.org/spec/v2.0.0.html
[release guide]: ../latest/contributions/releasing
[release guide]: ../contributions/releasing
[release schedule]: https://github.com/envoyproxy/envoy/blob/main/RELEASES.md#major-release-schedule
4 changes: 2 additions & 2 deletions site/content/en/blog/news/1.0-release/1.0-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ Following the 1.0 release, we’ll be focusing on:
* **Features**: More API Gateway features such as authorization (IP Addresses, JWT Claims, API Key, etc.) and compression
* **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](/v1.0.1/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
* **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.1/tasks/operations/egctl/)

## Get Started
If you’ve been looking to use Envoy as a Gateway, check out our [quickstart guide](/v1.0.1/tasks/quickstart) and give it a try! If you’re interested in contributing, check out our [guide for getting involved](/v1.0.1/contributions/)!
If you’ve been looking to use Envoy as a Gateway, check out our [quickstart guide](/v1.0.1/tasks/quickstart) and give it a try! If you’re interested in contributing, check out our [guide for getting involved](/contributions/)!
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ to the following guidelines for all code, APIs, and documentation:
build. If your PR cannot have 100% coverage for some reason please clearly explain why when you
open it.
* Any PR that changes user-facing behavior **must** have associated documentation in the [docs](https://github.com/envoyproxy/gateway/tree/main/site) folder of the repo as
well as the [changelog](../releases).
well as the [changelog](./RELEASING).
* All code comments and documentation are expected to have proper English grammar and punctuation.
If you are not a fluent English speaker (or a bad writer ;-)) please let us know and we will try
to find some help but there are no guarantees.
Expand Down Expand Up @@ -81,7 +81,7 @@ to the following guidelines for all code, APIs, and documentation:

## Maintainer PR Review Policy

* See [CODEOWNERS.md](../codeowners) for the current list of maintainers.
* See [CODEOWNERS.md](./codeowners) for the current list of maintainers.
* A maintainer representing a different affiliation from the PR owner is required to review and
approve the PR.
* When the project matures, it is expected that a "domain expert" for the code the PR touches should
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,6 @@ and is hosted in the repo.
[Envoy admin interface]: https://www.envoyproxy.io/docs/envoy/latest/operations/admin#operations-admin-interface
[jwt]: https://tools.ietf.org/html/rfc7519
[jwks]: https://tools.ietf.org/html/rfc7517
[request authentication]: ../tasks/security/jwt-authentication
[request authentication]: ../latest/tasks/security/jwt-authentication
[JWT Debugger]: https://jwt.io/
[JWK Creator]: https://russelldavies.github.io/jwk-creator/
8 changes: 8 additions & 0 deletions site/content/en/contributions/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
+++
title = "Get Involved"
description = "This section includes contents related to Contributions"
linktitle = "Get Involved"

[[cascade]]
type = "docs"
+++
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,6 @@ spec:
```

[Issue 31]: https://github.com/envoyproxy/gateway/issues/31
[EnvoyProxy]: ../../api/extension_types#envoyproxy
[EnvoyProxy]: ../../latest/api/extension_types#envoyproxy
[GatewayClass]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.GatewayClass
[parametersRef]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.ParametersReference
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,6 @@ Here is a list of features that can be included in this API
[Policy Attachment]: https://gateway-api.sigs.k8s.io/references/policy-attachment
[Gateway API]: https://gateway-api.sigs.k8s.io/
[Gateway API Route Filters]: https://gateway-api.sigs.k8s.io/api-types/httproute/#filters-optional
[Envoy Patch Policy]: ../../api/extension_types#envoypatchpolicy
[Envoy Patch Policy]: ../../latest/api/extension_types#envoypatchpolicy
[Envoy Extension Manager]: ./extending-envoy-gateway
[Alternatives]: #Alternatives
Original file line number Diff line number Diff line change
Expand Up @@ -167,10 +167,10 @@ patches will work.
[Gateway API]: https://gateway-api.sigs.k8s.io/
[Kubernetes]: https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/
[Kustomize]: https://github.com/kubernetes-sigs/kustomize/blob/master/examples/jsonpatch.md
[Extension APIs]: ../../api/extension_types/
[Extension APIs]: ../../latest/api/extension_types
[RateLimit]: ./rate-limit
[EnvoyGateway]: ../../api/extension_types#envoygateway
[EnvoyGateway]: ../../latest/api/extension_types#envoygateway
[Extending the Control Plane]: ./extending-envoy-gateway
[EnvoyFilter]: https://istio.io/latest/docs/reference/config/networking/envoy-filter
[egctl x translate]: ../../tasks/operations/egctl#egctl-experimental-translate
[Bootstrap configuration using EnvoyProxy API]: ../../tasks/operations/customize-envoyproxy#customize-envoyproxy-bootstrap-config
[egctl x translate]: ../../latest/tasks/operations/egctl#egctl-experimental-translate
[Bootstrap configuration using EnvoyProxy API]: ../../latest/tasks/operations/customize-envoyproxy#customize-envoyproxy-bootstrap-config
Original file line number Diff line number Diff line change
Expand Up @@ -316,10 +316,10 @@ Extending Envoy Gateway by using an external extension server which makes use of
[Envoy specific configuration (xDS)]: https://www.envoyproxy.io/docs/envoy/v1.25.1/configuration/configuration
[v1]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1
[rate limiting]: ./rate-limit
[authentication]: ../../tasks/security/jwt-authentication
[authentication]: ../../latest/tasks/security/jwt-authentication
[HTTPRoute]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRoute
[GRPCRoute]: https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1alpha2.GRPCRoute
[EnvoyGateway config]: ../../api/extension_types/#envoygateway
[EnvoyGateway config]: ../../latest/api/extension_types#envoygateway
[controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime
[Unstructured]: https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1/unstructured
[Listener]: https://www.envoyproxy.io/docs/envoy/v1.23.0/api-v3/config/listener/v3/listener.proto#config-listener-v3-listener
Expand Down
2 changes: 1 addition & 1 deletion site/content/en/latest/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ type = "docs"

{{% alert title="Note" color="primary" %}}

This project is under **active** development. Many features are not complete. We would love for you to [Get Involved](contributions/)!
This project is under **active** development. Many features are not complete. We would love for you to [Get Involved](/contributions)!

{{% /alert %}}

Expand Down
5 changes: 0 additions & 5 deletions site/content/en/latest/contributions/_index.md

This file was deleted.

Loading