From 19ea80fe7ca2c84971dc889756b2a540919e099a Mon Sep 17 00:00:00 2001 From: Thomas Varney Date: Tue, 25 Feb 2025 12:34:52 -0500 Subject: [PATCH 1/6] Add link to ref docs in Dev server README --- internal/dev_server/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/internal/dev_server/README.md b/internal/dev_server/README.md index 4466b8ae..d15016da 100644 --- a/internal/dev_server/README.md +++ b/internal/dev_server/README.md @@ -2,3 +2,6 @@ The dev server is a go server that ldcli can run. It provides a local-only version of all the APIs that support LaunchDarkly SDKs. You can use it to serve flags to local and ephemeral environments. It copies flag _values_ for a project from a source environment and serves those. There are also APIs that let you override those values so that you can enable a feature just in your dev environment, e.g. The build of the dev server is incorporated into the ldcli build itself. The UI provided by the dev server has a [manual build](./ui/README.md). + +## Reference Docs +For assistance starting with or running dev-server, refer to the [reference docs](https://launchdarkly.com/docs/guides/flags/ldcli-dev-server). From 65948cb95674d31f49cdfd1cdfd07acd71c34235 Mon Sep 17 00:00:00 2001 From: Thomas Varney Date: Tue, 25 Feb 2025 14:10:35 -0500 Subject: [PATCH 2/6] move into main readme --- README.md | 5 +++++ internal/dev_server/README.md | 5 +---- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2f0547d2..cf6df92b 100644 --- a/README.md +++ b/README.md @@ -146,3 +146,8 @@ LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) (Supply [ghrelease-badge]: https://img.shields.io/github/release/launchdarkly/ldcli.svg [ghrelease-link]: https://github.com/launchdarkly/ldcli/releases/latest + +## Dev Server + +For assistance starting with or running dev-server, refer to the [reference docs](https://launchdarkly.com/docs/guides/flags/ldcli-dev-server). + diff --git a/internal/dev_server/README.md b/internal/dev_server/README.md index d15016da..c181dd24 100644 --- a/internal/dev_server/README.md +++ b/internal/dev_server/README.md @@ -1,7 +1,4 @@ # dev server The dev server is a go server that ldcli can run. It provides a local-only version of all the APIs that support LaunchDarkly SDKs. You can use it to serve flags to local and ephemeral environments. It copies flag _values_ for a project from a source environment and serves those. There are also APIs that let you override those values so that you can enable a feature just in your dev environment, e.g. -The build of the dev server is incorporated into the ldcli build itself. The UI provided by the dev server has a [manual build](./ui/README.md). - -## Reference Docs -For assistance starting with or running dev-server, refer to the [reference docs](https://launchdarkly.com/docs/guides/flags/ldcli-dev-server). +The build of the dev server is incorporated into the ldcli build itself. The UI provided by the dev server has a [manual build](./ui/README.md). \ No newline at end of file From ea0e8a32916ead4984eff93e0d1d712c97a88ae4 Mon Sep 17 00:00:00 2001 From: Thomas Varney Date: Tue, 25 Feb 2025 14:12:40 -0500 Subject: [PATCH 3/6] newline --- internal/dev_server/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/dev_server/README.md b/internal/dev_server/README.md index c181dd24..4466b8ae 100644 --- a/internal/dev_server/README.md +++ b/internal/dev_server/README.md @@ -1,4 +1,4 @@ # dev server The dev server is a go server that ldcli can run. It provides a local-only version of all the APIs that support LaunchDarkly SDKs. You can use it to serve flags to local and ephemeral environments. It copies flag _values_ for a project from a source environment and serves those. There are also APIs that let you override those values so that you can enable a feature just in your dev environment, e.g. -The build of the dev server is incorporated into the ldcli build itself. The UI provided by the dev server has a [manual build](./ui/README.md). \ No newline at end of file +The build of the dev server is incorporated into the ldcli build itself. The UI provided by the dev server has a [manual build](./ui/README.md). From 8b30faad1fbec9441af062c31fed7c1b75917403 Mon Sep 17 00:00:00 2001 From: Thomas Varney Date: Tue, 25 Feb 2025 14:14:10 -0500 Subject: [PATCH 4/6] copy blurb from ref docs --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index cf6df92b..46977b3c 100644 --- a/README.md +++ b/README.md @@ -149,5 +149,7 @@ LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) (Supply ## Dev Server +LaunchDarkly provides a command line interface (CLI), which includes a `dev-server` command that you can use to start a local server and retrieve flag values from a LaunchDarkly source environment. This development server supports a single variation value for each flag, which you can override as needed. This means you can test your code locally, and you do not need to coordinate with other developers in your organization who are using the same LaunchDarkly source environment. + For assistance starting with or running dev-server, refer to the [reference docs](https://launchdarkly.com/docs/guides/flags/ldcli-dev-server). From d7cf9f8c71e6028a18cd7ceff8a0bf3699f7f664 Mon Sep 17 00:00:00 2001 From: Thomas Varney Date: Tue, 25 Feb 2025 14:15:35 -0500 Subject: [PATCH 5/6] remove extra whitespace --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 46977b3c..53b5a596 100644 --- a/README.md +++ b/README.md @@ -152,4 +152,3 @@ LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) (Supply LaunchDarkly provides a command line interface (CLI), which includes a `dev-server` command that you can use to start a local server and retrieve flag values from a LaunchDarkly source environment. This development server supports a single variation value for each flag, which you can override as needed. This means you can test your code locally, and you do not need to coordinate with other developers in your organization who are using the same LaunchDarkly source environment. For assistance starting with or running dev-server, refer to the [reference docs](https://launchdarkly.com/docs/guides/flags/ldcli-dev-server). - From ddd1ea372ce65e4955a1e9b1172a1c174df78e11 Mon Sep 17 00:00:00 2001 From: Thomas Varney Date: Tue, 25 Feb 2025 14:21:45 -0500 Subject: [PATCH 6/6] migrate text, pare down words --- README.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/README.md b/README.md index 53b5a596..516af1ea 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,7 @@ Running this command creates a configuration file located at `$XDG_CONFIG_HOME/l LaunchDarkly CLI commands: - `setup` guides you through creating your first flag, connecting an SDK, and evaluating your flag in your Test environment +- `dev-server` lets you start a local server and retrieve flag values from a LaunchDarkly source environment so you can test your code locally. For assistance starting with or running dev-server, refer to the [reference docs](https://launchdarkly.com/docs/guides/flags/ldcli-dev-server). ### Resource Commands @@ -146,9 +147,3 @@ LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) (Supply [ghrelease-badge]: https://img.shields.io/github/release/launchdarkly/ldcli.svg [ghrelease-link]: https://github.com/launchdarkly/ldcli/releases/latest - -## Dev Server - -LaunchDarkly provides a command line interface (CLI), which includes a `dev-server` command that you can use to start a local server and retrieve flag values from a LaunchDarkly source environment. This development server supports a single variation value for each flag, which you can override as needed. This means you can test your code locally, and you do not need to coordinate with other developers in your organization who are using the same LaunchDarkly source environment. - -For assistance starting with or running dev-server, refer to the [reference docs](https://launchdarkly.com/docs/guides/flags/ldcli-dev-server).