Skip to content
This repository was archived by the owner on May 30, 2024. It is now read-only.

Commit 0a6d568

Browse files
Updates outdated Docs site URLs (#23)
* Updates URLs * Update index.d.ts Co-authored-by: ember-stevens <79482775+ember-stevens@users.noreply.github.com> * Removes anchor from URL Co-authored-by: Eli Bishop <eli@launchdarkly.com> Co-authored-by: Eli Bishop <eli@launchdarkly.com>
1 parent 8acace3 commit 0a6d568

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# Contributing to this library
22

3-
The source code for this library is [here](https://github.com/launchdarkly/node-server-sdk-dynamodb). We encourage pull-requests and other contributions from the community. Since this library is meant to be used in conjunction with the LaunchDarkly Server-Side Node.js SDK, you may want to look at the [SDK source code](https://github.com/launchdarkly/node-server-sdk) and our [SDK contributor's guide](http://docs.launchdarkly.com/docs/sdk-contributors-guide).
3+
The source code for this library is [here](https://github.com/launchdarkly/node-server-sdk-dynamodb). We encourage pull-requests and other contributions from the community. Since this library is meant to be used in conjunction with the LaunchDarkly Server-Side Node.js SDK, you may want to look at the [SDK source code](https://github.com/launchdarkly/node-server-sdk) and our [SDK contributor's guide](https://docs.launchdarkly.com/sdk/concepts/contributors-guide).
44

55
## Submitting bug reports and feature requests
6-
6+
77
The LaunchDarkly SDK team monitors the [issue tracker](https://github.com/launchdarkly/node-server-sdk-dynamodb/issues) in this repository. Bug reports and feature requests specific to this project should be filed in the issue tracker. The SDK team will respond to all newly filed issues within two business days.
8-
8+
99
## Submitting pull requests
10-
10+
1111
We encourage pull requests and other contributions from the community. Before submitting pull requests, ensure that all temporary or unintended code is removed. Don't worry about adding reviewers to the pull request; the LaunchDarkly SDK team will add themselves. The SDK team will acknowledge all pull requests within two business days.
12-
12+
1313
## Build instructions
14-
14+
1515
### Prerequisites
1616

1717
The project uses `npm`, which is bundled in all supported versions of Node. It should be built against the lowest compatible version, Node 12.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This library provides a DynamoDB-backed persistence mechanism (feature store) fo
66

77
The minimum version of the LaunchDarkly Node.js SDK for use with this library is 6.2.0.
88

9-
For more information, see the [SDK features guide](https://docs.launchdarkly.com/sdk/features/database-integrations).
9+
For more information, read the [SDK features guide](https://docs.launchdarkly.com/sdk/features/storing-data).
1010

1111
TypeScript API documentation is [here](https://launchdarkly.github.io/node-server-sdk-dynamodb).
1212

@@ -67,7 +67,7 @@ To reduce traffic to DynamoDB, there is an optional in-memory cache that retains
6767
* Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
6868
* Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
6969
* Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
70-
* LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Check out [our documentation](https://docs.launchdarkly.com/docs) for a complete list.
70+
* LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Check out [our documentation](https://docs.launchdarkly.com/sdk) for a complete list.
7171
* Explore LaunchDarkly
7272
* [launchdarkly.com](https://www.launchdarkly.com/ "LaunchDarkly Main Website") for more information
7373
* [docs.launchdarkly.com](https://docs.launchdarkly.com/ "LaunchDarkly Documentation") for our documentation and SDK reference guides

index.d.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/**
44
* Interface for the DynamoDB feature store component to be used with the LaunchDarkly SDK.
55
*
6-
* See: https://docs.launchdarkly.com/sdk/features/database-integrations
6+
* See: https://docs.launchdarkly.com/sdk/concepts/data-stores
77
*/
88

99
declare module 'launchdarkly-node-server-sdk-dynamodb' {
@@ -13,7 +13,7 @@ declare module 'launchdarkly-node-server-sdk-dynamodb' {
1313

1414
/**
1515
* Create a feature flag store backed by DynamoDB.
16-
*
16+
*
1717
* @param tableName The table name in DynamoDB (required). The table must already exist.
1818
* See: https://docs.launchdarkly.com/sdk/features/storing-data/dynamodb
1919
* @param options Additional options for configuring the DynamoDB store's behavior.
@@ -25,9 +25,9 @@ declare module 'launchdarkly-node-server-sdk-dynamodb' {
2525

2626
/**
2727
* Configures a big segment store backed by a Redis instance.
28-
*
28+
*
2929
* "Big segments" are a specific type of user segments. For more information, read the
30-
* LaunchDarkly documentation about user segments: https://docs.launchdarkly.com/home/users
30+
* LaunchDarkly documentation about user segments: https://docs.launchdarkly.com/home/users/big-segments
3131
*
3232
* @param tableName The table name in DynamoDB (required). The table must already exist.
3333
* See: https://docs.launchdarkly.com/sdk/features/storing-data/dynamodb
@@ -57,18 +57,18 @@ declare module 'launchdarkly-node-server-sdk-dynamodb' {
5757
/**
5858
* An optional namespace prefix for all keys stored in DynamoDB. Use this if you are sharing
5959
* the same database table between multiple clients that are for different LaunchDarkly
60-
* environments, to avoid key collisions.
60+
* environments, to avoid key collisions.
6161
*/
6262
prefix?: string;
6363

6464
/**
6565
* The amount of time, in seconds, that recently read or updated items should remain in an
6666
* in-memory cache. If it is zero, there will be no in-memory caching.
67-
*
67+
*
6868
* This parameter applies only to [[DynamoDBFeatureStore]]. It is ignored for [[DynamoDBBigSegmentStore]].
6969
* Caching for [[DynamoDBBigSegmentStore]] is configured separately, in the SDK's
7070
* `LDBigSegmentsOptions` type, since it is independent of what database implementation is used.
71-
*
71+
*
7272
* If omitted, the default value is 15 seconds.
7373
*/
7474
cacheTTL?: number;

0 commit comments

Comments
 (0)