From 108200c4d0b17a804f869700b8b21824114fede3 Mon Sep 17 00:00:00 2001 From: Oscar Hinton Date: Thu, 12 Dec 2024 18:36:43 +0100 Subject: [PATCH] [PM-13377] Update links to sm sdk (#497) --- docs/architecture/mobile-clients/android/index.md | 2 +- docs/architecture/mobile-clients/ios/index.md | 2 +- docs/architecture/sdk/index.md | 10 ++++------ docs/architecture/sdk/versioning.md | 8 +++++--- docs/getting-started/sdk/secrets-manager/index.mdx | 4 ++-- .../sdk/secrets-manager/integrations/kubernetes.mdx | 2 +- 6 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/architecture/mobile-clients/android/index.md b/docs/architecture/mobile-clients/android/index.md index eac72e2bd..ce272f895 100644 --- a/docs/architecture/mobile-clients/android/index.md +++ b/docs/architecture/mobile-clients/android/index.md @@ -59,7 +59,7 @@ The lowest level of the data layer are the "data source" classes. These are the that include data persisted in [Room](https://developer.android.com/jetpack/androidx/releases/room) / [SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences), data retrieved from network requests using [Retrofit](https://github.com/square/retrofit), and data -retrieved via interactions with the [Bitwarden SDK](https://github.com/bitwarden/sdk). +retrieved via interactions with the [Bitwarden SDK](https://github.com/bitwarden/sdk-internal). Note that these data sources are constructed in a manner that adheres to a very important principle of the app: **that function calls should not throw exceptions** (see the diff --git a/docs/architecture/mobile-clients/ios/index.md b/docs/architecture/mobile-clients/ios/index.md index a5c89012f..46c3b31cd 100644 --- a/docs/architecture/mobile-clients/ios/index.md +++ b/docs/architecture/mobile-clients/ios/index.md @@ -60,7 +60,7 @@ data sources as well as higher-level "repository" and "service" classes. The lowest level of the core layer are the data model objects. These are the raw sources of data that include data retrieved or sent via network requests, data persisted with [CoreData](https://developer.apple.com/documentation/coredata/), and data that is used to interact -with the [Bitwarden SDK](https://github.com/bitwarden/sdk). +with the [Bitwarden SDK](https://github.com/bitwarden/sdk-internal). The models are roughly organized based on their use and type: diff --git a/docs/architecture/sdk/index.md b/docs/architecture/sdk/index.md index ea2779caa..674cc5db7 100644 --- a/docs/architecture/sdk/index.md +++ b/docs/architecture/sdk/index.md @@ -17,9 +17,9 @@ internal private items. ## Architecture -The Bitwarden SDK is structured as a single [Git repository](https://github.com/bitwarden/sdk) with -multiple internal crates. Please review the `README` in the repository for up to date information -about the different crates. +The Bitwarden SDK is structured as a single +[Git repository](https://github.com/bitwarden/sdk-internal) with multiple internal crates. Please +review the `README` in the repository for up to date information about the different crates. We generally strive towards extracting features into separate crates to keep the `bitwarden-core` crate as lean as possible. This has multiple benefits such as faster compile-time and clear @@ -98,9 +98,7 @@ WebAssembly module that can be used in JavaScript / TypeScript. To ensure compat browsers that do not support WebAssembly, we also generate a JavaScript module from the WebAssembly that can be used as a fallback. -The WebAssembly module is published on [npm](https://www.npmjs.com/package/@bitwarden/sdk-wasm) and -prerelease builds are published on -[GitHub Packages](https://github.com/bitwarden/sdk/pkgs/npm/sdk-wasm). +The WebAssembly module is published on [npm](https://www.npmjs.com/package/@bitwarden/sdk-internal). ### C bindings diff --git a/docs/architecture/sdk/versioning.md b/docs/architecture/sdk/versioning.md index 7c10bf8bc..e9ee0bc78 100644 --- a/docs/architecture/sdk/versioning.md +++ b/docs/architecture/sdk/versioning.md @@ -10,7 +10,9 @@ There may be certain functionality that is actively being developed and is not y cases, they should be marked as such and gated behind a `unstable` feature flag. Consuming client applications should avoid merging changes that depend on these features into `main`. -To track breaking changes, we use a [changelog file in the `bitwarden` crate][changelog]. This file -should be updated with noteworthy changes for each PR. +## Public APIs -[changelog]: https://github.com/bitwarden/sdk/blob/main/crates/bitwarden/CHANGELOG.md +To track breaking changes to the public APIs for Secrets Manager, we use a [changelog file in the +`bitwarden` crate][changelog]. This file should be updated with noteworthy changes. + +[changelog]: https://github.com/bitwarden/sdk-sm/blob/main/crates/bitwarden/CHANGELOG.md diff --git a/docs/getting-started/sdk/secrets-manager/index.mdx b/docs/getting-started/sdk/secrets-manager/index.mdx index bfe3a3ccd..910a7ec0b 100644 --- a/docs/getting-started/sdk/secrets-manager/index.mdx +++ b/docs/getting-started/sdk/secrets-manager/index.mdx @@ -4,7 +4,7 @@ This section contains development information for the Bitwarden Secrets Manager wrappers, and integrations based on the SDK. For more in-depth documentation please review the [SDK Architecture](../../../architecture/sdk), -Secrets Manager SDK project's [`README`](https://github.com/bitwarden/sdk). +Secrets Manager SDK project's [`README`](https://github.com/bitwarden/sdk-sm). ## Requirements @@ -19,7 +19,7 @@ See the [Tools and Libraries](../../tools/index.md) page for more information. 1. Clone the repository: ```bash - git clone https://github.com/bitwarden/sdk.git + git clone https://github.com/bitwarden/sdk-sm.git cd sdk ``` diff --git a/docs/getting-started/sdk/secrets-manager/integrations/kubernetes.mdx b/docs/getting-started/sdk/secrets-manager/integrations/kubernetes.mdx index ce6da26c6..b2402b6a9 100644 --- a/docs/getting-started/sdk/secrets-manager/integrations/kubernetes.mdx +++ b/docs/getting-started/sdk/secrets-manager/integrations/kubernetes.mdx @@ -220,7 +220,7 @@ the map settings available: - **bwSecretId**: This is the UUID of the secret in Secrets Manager. This can found under the secret name in the Secrets Manager web portal or by using the - [Bitwarden Secrets Manager CLI](https://github.com/bitwarden/sdk/releases). + [Bitwarden Secrets Manager CLI](https://github.com/bitwarden/sdk-sm/releases). - **secretKeyName**: The resulting key inside the Kubernetes secret that replaces the UUID Note that the custom mapping is made available on the generated secret for informational purposes in