Skip to content
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-8952] doc: Full Stack to Feature Experimentation Rename #450

Merged
merged 3 commits into from Mar 14, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
45 changes: 35 additions & 10 deletions README.md
Expand Up @@ -4,22 +4,20 @@

## Overview
mnoman09 marked this conversation as resolved.
Show resolved Hide resolved

This repository houses the Android SDK for use with Optimizely Full Stack and Optimizely Rollouts. The Android SDK depends on the [Optimizely Java SDK](https://github.com/optimizely/java-sdk).
This repository houses the Android SDK for use with Optimizely Feature Experimentation and Optimizely Full Stack (legacy). The Android SDK depends on the [Optimizely Java SDK](https://github.com/optimizely/java-sdk).

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
## Get Started

### Using the SDK
See the [Android SDK developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/install-sdk-android) to learn how to set
up an Optimizely project and start using the SDK.
Refer to the [Android SDK's developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/android-sdk) for detailed instructions on getting started with using the SDK.

### Requirements
* Android API 14 or higher

### Installing the SDK
### Install the SDK
To add the android-sdk and all modules to your project, include the following in your app's `build.gradle`:

---
Expand Down Expand Up @@ -60,6 +58,10 @@ optimizelyManager.initialize(this, null, (OptimizelyClient optimizely) -> {

```

## Use the Android SDK

See the Optimizely Feature Experimentation [developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0-full-stack/docs/android-sdk) to learn how to set up your first Csharp project and use the SDK.
mnoman09 marked this conversation as resolved.
Show resolved Hide resolved

## Architecture

This project includes 5 library modules and a test app.
Expand All @@ -82,7 +84,7 @@ This project includes 5 library modules and a test app.
6. Test App
- A simple app showing how to use the Optimizely Android SDK

## Development
## SDK Development

### Command Line

Expand Down Expand Up @@ -110,7 +112,7 @@ You can import this project into Android Studio by opening Android Studio and se

Tests can be run by right clicking the file in the project pane or by clicking the method name in source and selecting run. You will be prompted to create an AVD or connect a device if one isn't connected.

### Contributing
## Contributing

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Contributing
## SDK Development
### Contributing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this heading is already getting used at line 85, should I move it here? and then what should be the heading at line 85?

Please see [CONTRIBUTING](CONTRIBUTING.md).

### Credits
Expand All @@ -128,3 +130,26 @@ Additional credits from java-sdk:[https://github.com/optimizely/java-sdk/blob/ma
**Android Logger** [https://github.com/noveogroup/android-logger](https://github.com/noveogroup/android-logger)
License (Public Domain): [https://github.com/noveogroup/android-logger/blob/master/LICENSE.txt](https://github.com/noveogroup/android-logger/blob/master/LICENSE.txt)

### Other Optimzely SDKs

- Agent - https://github.com/optimizely/agent

- C# - https://github.com/optimizely/csharp-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
2 changes: 1 addition & 1 deletion build.gradle
Expand Up @@ -217,7 +217,7 @@ configure(publishedProjects) {

customizePom(pom, docTitle)
// "description" is required by MavenCentral but it does not work in customizePom(). added here explicitly.
pom.description = 'The Android SDK for Optimizely Full Stack (feature flag management for product development teams)'
pom.description = 'The Android SDK for Optimizely Feature Experimentation and Optimizely Full Stack (legacy) (feature flag management for product development teams)'
mnoman09 marked this conversation as resolved.
Show resolved Hide resolved

from components.release
}
Expand Down
2 changes: 1 addition & 1 deletion test-app/build.gradle
Expand Up @@ -38,7 +38,7 @@ android {
}

dependencies {
// Includes the Optimizely X Full Stack Java SDK, event handler, and user profile
// Includes the Optimizely Feature Experimentation and Optimizely Full Stack (legacy) Java SDK, event handler, and user profile
mnoman09 marked this conversation as resolved.
Show resolved Hide resolved
//implementation "com.optimizely.ab:android-sdk:1.0.0"
implementation (project(':android-sdk')) {
exclude group: 'com.google.code.gson', module:'gson'
Expand Down