Skip to content

Commit

Permalink
chore: Updating docs for pkgs/sdk/server
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Aug 27, 2024
1 parent 51ed655 commit 41701ac
Show file tree
Hide file tree
Showing 271 changed files with 110,285 additions and 0 deletions.
844 changes: 844 additions & 0 deletions pkgs/sdk/server/CHANGELOG.html
View file

Large diffs are not rendered by default.

156 changes: 156 additions & 0 deletions pkgs/sdk/server/CONTRIBUTING.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Contributing to the LaunchDarkly Server-Side SDK for .NET | LaunchDarkly Dotnet Server SDK </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Contributing to the LaunchDarkly Server-Side SDK for .NET | LaunchDarkly Dotnet Server SDK ">


<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="styles/docfx.vendor.min.css">
<link rel="stylesheet" href="styles/docfx.css">
<link rel="stylesheet" href="styles/main.css">
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="">

<meta property="docfx:rel" content="">

</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>

<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>

<a class="navbar-brand" href="index.html">
<img id="logo" class="svg" src="logo.svg" alt="LaunchDarkly Dotnet Server SDK">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>

<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">

<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="article row grid">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="">
<h1 id="contributing-to-the-launchdarkly-server-side-sdk-for-net">Contributing to the LaunchDarkly Server-Side SDK for .NET</h1>

