Add forward compatibility disclaimer to README#50
Conversation
| - Materialize Helm Operator Terraform Module v0.1.8 | ||
|
|
||
| > [!WARNING] | ||
| > This module is provided on a best-effort basis and Materialize cannot offer support for it. |
There was a problem hiding this comment.
I might nix this, I think we would support people trying to use it to a degree, like if the TF provider clearly had bugs
| > | ||
| > It is not guaranteed to be forward-compatible and may include breaking changes in future versions. | ||
| > | ||
| > The module is intended for demonstration and evaluation purposes only, not for production use. |
There was a problem hiding this comment.
I'd start with this disclaimer, and then segue into the above. I think we're also saying it has two different purposes here (evaluation only) and later (use as starting point for prod infra), and as a reader I'm not quite sure what the actual intent is
maybe something like this?
"This module is intended to be used for demonstrations, simple evaluations, and as a template for building your own production deployment of Materialize on AWS.
This module should not be relied upon for production deployments directly: future releases of those module will contain breaking changes. When used as a starting point for a production deployment, you must either fork this repo and pin to a specific version, or use the code as a reference when developing your own deployment."
There was a problem hiding this comment.
cc @kay-kim same feedback for the disclaimer we have in the docs as well. I'm finding our current messaging reads a little confused. Seth had a nice clear take in https://materializeinc.slack.com/archives/C085QFLB072/p1740503361409879?thread_ts=1740502884.282719&cid=C085QFLB072 that I think is a good reference
There was a problem hiding this comment.
Sounds good! I prepared PRs to update the wording:
MaterializeInc/terraform-google-materialize#31
MaterializeInc/terraform-azurerm-materialize#23
#51
3 participants
Similar to what we have in the official docs, adding a small compatibility disclaimer.