From 32432911b57629871abf089cc69a9dac1e84879a Mon Sep 17 00:00:00 2001 From: Darius Harrison Date: Fri, 9 Jun 2023 16:03:05 -0500 Subject: [PATCH 1/2] Fix readme links for Akamai projects, add package name and version to doc command --- README.md | 4 ++-- packages/sdk/akamai-base/README.md | 2 +- packages/sdk/akamai-base/package.json | 2 +- packages/sdk/akamai-edgekv/README.md | 2 +- packages/sdk/akamai-edgekv/package.json | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7913bbed3b..348f1a2e64 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ We encourage pull requests and other contributions from the community. Check out [sdk-akamai-base-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/akamai-server-base-sdk.svg?style=flat-square [sdk-akamai-base-npm-link]: https://www.npmjs.com/package/@launchdarkly/akamai-server-base-sdk [sdk-akamai-base-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8 -[sdk-akamai-base-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/akamai/docs/ +[sdk-akamai-base-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/akamai-base/docs/ [sdk-akamai-base-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/akamai-server-base-sdk.svg?style=flat-square [sdk-akamai-base-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/akamai-server-base-sdk.svg?style=flat-square [package-sdk-akamai-base-issues]: https://github.com/launchdarkly/js-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+sdk%2Fakamai-base%22+ @@ -115,7 +115,7 @@ We encourage pull requests and other contributions from the community. Check out [sdk-akamai-edgekv-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/akamai-server-edgekv-sdk.svg?style=flat-square [sdk-akamai-edgekv-npm-link]: https://www.npmjs.com/package/@launchdarkly/akamai-server-edgekv-sdk [sdk-akamai-edgekv-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8 -[sdk-akamai-edgekv-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/akamai/docs/ +[sdk-akamai-edgekv-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/akamai-edgekv/docs/ [sdk-akamai-edgekv-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/akamai-server-edgekv-sdk.svg?style=flat-square [sdk-akamai-edgekv-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/akamai-server-edgekv-sdk.svg?style=flat-square [package-sdk-akamai-edgekv-issues]: https://github.com/launchdarkly/js-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+sdk%2Fakamai-edgekv%22+ diff --git a/packages/sdk/akamai-base/README.md b/packages/sdk/akamai-base/README.md index a5489b13ce..84316f8613 100644 --- a/packages/sdk/akamai-base/README.md +++ b/packages/sdk/akamai-base/README.md @@ -52,7 +52,7 @@ yarn test [sdk-akamai-base-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/akamai-server-base-sdk.svg?style=flat-square [sdk-akamai-base-npm-link]: https://www.npmjs.com/package/@launchdarkly/akamai-server-base-sdk [sdk-akamai-base-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8 -[sdk-akamai-base-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/akamai/docs/ +[sdk-akamai-base-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/akamai-base/docs/ [sdk-akamai-base-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/akamai-server-base-sdk.svg?style=flat-square [sdk-akamai-base-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/akamai-server-base-sdk.svg?style=flat-square [package-sdk-akamai-base-issues]: https://github.com/launchdarkly/js-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+sdk%2Fakamai-base%22+ \ No newline at end of file diff --git a/packages/sdk/akamai-base/package.json b/packages/sdk/akamai-base/package.json index 430c4656ca..fceaa0bfe4 100644 --- a/packages/sdk/akamai-base/package.json +++ b/packages/sdk/akamai-base/package.json @@ -25,7 +25,7 @@ "dist" ], "scripts": { - "doc": "npx typedoc --entryPointStrategy resolve src/index.ts", + "doc": "npx typedoc --name \"Akamai LaunchDarkly EdgeWorker SDK ${npm_package_version}\" --readme none --entryPointStrategy resolve src/index.ts", "build": "rollup -c rollup.config.js", "clean": "rimraf dist", "tsw": "yarn tsc --watch", diff --git a/packages/sdk/akamai-edgekv/README.md b/packages/sdk/akamai-edgekv/README.md index 02c9451325..9fb33ebca0 100644 --- a/packages/sdk/akamai-edgekv/README.md +++ b/packages/sdk/akamai-edgekv/README.md @@ -52,7 +52,7 @@ yarn test [sdk-akamai-edgekv-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/akamai-server-edgekv-sdk.svg?style=flat-square [sdk-akamai-edgekv-npm-link]: https://www.npmjs.com/package/@launchdarkly/akamai-server-edgekv-sdk [sdk-akamai-edgekv-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8 -[sdk-akamai-edgekv-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/akamai/docs/ +[sdk-akamai-edgekv-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/akamai-edgekv/docs/ [sdk-akamai-edgekv-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/akamai-server-edgekv-sdk.svg?style=flat-square [sdk-akamai-edgekv-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/akamai-server-edgekv-sdk.svg?style=flat-square [package-sdk-akamai-edgekv-issues]: https://github.com/launchdarkly/js-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+sdk%2Fakamai-edgekv%22+ \ No newline at end of file diff --git a/packages/sdk/akamai-edgekv/package.json b/packages/sdk/akamai-edgekv/package.json index 501eb16ad5..28a4632de7 100644 --- a/packages/sdk/akamai-edgekv/package.json +++ b/packages/sdk/akamai-edgekv/package.json @@ -26,7 +26,7 @@ "dist" ], "scripts": { - "doc": "npx typedoc --entryPointStrategy resolve src/index.ts", + "doc": "npx typedoc --name \"Akamai LaunchDarkly EdgeWorker SDK for EdgeKV feature store ${npm_package_version}\" --readme none --entryPointStrategy resolve src/index.ts", "build": "rollup -c rollup.config.js", "clean": "rimraf dist", "tsw": "yarn tsc --watch", From aec32ac0f8a38730232c827fbb62739057ebe3d4 Mon Sep 17 00:00:00 2001 From: Darius Harrison Date: Fri, 9 Jun 2023 16:54:45 -0500 Subject: [PATCH 2/2] Update doc command to use doc-name script --- packages/sdk/akamai-base/package.json | 2 +- packages/sdk/akamai-edgekv/package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/sdk/akamai-base/package.json b/packages/sdk/akamai-base/package.json index fceaa0bfe4..955d2d2eed 100644 --- a/packages/sdk/akamai-base/package.json +++ b/packages/sdk/akamai-base/package.json @@ -25,7 +25,7 @@ "dist" ], "scripts": { - "doc": "npx typedoc --name \"Akamai LaunchDarkly EdgeWorker SDK ${npm_package_version}\" --readme none --entryPointStrategy resolve src/index.ts", + "doc": "npx typedoc --name \"$(../../../scripts/doc-name.sh .)\" --readme none --entryPointStrategy resolve src/index.ts", "build": "rollup -c rollup.config.js", "clean": "rimraf dist", "tsw": "yarn tsc --watch", diff --git a/packages/sdk/akamai-edgekv/package.json b/packages/sdk/akamai-edgekv/package.json index 28a4632de7..e51f13c34c 100644 --- a/packages/sdk/akamai-edgekv/package.json +++ b/packages/sdk/akamai-edgekv/package.json @@ -26,7 +26,7 @@ "dist" ], "scripts": { - "doc": "npx typedoc --name \"Akamai LaunchDarkly EdgeWorker SDK for EdgeKV feature store ${npm_package_version}\" --readme none --entryPointStrategy resolve src/index.ts", + "doc": "npx typedoc --name \"$(../../../scripts/doc-name.sh .)\" --readme none --entryPointStrategy resolve src/index.ts", "build": "rollup -c rollup.config.js", "clean": "rimraf dist", "tsw": "yarn tsc --watch",