<p>LaunchDarkly has published an <a href="https://docs.launchdarkly.com/sdk/concepts/contributors-guide">SDK contributor's guide</a> that provides a detailed explanation of how our SDKs work. See below for additional information on how to contribute to this SDK.</p>
<h2 id="submitting-bug-reports-and-feature-requests">Submitting bug reports and feature requests</h2>
<p>The LaunchDarkly SDK team monitors the <a href="https://github.com/launchdarkly/dotnet-core/issues">issue tracker</a> in the SDK repository. Bug reports and feature requests specific to this SDK should be filed in this issue tracker. The SDK team will respond to all newly filed issues within two business days.</p>
<h2 id="submitting-pull-requests">Submitting pull requests</h2>
<p>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.</p>
<h2 id="build-instructions">Build instructions</h2>
<h3 id="prerequisites">Prerequisites</h3>
<p>To set up your SDK build time environment, you must <a href="https://dotnet.microsoft.com/download">download .NET development tools and follow the instructions</a>. .NET 5.0 is preferred, since the .NET 5.0 tools are able to build for all supported target platforms.</p>
<p>This SDK shares part of its implementation and public API with the <a href="../client">Client-Side SDK for .NET</a>. The shared code is in two other packages:</p>
<ul>
<li><code>LaunchDarkly.CommonSdk</code> (in <a href="https://github.com/launchdarkly/dotnet-sdk-common"><code>launchdarkly/dotnet-sdk-common</code></a>: Types such as <code>User</code> that are part of the SDK's public API, but are not specific to server-side or client-side use.</li>
<li><code>LaunchDarkly.InternalSdk</code> (in <a href="https://github.com/launchdarkly/dotnet-sdk-internal"><code>launchdarkly/dotnet-sdk-internal</code></a>: Support code that is not part of the SDK's public API, such as the implementation of analytics event processing. These types are public in order to be usable from outside of their assembly, but they are not included in the SDK's public API or documentation.</li>
</ul>
<p>Other support code is in the packages <a href="https://github.com/launchdarkly/dotnet-eventsource"><code>LaunchDarkly.EventSource</code></a> and <a href="https://github.com/launchdarkly/dotnet-logging"><code>LaunchDarkly.Logging</code></a>.</p>
<h3 id="building">Building</h3>
<p>To install all required packages:</p>
<pre><code class="lang-bash">dotnet restore
</code></pre>
<p>Then, to build the SDK for all target frameworks:</p>
<pre><code class="lang-bash">dotnet build src/LaunchDarkly.ServerSdk
</code></pre>
<p>Or, in Linux:</p>
<pre><code class="lang-bash">make
</code></pre>
<p>Or, to build for only one target framework (in this example, .NET Standard 2.0):</p>
<pre><code class="lang-bash">dotnet build src/LaunchDarkly.ServerSdk -f netstandard2.0
</code></pre>
<h3 id="testing">Testing</h3>
<p>To run all unit tests:</p>
<pre><code class="lang-bash">dotnet test test/LaunchDarkly.ServerSdk.Tests/LaunchDarkly.ServerSdk.Tests.csproj
</code></pre>
<p>Or, in Linux:</p>
<pre><code class="lang-bash">make test
</code></pre>
<p>Note that the unit tests can only be run in Debug configuration. There is an <code>InternalsVisibleTo</code> directive that allows the test code to access internal members of the library, and assembly strong-naming in the Release configuration interferes with this.</p>
<p>To run the SDK contract test suite in Linux (see <a href="contract-tests/README.html"><code>contract-tests/README.md</code></a>):</p>
<pre><code class="lang-bash">make contract-tests
</code></pre>
<h2 id="documentation-in-code">Documentation in code</h2>
<p>All public types, methods, and properties should have documentation comments in the standard C# XML comment format. These will be automatically included in the documentation that is generated on release; this process also uses additional Markdown content from the respective packages <code>docs-src/</code> subdirectory.</p>
<p>See <a href="docs-src/README.html"><code>docs-src/README.md</code></a> for more details.</p>

</article>
</div>

<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/launchdarkly/dotnet-core/blob/main/pkgs/sdk/server/CONTRIBUTING.md/#L1" class="contribution-link">Edit this page</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In this article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>

<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>

<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>

<script type="text/javascript" src="styles/docfx.vendor.min.js"></script>
<script type="text/javascript" src="styles/docfx.js"></script>
<script type="text/javascript" src="styles/main.js"></script>
</body>
</html>
173 changes: 173 additions & 0 deletions pkgs/sdk/server/README.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>LaunchDarkly Server-Side SDK for .NET | LaunchDarkly Dotnet Server SDK </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="LaunchDarkly Server-Side SDK for .NET | LaunchDarkly Dotnet Server SDK ">


<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="styles/docfx.vendor.min.css">
<link rel="stylesheet" href="styles/docfx.css">
<link rel="stylesheet" href="styles/main.css">
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="">

<meta property="docfx:rel" content="">

</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>

<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>

<a class="navbar-brand" href="index.html">
<img id="logo" class="svg" src="logo.svg" alt="LaunchDarkly Dotnet Server SDK">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>

<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">

<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="article row grid">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="">
<h1 id="launchdarkly-server-side-sdk-for-net">LaunchDarkly Server-Side SDK for .NET</h1>

<p>The LaunchDarkly Server-Side SDK for .NET is designed primarily for use in multi-user systems such as web servers and applications. It follows the server-side LaunchDarkly model for multi-user contexts. It is not intended for use in desktop and embedded systems applications.</p>
<p>For using LaunchDarkly in <em>client-side</em> .NET applications, including mobile (MAUI) applications and desktop applications, refer to our <a href="../client">Client-Side SDK for .NET</a>.</p>
<h2 id="launchdarkly-overview">LaunchDarkly overview</h2>
<p><a href="https://www.launchdarkly.com">LaunchDarkly</a> is a feature management platform that serves trillions of feature flags daily to help teams build better software, faster. <a href="https://docs.launchdarkly.com/home/getting-started">Get started</a> using LaunchDarkly today!</p>
<p><a href="https://twitter.com/intent/follow?screen_name=launchdarkly"><img src="https://img.shields.io/twitter/follow/launchdarkly.svg?style=social&amp;label=Follow&amp;maxAge=2592000" alt="Twitter Follow"></a></p>
<h2 id="supported-net-versions">Supported .NET versions</h2>
<p>This version of the SDK is built for the following targets:</p>
<ul>
<li>.NET 6.0: runs on .NET 6.0 and above (including higher major versions).</li>
<li>.NET Framework 4.6.2: runs on .NET Framework 4.6.2 and above.</li>
<li>.NET Standard 2.0: runs in any project that is targeted to .NET Standard 2.x rather than to a specific runtime platform.</li>
</ul>
<p>The .NET build tools should automatically load the most appropriate build of the SDK for whatever platform your application or library is targeted to.</p>
<p>The only differences in the SDK between platforms are these:</p>
<ul>
<li>Setting a TCP connection timeout is only supported in .NET Core and .NET 6.0+. For more details, see <code>HttpConfigurationBuilder.ConnectTimeout</code>.</li>
<li>The SDK requires the <code>System.Text.Json</code> API to be available; it is built into the standard runtime library in .NET Core and .NET 6.0+, but not on other platforms, so on other platforms the SDK brings in <code>System.Text.Json</code> as a NuGet package dependency.</li>
</ul>
<h2 id="getting-started">Getting started</h2>
<p>Refer to the <a href="https://docs.launchdarkly.com/sdk/server-side/dotnet#getting-started">SDK documentation</a> for instructions on getting started with using the SDK.</p>
<h2 id="signing">Signing</h2>
<p>The published version of this assembly is digitally signed with Authenticode and <a href="https://docs.microsoft.com/en-us/dotnet/framework/app-domains/strong-named-assemblies">strong-named</a>. Building the code locally in the default Debug configuration does not use strong-naming and does not require a key file. The public key file is in this repository at <code>LaunchDarkly.pk</code> as well as here:</p>
<pre><code>Public Key:
0024000004800000940000000602000000240000525341310004000001000100f121bbf427e4d7
edc64131a9efeefd20978dc58c285aa6f548a4282fc6d871fbebeacc13160e88566f427497b625
56bf7ff01017b0f7c9de36869cc681b236bc0df0c85927ac8a439ecb7a6a07ae4111034e03042c
4b1569ebc6d3ed945878cca97e1592f864ba7cc81a56b8668a6d7bbe6e44c1279db088b0fdcc35
52f746b4

Public Key Token: f86add69004e6885
</code></pre>
<h2 id="learn-more">Learn more</h2>
<p>Read our <a href="https://docs.launchdarkly.com">documentation</a> for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the <a href="https://docs.launchdarkly.com/sdk/server-side/dotnet">complete reference guide for this SDK</a>.</p>
<p>The authoritative description of all types, properties, and methods is in the <a href="https://launchdarkly.github.io/dotnet-core/pkgs/sdk/server">generated API documentation</a>.</p>
<h2 id="testing">Testing</h2>
<p>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.</p>
<h2 id="contributing">Contributing</h2>
<p>We encourage pull requests and other contributions from the community. Check out our <a href="CONTRIBUTING.html">contributing guidelines</a> for instructions on how to contribute to this SDK.</p>
<h2 id="about-launchdarkly">About LaunchDarkly</h2>
<ul>
<li>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:
<ul>
<li>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.</li>
<li>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?).</li>
<li>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.</li>
<li>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.</li>
</ul>
</li>
<li>LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read <a href="https://docs.launchdarkly.com/sdk">our documentation</a> for a complete list.</li>
<li>Explore LaunchDarkly
<ul>
<li><a href="https://www.launchdarkly.com/" title="LaunchDarkly Main Website">launchdarkly.com</a> for more information</li>
<li><a href="https://docs.launchdarkly.com/" title="LaunchDarkly Documentation">docs.launchdarkly.com</a> for our documentation and SDK reference guides</li>
<li><a href="https://apidocs.launchdarkly.com/" title="LaunchDarkly API Documentation">apidocs.launchdarkly.com</a> for our API documentation</li>
<li><a href="https://blog.launchdarkly.com/" title="LaunchDarkly Blog Documentation">blog.launchdarkly.com</a> for the latest product updates</li>
</ul>
</li>
</ul>

</article>
</div>

<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/launchdarkly/dotnet-core/blob/main/pkgs/sdk/server/README.md/#L1" class="contribution-link">Edit this page</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In this article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>

<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>

<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>

<script type="text/javascript" src="styles/docfx.vendor.min.js"></script>
<script type="text/javascript" src="styles/docfx.js"></script>
<script type="text/javascript" src="styles/main.js"></script>
</body>
</html>
Loading

0 comments on commit 41701ac

Please sign in to comment.