Skip to content

Commit fd39bfd

Browse files
authored
Move release process doc and update READMEs (#1038)
* Move release process doc and update READMEs * Release feedback * Fix typos
1 parent 901b400 commit fd39bfd

File tree

4 files changed

+16
-2
lines changed

4 files changed

+16
-2
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,19 @@ to the correct versions:
5454
| 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). |
5555
| 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). |
5656

57+
### Versioning
58+
59+
NKG uses semantic versioning for its releases. For more information, see https://semver.org.
60+
61+
> Major version zero `(0.Y.Z)` is reserved for development, anything MAY change at any time. The public API is not stable.
62+
63+
### Release Planning and Development
64+
65+
The features that will go into the next release are reflected in the
66+
corresponding [milestone](https://github.com/nginxinc/nginx-kubernetes-gateway/milestones). Refer to
67+
the [Issue Lifecycle](ISSUE_LIFECYCLE.md) document for information on issue creation and assignment to releases.
68+
69+
5770
## Technical Specifications
5871

5972
The following table lists the software versions NGINX Kubernetes Gateway supports.

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ yourself.
1717
- [Running on Kind](running-on-kind.md): Walkthrough on how to run NGINX Kubernetes Gateway on a `kind` cluster.
1818
- [CLI Help](cli-help.md): Describes the commands available in the `gateway` binary of `nginx-kubernetes-gateway`
1919
container.
20+
- [Monitoring](monitoring.md): Information on monitoring NGINX Kubernetes Gateway using Prometheus metrics.
2021

2122
### Directories
2223

docs/developer/logging-guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ As NKG evolves, we might change the logging. For example:
405405
- Change the default key-value pairs and their representation.
406406

407407
Such changes should be considered a breaking change and handled according
408-
to our [release process](/docs/release-process.md) because they will require users to update their log processing
408+
to our [release process](/docs/developer/release-process.md) because they will require users to update their log processing
409409
pipelines.
410410

411411
At the same time, changes to individual log messages are not breaking changes.

docs/release-process.md renamed to docs/developer/release-process.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ NKG uses semantic versioning for its releases. For more information, see https:/
1212

1313
The features that will go into the next release are reflected in the
1414
corresponding [milestone](https://github.com/nginxinc/nginx-kubernetes-gateway/milestones). Refer to
15-
the [Issue Lifecycle](../ISSUE_LIFECYCLE.md) document for information on issues creation and assignment to releases.
15+
the [Issue Lifecycle](/ISSUE_LIFECYCLE.md) document for information on issue creation and assignment to releases.
1616

1717
## Releasing
1818

0 commit comments

Comments
 (0)