Update doc publishing script and add readme files.

kinyoklion · kinyoklion · commit 3050f01c7674 · 2023-05-09T09:46:26.000-07:00
diff --git a/README.md b/README.md
@@ -1,6 +1,80 @@
-# cpp-client-sdk
+# LaunchDarkly monorepo for C++ SDKs.
 
-This is a research SDK to determine if creating a pure C++ SDK is
-feasible.
+This repository contains LaunchDarkly SDK packages which are written in C++.
+This includes shared libraries, used by SDKs and other tools, as well as SDKs.
 
-It is 100% not supported in any way. In fact, it doesn't even exist at the moment.
+## Packages
+
+| SDK packages                                          | issues                                      | tests                                                   |
+|-------------------------------------------------------|---------------------------------------------|---------------------------------------------------------|
+| [libs/client-sdk](packages/sdk/server-node/README.md) | [C++ Client SDK][package-cpp-client-issues] | [![Actions Status][cpp-client-ci-badge]][cpp-client-ci] |
+
+| Shared packages                                              | issues                                            | tests                                                                 |
+|--------------------------------------------------------------|---------------------------------------------------|-----------------------------------------------------------------------|
+| [libs/common](libs/common/README.md)                         | [Common][package-shared-common-issues]            | [![Actions Status][shared-common-ci-badge]][shared-common-ci]         |
+| [libs/server-sent-events](libs/server-sent-events/README.md) | [Common Server][package-shared-sdk-server-issues] | [![Actions Status][shared-sse-ci-badge-badge]][shared-sdk-server-ci] |
+
+## Organization
+
+[TODO]
+
+## LaunchDarkly overview
+
+[LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves over 100 billion feature flags
+daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/home/getting-started)
+using LaunchDarkly today!
+
+[![Twitter Follow](https://img.shields.io/twitter/follow/launchdarkly.svg?style=social&label=Follow&maxAge=2592000)](https://twitter.com/intent/follow?screen_name=launchdarkly)
+
+## Testing
+
+We run integration tests for all our SDKs using a centralized test harness. This approach gives us the ability to test
+for consistency across SDKs, as well as test networking behavior in a long-running application. These tests cover each
+method in the SDK, and verify that event sending, flag evaluation, stream reconnection, and other aspects of the SDK all
+behave correctly.
+
+## Contributing
+
+We encourage pull requests and other contributions from the community. Check out
+our [contributing guidelines](CONTRIBUTING.md) for instructions on how to contribute to this SDK.
+
+## About LaunchDarkly
+
+- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to
+  iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard.
+  With LaunchDarkly, you can:
+    - Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group),
+      gathering feedback and bug reports from real-world use cases.
+    - 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?).
+    - 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.
+    - 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.
+- 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.
+- Explore LaunchDarkly
+    - [launchdarkly.com](https://www.launchdarkly.com/ 'LaunchDarkly Main Website') for more information
+    - [docs.launchdarkly.com](https://docs.launchdarkly.com/ 'LaunchDarkly Documentation') for our documentation and SDK
+      reference guides
+    - [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API
+      documentation
+    - [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product
+      updates
+
+[//]: # 'libs/common'
+[shared-common-ci-badge]: https://github.com/launchdarkly/cpp-sdks/actions/workflows/common.yml/badge.svg
+[shared-common-ci]: https://github.com/launchdarkly/cpp-sdks/actions/workflows/common.yml
+[package-shared-common-issues]: https://github.com/launchdarkly/cpp-sdks/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+shared%2Fcommon%22+
+
+[//]: # 'libs/server-sent-events'
+[shared-sse-ci-badge-badge]: https://github.com/launchdarkly/cpp-sdks/actions/workflows/sse.yml/badge.svg
+[shared-sdk-server-ci]: https://github.com/launchdarkly/jcpp-sdks/actions/workflows/sse.yml
+[package-shared-sdk-server-issues]: https://github.com/launchdarkly/cpp-sdks/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+shared%2Fsse%22+
+
+
+[//]: # 'libs/client-sdk'
+[cpp-client-ci-badge]: https://github.com/launchdarkly/cpp-sdks/actions/workflows/client.yml/badge.svg
+[cpp-client-ci]: https://github.com/launchdarkly/cpp-sdks/actions/workflows/client.yml
+[package-cpp-client-issues]: https://github.com/launchdarkly/cpp-sdks/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+sdk%2Fclient%22+
diff --git a/libs/client-sdk/README.md b/libs/client-sdk/README.md
@@ -0,0 +1,52 @@
+LaunchDarkly Client-Side SDK for C/C++
+===================================
+
+[![Actions Status](https://github.com/launchdarkly/cpp-sdks/actions/workflows/client.yml/badge.svg)](https://github.com/launchdarkly/cpp-sdks/actions/workflows/client.yml)
+
+The LaunchDarkly Client-Side SDK for C/C++ is designed primarily for use in desktop and embedded systems applications. It follows the client-side LaunchDarkly model for single-user contexts (much like our mobile or JavaScript SDKs). It is not intended for use in multi-user systems such as web servers and applications.
+
+LaunchDarkly overview
+-------------------------
+[LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves over 100 billion feature flags daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/docs/getting-started) using LaunchDarkly today!
+
+[![Twitter Follow](https://img.shields.io/twitter/follow/launchdarkly.svg?style=social&label=Follow&maxAge=2592000)](https://twitter.com/intent/follow?screen_name=launchdarkly)
+
+Compatibility
+-------------------------
+
+This version of the LaunchDarkly SDK is compatible with POSIX environments (Linux, OS X, BSD) and Windows.
+
+Getting started
+---------------
+
+Download a release archive from the [TODO](TODO) for use in your project. Refer to the [SDK documentation](TODO) for complete instructions on installing and using the SDK.
+
+Learn more
+-----------
+
+Check out our [documentation](https://docs.launchdarkly.com) for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the [complete reference guide for this SDK](TODO).
+
+Testing
+-------
+
+We run integration tests for all our SDKs using a centralized test harness. This approach gives us the ability to test for consistency across SDKs, as well as test networking behavior in a long-running application. These tests cover each method in the SDK, and verify that event sending, flag evaluation, stream reconnection, and other aspects of the SDK all behave correctly.
+
+Contributing
+------------
+
+We encourage pull requests and other contributions from the community. Check out our [contributing guidelines](../../CONTRIBUTING.md) for instructions on how to contribute to this SDK.
+
+About LaunchDarkly
+-----------
+
+* LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard.  With LaunchDarkly, you can:
+    * Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
+    * 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?).
+    * 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.
+    * 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.
+* 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.
+* Explore LaunchDarkly
+    * [launchdarkly.com](https://www.launchdarkly.com/ "LaunchDarkly Main Website") for more information
+    * [docs.launchdarkly.com](https://docs.launchdarkly.com/  "LaunchDarkly Documentation") for our documentation and SDK reference guides
+    * [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/  "LaunchDarkly API Documentation") for our API documentation
+    * [blog.launchdarkly.com](https://blog.launchdarkly.com/  "LaunchDarkly Blog Documentation") for the latest product updates
diff --git a/libs/client-sdk/docs/doc.md b/libs/client-sdk/docs/doc.md
diff --git a/libs/common/README.md b/libs/common/README.md
@@ -0,0 +1,5 @@
+# C++ SDK Common
+
+Contains code which is suitable for both client-side and server-side C++ SDKs.
+
+This project is not intended to be directly used in applications, instead a specific client-side or server-side SDK package should be used.
diff --git a/libs/server-sent-events/README.md b/libs/server-sent-events/README.md
@@ -0,0 +1,3 @@
+# C++ Server Sent Events
+
+This library provides an event source client implementation for use in client-side and server-side LaunchDarkly SDKs.
diff --git a/scripts/publish-doc.sh b/scripts/publish-doc.sh
@@ -1,4 +1,4 @@
-# Run this script like:
+./sc# Run this script like:
 # ./scripts/build-doc.sh libs/client-sdk
 
 set -e
@@ -8,6 +8,8 @@ set -x
 script_path=$(readlink -f "$0")
 base_name=$(dirname $script_path)
 
+WORKSPACE="$1"
+
 # Move the built docs so switching branches doesn't conflict.
 mv $WORKSPACE/docs $RUNNER_TEMP/doc-temp
 
@@ -42,7 +44,7 @@ mv $RUNNER_TEMP/doc-temp/* $WORKSPACE/docs
 mkdir -p $WORKSPACE
 git add $WORKSPACE/docs
 
-git commit -m "chore: Updating docs for $0"
+git commit -m "chore: Updating docs for $1"
 
 # Update the local copy in case there have been any interim changes.
 # If this works inconsistently, then additional checks should be done.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# C++ Server Sent Events`
	`2`	`+`
	`3`	`+This library provides an event source client implementation for use in client-side and server-side LaunchDarkly SDKs.`