opensource/flux2
1
0
Fork 0
mirror of https://github.com/fluxcd/flux2.git synced 2025-11-04 03:46:24 +08:00
Code Issues Packages Projects Releases Wiki Activity

Address various nits

Browse Source 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
This commit is contained in:
Hidde Beydals
2023-06-29 19:00:19 +02:00
committed by Stefan Prodan
parent 4e78e80619
commit 5abf1ee817
5 changed files with 10 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/release/README.md
View File

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

5
docs/release/controllers.md
View File

@ -1,4 +1,4 @@
# Flux controllers release spec # Flux controller releases
The Flux controllers are The Flux controllers are
[Kubernetes operators](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/), [Kubernetes operators](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/),
@ -44,7 +44,7 @@ The Custom Resources may require editing after a CRD update for which migration
provided as part of the controller changelog. provided as part of the controller changelog.
A beta version API becomes deprecated once a subsequent beta or stable API version is released. 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 ### 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. 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. The release artifacts can be accessed based on the controller name and version.

7
docs/release/flux.md
View File

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

5
docs/release/packages.md
View File

@ -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, 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. 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. for projects which integrate and/or extend Flux.
## Release versioning ## 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. // Deprecated: use github.com/fluxcd/pkg/tar instead.
module github.com/fluxcd/pkg/untar module github.com/fluxcd/pkg/untar
``` ```

2
docs/release/release-notes-template.md
View File

@ -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 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 starting point for writing release notes for a new release. It should be copied