Merge pull request #8905 from fabriziopandini/fix-readme-inmemory-pro…

…vider 🌱 fix readme for in-memory provider
kubernetes-sigs · Jun 22, 2023 · 266685d · 266685d
2 parents 89a8866 + f13793d
commit 266685d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/test/README.md b/test/README.md
@@ -6,4 +6,4 @@ This package is not subject to deprecation notices or compatibility guarantees.
 
 - We iterate on the test framework quickly and frequently, and breaking changes are likely. External providers using this package should update to the latest API changes when updating Cluster API. Maintainers and contributors must give notice in release notes when a breaking change happens.
 
-- The docker provider, including its APIs, should only be used for development/testing purposes. Its API and code can change at any time without notice.
+- The docker and the in-memory providers, including their APIs, should only be used for development/testing purposes. APIs and code can change at any time without notice.
diff --git a/test/infrastructure/inmemory/README.md b/test/infrastructure/inmemory/README.md
@@ -1,3 +1,5 @@
 # Cluster API Provider In Memory (CAPIM)
 
-FIXME
+CAPIM is a implementation of an infrastructure provider for the Cluster API project using in memory, fake objects.
+
+**NOTE:** The In memory provider is **not** designed for production use and is intended for development environments only.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,4 @@ This package is not subject to deprecation notices or compatibility guarantees.

		- We iterate on the test framework quickly and frequently, and breaking changes are likely. External providers using this package should update to the latest API changes when updating Cluster API. Maintainers and contributors must give notice in release notes when a breaking change happens.

		- The docker provider, including its APIs, should only be used for development/testing purposes. Its API and code can change at any time without notice.
		- The docker and the in-memory providers, including their APIs, should only be used for development/testing purposes. APIs and code can change at any time without notice.