diff --git a/README.md b/README.md
index 4bd9886..18dbb1f 100644
--- a/README.md
+++ b/README.md
@@ -79,9 +79,9 @@ The examples of Kubernetes providers, to which Kodjin has been installed already
- [K3D cluster provider for RMK](https://github.com/edenlabllc/k3d.provisioner.infra)
- [Helmfile hooks](https://github.com/edenlabllc/helmfile.hooks.infra)
-## Development
+## Development and release
-The guidelines are available at https://edenlabllc.github.io/rmk/latest/https://edenlabllc.github.io/rmk/latest/development-and-release-flows/
+The guidelines are available at https://edenlabllc.github.io/rmk/latest/development-and-release/
## License
diff --git a/docs/.pages b/docs/.pages
index 3964471..f39fa49 100644
--- a/docs/.pages
+++ b/docs/.pages
@@ -3,5 +3,5 @@ nav:
- quickstart.md
- Configuration and management: configuration
- Commands: commands.md
- - development-and-release-flows.md
+ - development-and-release.md
collapse: false
diff --git a/docs/commands.md b/docs/commands.md
index f448e77..2e29222 100644
--- a/docs/commands.md
+++ b/docs/commands.md
@@ -18,8 +18,8 @@ rmk
Command line tool for reduced management of the provision of Kubernetes clusters in different environments and management of service releases.
**BuiltBy:** goreleaser
-**Commit:** 0370089
-**Date:** 2024-09-03T16:41:40Z
+**Commit:** 7a0f199
+**Date:** 2024-09-04T07:46:16Z
**Target:** linux_amd64
**Usage**:
diff --git a/docs/development-and-release-flows.md b/docs/development-and-release.md
similarity index 88%
rename from docs/development-and-release-flows.md
rename to docs/development-and-release.md
index 30f9f09..e99f014 100644
--- a/docs/development-and-release-flows.md
+++ b/docs/development-and-release.md
@@ -1,11 +1,13 @@
-# Development and release flow
+# Development and release
-## Requirements for the availability of tools during development
+## Development
+
+### Requirements for the availability of tools during development
- **[Golang](https://tip.golang.org/doc/install)** = v1.21.X
- **[GoReleaser](https://goreleaser.com/install)** = v1.23.0
-## Building from source
+### Building from source
To build RMK from source, run the following [GoReleaser](https://goreleaser.com/) command from the root of the repository:
@@ -15,12 +17,12 @@ goreleaser build --snapshot --clean
> You can also use this command for recompilation of RMK during development.
-## Git workflow
+### Git workflow
In RMK development, we use the classic [GitFlow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) workflow,
embracing all its advantages and disadvantages.
-### Git branch naming conventions
+#### Git branch naming conventions
- `feature/RMK--`
- `release/`
@@ -32,7 +34,7 @@ For example:
- `release/v0.42.0`
- `hotfix/v0.42.1`
-## Release flow
+## Release
After accumulating a certain set of features in the develop branch,
a `release/` branch is created for the next release version.
diff --git a/docs/index.md b/docs/index.md
index cffb3a1..358930e 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -28,10 +28,10 @@ Command line tool for reduced management and provisioning of Kubernetes clusters
* [Release management](configuration/release-management/release-management.md)
* [Secrets management](configuration/secrets-management/secrets-management.md)
* [Commands](commands.md)
- * [Development and release flows](development-and-release-flows.md)
* [Features](#features)
* [Supported Kubernetes providers](#supported-kubernetes-providers)
* [Roadmap](#roadmap)
+ * [Development and release](development-and-release.md)
* [License](#license)
* [Code of Conduct](#code-of-conduct)
@@ -131,7 +131,7 @@ curl -sL "https://edenlabllc-rmk.s3.eu-north-1.amazonaws.com/rmk/s3-installer" |
Alternatively, you can go directly to https://github.com/edenlabllc/rmk/releases and download the binary.
-As another option, the binary can be [built from source](development-and-release-flows.md#building-from-source).
+As another option, the binary can be [built from source](development-and-release.md#building-from-source).
## Update
@@ -196,6 +196,10 @@ Among the providers are:
Check the [issues](https://github.com/edenlabllc/rmk/issues) for more information.
+## Development and release
+
+The guidelines are available at the [link](development-and-release.md).
+
## License
RMK is open source software (OSS) licensed under the [Apache 2.0 License](https://github.com/edenlabllc/rmk/blob/master/LICENSE).
diff --git a/docs/release-notes.md b/docs/release-notes.md
index d45832e..7feef1c 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -1,2 +1 @@
-- #27 - Configured GitHub Pages documentation generation using MkDocs Materials, mike.
-- #42 - Fixed markdown headers in rmk doc generate command.
+- #27 - Fixed development-and-release.md guides, links to them from README.md and index.md.