feature: version compatability matrix

equinor · Jan 20, 2023 · 72c267b · 72c267b
1 parent d9ba3f5
commit 72c267b
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 4 deletions.
diff --git a/docs/docs/guides/deployment-and-configuration.md b/docs/docs/guides/deployment-and-configuration.md
diff --git a/docs/docs/guides/version-compatability.md b/docs/docs/guides/version-compatability.md
@@ -0,0 +1,22 @@
+---
+title: Version compatability
+sidebar_position: 5
+---
+
+## Component version compatibility matrix
+
+The Development Framework has many different component, and not all versions of these
+are neccesarily compatible with one another.
+
+This table shows which versions of which component _are_ compatible. Expressed in semantic versioning.  
+For a description on the _semver_ syntax you could have a look at [this page](https://semver.npmjs.com).
+
+| `COMPONENT` | DMSS    | DM-Job  | @dm-core | react |
+|-------------|---------|-------- |----------|-------|
+|DM-Job       | >1.0.0  | -       |    -     |    -  |
+|@dm-core     |  >1.0.0 | >1.0.4  |    -     | ^17*  |
+|@form        |  -      | -       |   >1.0.29|    -  |
+|@blueprint   |  -      | -       |   >1.0.29|    -  |
+
+Cells marked with `-` indicate no hard relationship between the components.  
+Components prefixed with `@` are NPM pacakges under the `development-framework@` group.
diff --git a/yarn.lock b/yarn.lock
@@ -0,0 +1,4 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,4 @@
		# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
		# yarn lockfile v1