-
Notifications
You must be signed in to change notification settings - Fork 20
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[FSSDK-8955] Refac: Replaced all instances of full stack except from changelog file and code files #331
[FSSDK-8955] Refac: Replaced all instances of full stack except from changelog file and code files #331
Changes from all commits
e29a8b8
27094a0
15b20f1
b5e8140
46c1633
5449c90
5ed3318
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,7 +28,6 @@ jobs: | |
VALIDATE_ALL_CODEBASE: false | ||
DEFAULT_BRANCH: master | ||
VALIDATE_CSHARP: true | ||
VALIDATE_MARKDOWN: true | ||
|
||
integration_tests: | ||
name: Run Integration Tests | ||
|
@@ -38,7 +37,7 @@ jobs: | |
TRAVIS_COM_TOKEN: ${{ secrets.TRAVIS_COM_TOKEN }} | ||
|
||
fullstack_production_suite: | ||
name: Run Full Stack Compatibility Suite | ||
name: Run Optimizely Feature Experimentation Compatibility Suite | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @mnoman09 I wonder if @russell-loube-optimizely is on point here. The ping is not completing b/c we've renamed the job. Maybe revert this particular instance. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No this does not have to do with the issue because build uses fullstack_production_suite as ID and it is running fine. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Cool. I'll merge then. |
||
uses: optimizely/csharp-sdk/.github/workflows/integration_test.yml@master | ||
with: | ||
FULLSTACK_TEST_REPO: ProdTesting | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,15 +4,18 @@ | |
[![NuGet](https://img.shields.io/nuget/v/Optimizely.SDK.svg?style=plastic)](https://www.nuget.org/packages/Optimizely.SDK/) | ||
[![Apache 2.0](https://img.shields.io/github/license/nebula-plugins/gradle-extra-configurations-plugin.svg)](http://www.apache.org/licenses/LICENSE-2.0) | ||
|
||
This repository houses the .Net based C# SDK for use with Optimizely Full Stack and Optimizely Rollouts. | ||
This repository houses the .Net based C# SDK for use with Optimizely Feature Experimentation and Optimizely Full Stack (legacy). | ||
|
||
Optimizely Full Stack is A/B testing and feature flag management for product development teams. Experiment in any application. Make every feature on your roadmap an opportunity to learn. Learn more at https://www.optimizely.com/platform/full-stack/, or see the [documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome). | ||
Optimizely Feature Experimentation is an A/B testing and feature management tool for product development teams, letting you experiment at every step. Using Optimizely Feature Experimentation allows for every feature on your roadmap to be an opportunity to discover hidden insights. Learn more at [Optimizely.com](https://www.optimizely.com/products/experiment/feature-experimentation/), or see the [developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome). | ||
|
||
Optimizely Rollouts is free feature flags for development teams. Easily roll out and roll back features in any application without code deploys. Mitigate risk for every feature on your roadmap. Learn more at https://www.optimizely.com/rollouts/, or see the [documentation](https://docs.developers.optimizely.com/experimentation/v3.1.0-full-stack/docs/introduction-to-rollouts). | ||
Optimizely Rollouts is [free feature flags](https://www.optimizely.com/free-feature-flagging/) for development teams. You can easily roll out and roll back features in any application without code deploys, mitigating risk for every feature on your roadmap. | ||
|
||
## Getting Started | ||
|
||
### Installing the SDK | ||
## Get Started | ||
|
||
Refer to the [C# SDK's developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/csharp-sdk) for detailed instructions on getting started with using the SDK. | ||
|
||
### Install the C# SDK | ||
|
||
The SDK can be installed through [NuGet](https://www.nuget.org): | ||
|
||
|
@@ -30,13 +33,16 @@ Simply compile and run the Sample application to see it in use. | |
Note that the way the Demo App stores data in memory is not recommended for production use | ||
and is merely illustrates how to use the SDK. | ||
|
||
### Using the SDK | ||
|
||
#### Documentation | ||
### Feature Management Access | ||
|
||
To access the Feature Management configuration in the Optimizely dashboard, please contact your Optimizely customer success manager. | ||
|
||
See the Optimizely Full Stack C# SDK [developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/csharp-sdk) to learn how to set up your first Full Stack project and use the SDK. | ||
## Use the C# SDK | ||
|
||
#### Initialization | ||
See the Optimizely Feature Experimentation [developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0-full-stack/docs/csharp-sdk) to learn how to set up your first C# project and use the SDK. | ||
|
||
### Initialization | ||
|
||
Create the Optimizely Client, for example: | ||
|
||
|
@@ -210,19 +216,39 @@ This option is used to specify whether to start the config manager on initializa | |
|
||
This option is used to provide token for datafile belonging to a secure environment. | ||
|
||
## Development | ||
|
||
### Unit tests | ||
|
||
The sample project contains unit tests as well which can be run from the built-in Visual Studio Test Runner. | ||
## SDK Development | ||
|
||
russell-loube-optimizely marked this conversation as resolved.
Show resolved
Hide resolved
|
||
### Contributing | ||
|
||
Please see [CONTRIBUTING](CONTRIBUTING.md). | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Change line 223 to ### Third Party Licenses |
||
## Third Party Licenses | ||
### Third Party Licenses | ||
|
||
Optimizely SDK uses third party software: | ||
[murmurhash-signed](https://www.nuget.org/packages/murmurhash-signed/), | ||
[Newtonsoft.Json](https://www.nuget.org/packages/Newtonsoft.Json/), and | ||
[NJsonSchema](https://www.nuget.org/packages/NJsonSchema/). | ||
|
||
### Other Optimzely SDKs | ||
|
||
- Agent - https://github.com/optimizely/agent | ||
|
||
- Android - https://github.com/optimizely/android-sdk | ||
|
||
- Flutter - https://github.com/optimizely/optimizely-flutter-sdk | ||
|
||
- Go - https://github.com/optimizely/go-sdk | ||
|
||
- Java - https://github.com/optimizely/java-sdk | ||
|
||
- JavaScript - https://github.com/optimizely/javascript-sdk | ||
|
||
- PHP - https://github.com/optimizely/php-sdk | ||
|
||
- Python - https://github.com/optimizely/python-sdk | ||
|
||
- React - https://github.com/optimizely/react-sdk | ||
|
||
- Ruby - https://github.com/optimizely/ruby-sdk | ||
|
||
- Swift - https://github.com/optimizely/swift-sdk |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,7 +10,7 @@ updatedAt: "2020-01-28T21:53:11.290Z" | |
"title": "Overview" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Change looks good, but md file as a whole doesn't seem to be rendering properly. Could you please take a look? |
||
} | ||
[/block] | ||
Full Stack SDKs open a well-defined set of public APIs, hiding all implementation details. However, some clients may need access to project configuration data within the "datafile". | ||
Optimizely Feature Experimentation SDKs open a well-defined set of public APIs, hiding all implementation details. However, some clients may need access to project configuration data within the "datafile". | ||
|
||
In this document, we extend our public APIs to define data models and access methods, which clients can use to access project configuration data. | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,7 +5,7 @@ hidden: false | |
createdAt: "2019-09-12T13:44:04.059Z" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also doesn't seem to be rendering properly, could you please double check? |
||
updatedAt: "2019-12-13T00:25:39.892Z" | ||
--- | ||
The [Optimizely Full Stack C# SDK](https://github.com/optimizely/csharp-sdk) now batches impression and conversion events into a single payload before sending it to Optimizely. This is achieved through a new SDK component called the event processor. | ||
The [Optimizely Feature Experimentation C# SDK](https://github.com/optimizely/csharp-sdk) now batches impression and conversion events into a single payload before sending it to Optimizely. This is achieved through a new SDK component called the event processor. | ||
|
||
Event batching has the advantage of reducing the number of outbound requests to Optimizely depending on how you define, configure, and use the event processor. It means less network traffic for the same number of Impression and conversion events tracked. | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -91,7 +91,7 @@ The table lists other other Optimizely functionality that may be triggered by us | |
"h-0": "Functionality", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also not rendering properly? |
||
"h-1": "Description", | ||
"0-0": "Conversions", | ||
"0-1": "Calling this method records a conversion and attributes it to the variations that the user has seen.\n \nFull Stack 3.x supports retroactive metrics calculation. You can create [metrics](doc:choose-metrics) on this conversion event and add metrics to experiments even after the conversion has been tracked.\n\nFor more information, see the paragraph **Events are always on** in the introduction of [Events: Tracking clicks, pageviews, and other visitor actions](https://help.optimizely.com/Measure_success%3A_Track_visitor_behaviors/Events%3A_Tracking_clicks%2C_pageviews%2C_and_other_visitor_actions).\n\n**Important!** \n - This method won't track events when the specified event key is invalid.\n - Changing the traffic allocation of running experiments affects how conversions are recorded and variations are attributed to users.", | ||
"0-1": "Calling this method records a conversion and attributes it to the variations that the user has seen.\n \nOptimizely Feature Experimentation 3.x supports retroactive metrics calculation. You can create [metrics](doc:choose-metrics) on this conversion event and add metrics to experiments even after the conversion has been tracked.\n\nFor more information, see the paragraph **Events are always on** in the introduction of [Events: Tracking clicks, pageviews, and other visitor actions](https://help.optimizely.com/Measure_success%3A_Track_visitor_behaviors/Events%3A_Tracking_clicks%2C_pageviews%2C_and_other_visitor_actions).\n\n**Important!** \n - This method won't track events when the specified event key is invalid.\n - Changing the traffic allocation of running experiments affects how conversions are recorded and variations are attributed to users.", | ||
"1-0": "Impressions", | ||
"1-1": "Track doesn't trigger impressions.", | ||
"2-0": "Notification Listeners", | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Totally fine with the change so long as you don't think it would be confusing since we still call the test suite by "FSC".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not sure are we are going to rename FSC as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Funny. What can be a good name to replace it internally. FXC? @russell-loube-optimizely