Skip to content

Commit

Permalink
[rfc] Guide-level explanation: Documentation and Communication
Browse files Browse the repository at this point in the history
  • Loading branch information
didierofrivia committed Jan 15, 2024
1 parent 34ec8f4 commit a7cd956
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions rfcs/0000-kuadrant-release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,25 @@ component. The following table shows the different registries used by each compo
| | kuadrant-operator-catalog images | [Quay.io](https://quay.io/repository/kuadrant/kuadrant-operator-catalog) |
| | kuadrant-operator manifests | [OperatorHub.io](https://operatorhub.io/operator/kuadrant-operator) |

## Documentation

The documentation for the Kuadrant suite is compiled and available on the [Kuadrant website](https://kuadrant.io/). One
can find the source of the documentation within each component repository, in the `docs` directory. It's important to
note that keeping the documentation up to date is a responsibility of the component maintainers, and it needs to be
done before releasing a new version of the component. The importance of keeping a clear and up-to-date documentation
is crucial for the success of the project.

## Communication

Another important aspect of releasing a new version of the Kuadrant suite is the communication with the community and
other teams within the organization. A few examples of the communication channels that need to be updated are:

- Changelog generation
- Release notes
- Slack channel, in Red Hat and Kubernetes workspaces
- Blog post, if applicable
- Social media, if applicable

# Reference-level explanation
[reference-level-explanation]: #reference-level-explanation

Expand Down

0 comments on commit a7cd956

Please sign in to comment.