Address various nits

Signed-off-by: Hidde Beydals <hidde@hhh.computer>
pull/3254/head
Hidde Beydals 2 years ago committed by Stefan Prodan
parent 4e78e80619
commit 5abf1ee817
No known key found for this signature in database
GPG Key ID: 3299AEB0E4085BAF

@ -5,4 +5,4 @@
- [Flux distribution](flux.md)
- [Flux APIs and controllers](controllers.md)
- [Flux shared libraries](packages.md)
- [Flux release procedure](procedure.md)
- [Flux release procedures](procedure.md)

@ -1,4 +1,4 @@
# Flux controllers release spec
# Flux controller releases
The Flux controllers are
[Kubernetes operators](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/),
@ -13,7 +13,7 @@ Controller repositories and their interdependencies:
5. [image-reflector-controller](https://github.com/fluxcd/image-reflector-controller)
6. [image-automation-controller](https://github.com/fluxcd/image-automation-controller) (imports `fluxcd/source-controller/api` and `fluxcd/image-reflector-controller/api`)
## API versioning
## API versioning
The Flux APIs (Kubernetes CRDs) follow the
[Kubernetes API versioning](https://kubernetes.io/docs/reference/using-api/#api-versioning) scheme.
@ -44,7 +44,7 @@ The Custom Resources may require editing after a CRD update for which migration
provided as part of the controller changelog.
A beta version API becomes deprecated once a subsequent beta or stable API version is released.
A deprecated beta version is subject to removal after a six months period.
A deprecated beta version is subject to removal after a six-months period.
### Stable version
@ -148,4 +148,3 @@ Each controller release produces the following artifacts:
All the artifacts are cryptographically signed and can be verified with Cosign and GitHub OIDC.
The release artifacts can be accessed based on the controller name and version.

@ -1,4 +1,4 @@
# Flux release spec
# Flux releases
The Flux project repository [fluxcd/flux2](https://github.com/fluxcd/flux2) contains
the Flux command-line tool source code and the Kubernetes manifests for
@ -65,8 +65,8 @@ new feature or optimization ahead of schedule.
## Supported releases
For Flux the CLI and its controllers we support the last three minor releases.
Critical bug fixes such as security fixes, may be back-ported to those three minor
For Flux the CLI and its controllers, we support the last three minor releases.
Critical bug fixes, such as security fixes, may be back-ported to those three minor
versions as patch releases, depending on severity and feasibility.
Note that back-porting is provided by the community on a best-effort basis.
@ -139,4 +139,3 @@ The changelog contains the following information:
- A list of documentation additions
**Note** that the vulnerability disclosure procedure is explained on the [security page](https://fluxcd.io/security/).

@ -1,9 +1,9 @@
# Flux shared packages release spec
# Flux shared package releases
The Go packages in [github.com/fluxcd/pkg](https://github.com/fluxcd/pkg) are dedicated Go modules,
each module has its own set of dependencies and release cycle.
These packages are primary meant for internal use in Flux controllers and
These packages are primarily meant for internal use in Flux controllers and
for projects which integrate and/or extend Flux.
## Release versioning
@ -72,4 +72,3 @@ A deprecated package is marked as so in its `go.mod` e.g.
// Deprecated: use github.com/fluxcd/pkg/tar instead.
module github.com/fluxcd/pkg/untar
```

@ -1,4 +1,4 @@
# Release notes template
# Flux release note template
This is a template for release notes. It is intended to be used as a
starting point for writing release notes for a new release. It should be copied

Loading…
Cancel
Save