From 8bc86aee79c7ce21b07d2ac239c7a7400546b7e9 Mon Sep 17 00:00:00 2001 From: Rob Scott Date: Wed, 13 Oct 2021 10:41:04 -0700 Subject: [PATCH] Updating docs for v1alpha2 --- README.md | 11 +++----- mkdocs.yml | 30 ++++++++++----------- site-src/index.md | 4 --- site-src/v1alpha2/guides/getting-started.md | 7 ++--- site-src/v1alpha2/guides/tls.md | 4 --- 5 files changed, 21 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 214006935a..b49e4bbc59 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,12 @@ The Gateway API is a part of the [SIG Network][sn], and this repository contains the specification and Custom Resource Definitions (CRDs). -*Note: This project was previously named "Service APIs" until being renamed to -"Gateway API" in February 2021.* - ## Status -The latest supported version is v1alpha1 as released by the [v0.3.0 -release](https://github.com/kubernetes-sigs/gateway-api/releases/tag/v0.3.0) of -this project. A second alpha API version, v1alpha2, is under active development, -but this is considered unstable and has not been released yet. +The latest supported version is v1alpha2 as released by the [v0.4.0 +release](https://github.com/kubernetes-sigs/gateway-api/releases/tag/v0.4.0) of +this project. This version of the API is expected to graduate to beta in the +future with relatively minimal changes. ## Documentation diff --git a/mkdocs.yml b/mkdocs.yml index 3379e3bda6..192fc67f07 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -34,6 +34,14 @@ nav: Implementation Guidelines: concepts/guidelines.md - Implementations: implementations.md - Guides: + - v1alpha2: + - Getting started: v1alpha2/guides/getting-started.md + - Simple Gateway: v1alpha2/guides/simple-gateway.md + - HTTP routing: v1alpha2/guides/http-routing.md + - HTTP traffic splitting: v1alpha2/guides/traffic-splitting.md + - Cross-Namespace routing: v1alpha2/guides/multiple-ns.md + - TLS: v1alpha2/guides/tls.md + - TCP routing: v1alpha2/guides/tcp.md - v1alpha1: - Getting started: v1alpha1/guides/getting-started.md - Simple Gateway: v1alpha1/guides/simple-gateway.md @@ -42,22 +50,8 @@ nav: - Cross-Namespace routing: v1alpha1/guides/multiple-ns.md - TLS: v1alpha1/guides/tls.md - TCP routing: v1alpha1/guides/tcp.md - - v1alpha2(unreleased): - - Getting started: v1alpha2/guides/getting-started.md - - Simple Gateway: v1alpha2/guides/simple-gateway.md - - HTTP routing: v1alpha2/guides/http-routing.md - - HTTP traffic splitting: v1alpha2/guides/traffic-splitting.md - - Cross-Namespace routing: v1alpha2/guides/multiple-ns.md - - TLS: v1alpha2/guides/tls.md - - TCP routing: v1alpha2/guides/tcp.md - Reference: - - v1alpha1: - - API Types: - GatewayClass: v1alpha1/api-types/gatewayclass.md - Gateway: v1alpha1/api-types/gateway.md - HTTPRoute: v1alpha1/api-types/httproute.md - - API specification: v1alpha1/references/spec.md - - v1alpha2(unreleased): + - v1alpha2: - API Types: GatewayClass: v1alpha2/api-types/gatewayclass.md Gateway: v1alpha2/api-types/gateway.md @@ -65,6 +59,12 @@ nav: - API specification: v1alpha2/references/spec.md - Cross Namespace References: v1alpha2/references/cross-namespace-references.md - Policy Attachment: v1alpha2/references/policy-attachment.md + - v1alpha1: + - API Types: + GatewayClass: v1alpha1/api-types/gatewayclass.md + Gateway: v1alpha1/api-types/gateway.md + HTTPRoute: v1alpha1/api-types/httproute.md + - API specification: v1alpha1/references/spec.md - Release policy: references/releases.md - Contributing: - Developer guide: contributing/devguide.md diff --git a/site-src/index.md b/site-src/index.md index ddacf895b6..a7077bb03b 100644 --- a/site-src/index.md +++ b/site-src/index.md @@ -12,10 +12,6 @@ many vendors and have broad industry support. ![Gateway API Model](./images/api-model.png) - -!!! warning - Gateway API is preparing to release v1alpha2, which is a large change, and - some documents on this site are out of date. Please pardon our dust for now. ## Getting started Whether you are a user interested in using the Gateway API or an implementer diff --git a/site-src/v1alpha2/guides/getting-started.md b/site-src/v1alpha2/guides/getting-started.md index 24855dbdc7..77aed1f1b8 100644 --- a/site-src/v1alpha2/guides/getting-started.md +++ b/site-src/v1alpha2/guides/getting-started.md @@ -1,8 +1,5 @@ # Getting started with Gateway APIs -!!! danger - This page and some of its sub-pages are not fully updated for v1alpha2 yet. - **1.** **[Install a Gateway controller](#installing-a-gateway-controller)** _OR_ **[install the Gateway API CRDs manually](#installing-gateway-api-crds-manually)** @@ -36,7 +33,7 @@ these resources. Installing the CRDs will just allow you to see and apply the resources, though they won't do anything. ``` -kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd?ref=v0.4.0-rc1" \ +kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd?ref=v0.4.0" \ | kubectl apply -f - ``` @@ -50,7 +47,7 @@ these resources. ``` -kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd?ref=v0.4.0-rc1" \ +kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd?ref=v0.4.0" \ | kubectl delete -f - ``` diff --git a/site-src/v1alpha2/guides/tls.md b/site-src/v1alpha2/guides/tls.md index dbd6e9c2fc..685a74db26 100644 --- a/site-src/v1alpha2/guides/tls.md +++ b/site-src/v1alpha2/guides/tls.md @@ -1,9 +1,5 @@ # TLS Configuration -!!! danger - This page has not been updated for v1alpha2 yet. - - Gateway API allow for a variety of ways to configure TLS. This document lays out various TLS settings and gives general guidelines on how to use them effectively.