From 6b1672b25a0e181f411cdddb7563617a07636776 Mon Sep 17 00:00:00 2001 From: Ciara Stacke Date: Wed, 6 Sep 2023 14:06:58 +0100 Subject: [PATCH 1/3] Move release process doc and update READMEs --- README.md | 13 +++++++++++++ docs/README.md | 1 + docs/{ => developer}/release-process.md | 0 3 files changed, 14 insertions(+) rename docs/{ => developer}/release-process.md (100%) diff --git a/README.md b/README.md index 9ea05d074e..6c63693518 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,19 @@ to the correct versions: | Latest release | For experimental use | Use the 0.6.0 image from [GitHub](https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway) | [Manifests](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.6.0/deploy). | [Documentation](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.6.0/docs). [Examples](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.6.0/examples). | | Edge | For experimental use and latest features | Use the edge image from [GitHub](https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway) | [Manifests](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/main/deploy). | [Documentation](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/main/docs). [Examples](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/main/examples). | +### Versioning + +NKG uses semantic versioning for its releases. For more information, see https://semver.org. + +> Major version zero `(0.Y.Z)` is reserved for development, anything MAY change at any time. The public API is not stable. + +### Release Planning and Development + +The features that will go into the next release are reflected in the +corresponding [milestone](https://github.com/nginxinc/nginx-kubernetes-gateway/milestones). Refer to +the [Issue Lifecycle](../ISSUE_LIFECYCLE.md) document for information on issues creation and assignment to releases. + + ## Technical Specifications The following table lists the software versions NGINX Kubernetes Gateway supports. diff --git a/docs/README.md b/docs/README.md index ae6a47efd7..117b03b833 100644 --- a/docs/README.md +++ b/docs/README.md @@ -17,6 +17,7 @@ yourself. - [Running on Kind](running-on-kind.md): Walkthrough on how to run NGINX Kubernetes Gateway on a `kind` cluster. - [CLI Help](cli-help.md): Describes the commands available in the `gateway` binary of `nginx-kubernetes-gateway` container. +- [Monitoring](monitoring.md): Information on monitoring NGINX Kubernetes Gateway using Prometheus metrics. ### Directories diff --git a/docs/release-process.md b/docs/developer/release-process.md similarity index 100% rename from docs/release-process.md rename to docs/developer/release-process.md From 2af66d6ccc8d2d434fd616242aa6970efe6cecf7 Mon Sep 17 00:00:00 2001 From: Ciara Stacke Date: Thu, 7 Sep 2023 17:16:31 +0100 Subject: [PATCH 2/3] Release feedback --- README.md | 2 +- docs/developer/logging-guidelines.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6c63693518..e0f36bf480 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ NKG uses semantic versioning for its releases. For more information, see https:/ The features that will go into the next release are reflected in the corresponding [milestone](https://github.com/nginxinc/nginx-kubernetes-gateway/milestones). Refer to -the [Issue Lifecycle](../ISSUE_LIFECYCLE.md) document for information on issues creation and assignment to releases. +the [Issue Lifecycle](ISSUE_LIFECYCLE.md) document for information on issues creation and assignment to releases. ## Technical Specifications diff --git a/docs/developer/logging-guidelines.md b/docs/developer/logging-guidelines.md index 78500eaa7f..10f3208e62 100644 --- a/docs/developer/logging-guidelines.md +++ b/docs/developer/logging-guidelines.md @@ -405,7 +405,7 @@ As NKG evolves, we might change the logging. For example: - Change the default key-value pairs and their representation. Such changes should be considered a breaking change and handled according -to our [release process](/docs/release-process.md) because they will require users to update their log processing +to our [release process](/docs/developer/release-process.md) because they will require users to update their log processing pipelines. At the same time, changes to individual log messages are not breaking changes. From 7e3c4689819dd959deb38c64f6f09bb8a95c21a9 Mon Sep 17 00:00:00 2001 From: Ciara Stacke Date: Fri, 8 Sep 2023 09:25:35 +0100 Subject: [PATCH 3/3] Fix typos --- README.md | 2 +- docs/developer/release-process.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e0f36bf480..ea18a1f0ba 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ NKG uses semantic versioning for its releases. For more information, see https:/ The features that will go into the next release are reflected in the corresponding [milestone](https://github.com/nginxinc/nginx-kubernetes-gateway/milestones). Refer to -the [Issue Lifecycle](ISSUE_LIFECYCLE.md) document for information on issues creation and assignment to releases. +the [Issue Lifecycle](ISSUE_LIFECYCLE.md) document for information on issue creation and assignment to releases. ## Technical Specifications diff --git a/docs/developer/release-process.md b/docs/developer/release-process.md index 20a46b6e18..5aa411ede3 100644 --- a/docs/developer/release-process.md +++ b/docs/developer/release-process.md @@ -12,7 +12,7 @@ NKG uses semantic versioning for its releases. For more information, see https:/ The features that will go into the next release are reflected in the corresponding [milestone](https://github.com/nginxinc/nginx-kubernetes-gateway/milestones). Refer to -the [Issue Lifecycle](../ISSUE_LIFECYCLE.md) document for information on issues creation and assignment to releases. +the [Issue Lifecycle](/ISSUE_LIFECYCLE.md) document for information on issue creation and assignment to releases. ## Releasing