docs: Use 'latest' for package versions

open-pioneer · Jun 28, 2024 · c409926 · c409926
1 parent 6023177
commit c409926
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 12 deletions.
diff --git a/docs/tutorials/HowToCreateAPackage.md b/docs/tutorials/HowToCreateAPackage.md
@@ -107,8 +107,8 @@ In order to use the new package, it must be declared as a dependency in your app
     "name": "empty",
     "private": true,
     "peerDependencies": {
-        "@open-pioneer/runtime": "^1.0.0",
-        "@open-pioneer/chakra-integration": "^1.0.0",
+        "@open-pioneer/runtime": "latest",
+        "@open-pioneer/chakra-integration": "latest",
         // Add this line:
         "hello-world": "workspace:*"
     }

diff --git a/docs/tutorials/HowToCreateAService.md b/docs/tutorials/HowToCreateAService.md
@@ -81,7 +81,7 @@ The test-utils package contains helpers for testing service classes:
     "name": "math",
     "private": true,
     "devDependencies": {
-        "@open-pioneer/test-utils": "^1.0.0"
+        "@open-pioneer/test-utils": "latest"
     }
 }
 ```
@@ -139,8 +139,8 @@ First, add the package `math` in the app's `package.json`:
     "name": "empty",
     "private": true,
     "peerDependencies": {
-        "@open-pioneer/runtime": "^1.0.0",
-        "@open-pioneer/chakra-integration": "^1.0.0",
+        "@open-pioneer/runtime": "latest",
+        "@open-pioneer/chakra-integration": "latest",
         "math": "workspace:^"
     }
 }
@@ -244,7 +244,7 @@ Because we do not intend to export any classes, functions or constants, we'll ju
     "private": true,
     "main": "api.ts",
     "devDependencies": {
-        "@open-pioneer/test-utils": "^1.0.0"
+        "@open-pioneer/test-utils": "latest"
     }
 }
 ```
@@ -469,9 +469,9 @@ We want to use its logger implementation:
     "name": "empty",
     "private": true,
     "peerDependencies": {
-        "@open-pioneer/chakra-integration": "^1.0.0",
-        "@open-pioneer/core": "^1.0.0",
-        "@open-pioneer/runtime": "^1.0.0",
+        "@open-pioneer/chakra-integration": "latest",
+        "@open-pioneer/core": "latest",
+        "@open-pioneer/runtime": "latest",
         "math": "workspace:^"
     }
 }

diff --git a/docs/tutorials/HowToCreateAnApp.md b/docs/tutorials/HowToCreateAnApp.md
@@ -20,11 +20,15 @@ Create a very simple [`package.json`](https://docs.npmjs.com/cli/v9/configuring-
     "name": "my-app",
     "private": true,
     "dependencies": {
-        "@open-pioneer/runtime": "^1.0.0"
+        "@open-pioneer/runtime": "latest"
     }
 }
 ```
 
+> NOTE  
+> Dependencies in the preceding example snippet (and some other snippets in this documentation) use the version specifier `latest` to avoid being immediately outdated.
+> You should pick a recent version with the help of your IDE or the index at [npmjs.com](https://www.npmjs.com/), for example `"@open-pioneer/some-package": "^1.2.3"`.
+
 A `package.json` file should always contain at least a `name`, usually some `dependencies` and either `private: true` or a valid license (in case you intend to publish it).
 After creating a new package or modifying the dependencies of an existing package, you should run `pnpm install`:
 

diff --git a/docs/tutorials/HowToProvideAnAPI.md b/docs/tutorials/HowToProvideAnAPI.md
@@ -37,7 +37,7 @@ import { ApiExtension } from "@open-pioneer/integration";
 export class LogApiExtension implements ApiExtension {}
 ```
 
-Make sure to additionally add the `"@open-pioneer/integration": "^1.0.0"` dependency in the package.json, then run `pnpm install`.
+Make sure to additionally add the `"@open-pioneer/integration"` dependency in the package.json, then run `pnpm install`.
 
 Now you should see an error similar to "Property 'getApiMethods' is missing" on the class.
 This is because the interface requires that a function `getApiMethods` must exist.

diff --git a/docs/tutorials/HowToPublishAPackage.md b/docs/tutorials/HowToPublishAPackage.md
@@ -386,7 +386,7 @@ We have also been told to configure `publishConfig.directory`:
         "build": "build-pioneer-package"
     },
 +   "peerDependencies": {
-+       "@open-pioneer/core": "^1.0.0"
++       "@open-pioneer/core": "<omitted from example>"
 +   },
 +   "publishConfig": {
 +       "directory": "dist",
@@ -396,6 +396,7 @@ We have also been told to configure `publishConfig.directory`:
 ```
 
 Because the core package is a Trails package, we have added it as a `peerDependency` (see [Best Practices](../BestPractices.md#dependency-management)).
+
 We also added `linkDirectory: false`, see [Publishing](#publishing).
 
 #### Adding required files