Skip to content

Commit ed61200

Browse files
committed
Update warning based on feedback
1 parent 44d955b commit ed61200

2 files changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ This module sets up:
1111
- Service accounts with proper IAM permissions
1212

1313
> [!WARNING]
14-
> This module is intended to be used for demonstrations, simple evaluations, and as a template for building your own production deployment of Materialize.
14+
> This module is intended for demonstration/evaluation purposes as well as for serving as a template when building your own production deployment of Materialize.
1515
>
16-
> This module should not be relied upon for production deployments directly: future releases of the 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.
16+
> This module should not be directly relied upon for production deployments: **future releases of the module will contain breaking changes.** Instead, to use as a starting point for your own production deployment, either:
17+
> - Fork this repo and pin to a specific version, or
18+
> - Use the code as a reference when developing your own deployment.
1719
1820
The module has been tested with:
1921
- GKE version 1.28

docs/header.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@ This module sets up:
1010
- Service accounts with proper IAM permissions
1111

1212
> [!WARNING]
13-
> This module is intended to be used for demonstrations, simple evaluations, and as a template for building your own production deployment of Materialize.
13+
> This module is intended for demonstration/evaluation purposes as well as for serving as a template when building your own production deployment of Materialize.
1414
>
15-
> This module should not be relied upon for production deployments directly: future releases of the 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.
15+
> This module should not be directly relied upon for production deployments: **future releases of the module will contain breaking changes.** Instead, to use as a starting point for your own production deployment, either:
16+
> - Fork this repo and pin to a specific version, or
17+
> - Use the code as a reference when developing your own deployment.
1618
1719
The module has been tested with:
1820
- GKE version 1.28

0 commit comments

Comments
 (0)