readme: Optimizely DFM #188
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 similar comment
aliabbasrizvi
approved these changes
Jul 15, 2019
README.rst
Outdated
| @@ -30,7 +30,94 @@ dashboard, please contact your Optimizely account executive. | |||
| Using the SDK | |||
| ~~~~~~~~~~~~~ | |||
|
|
|||
| See the Optimizely `Full Stack documentation`_ to learn how to | |||
| You can initialize the Optimizely instance in three ways: with a datafile, by providing an `sdk_key`, or by providing a Config Manager. Each method is described below. | |||
There was a problem hiding this comment.
Link ConfigManager to config_manager.py
README.rst
Outdated
| :: | ||
|
|
||
| optimizely.Optimizely( | ||
| datafile=None, |
There was a problem hiding this comment.
nit. I don't think our example needs to show datafile=None
README.rst
Outdated
| sdk_key='put_your_sdk_key_here' | ||
| ) | ||
|
|
||
| 3. Initialize Optimizely by providing a Config Manager that implements a |
There was a problem hiding this comment.
Instead, link to BaseConfigManager and ask for user to implement BaseConfigManager.
README.rst
Outdated
| a PollingConfigManager that makes an HTTP GET request to the URL ( | ||
| formed using your provided sdk key and the default datafile CDN url | ||
| a PollingConfigManager that makes an HTTP GET request to the URL (formed | ||
| using your provided `sdk key` and the default datafile CDN url |
There was a problem hiding this comment.
put "URL" in capital letters?
README.rst
Outdated
| ================ ======================================================== ===================================================================================== | ||
|
|
||
| A notification signal will be triggered whenever a *new* datafile is | ||
| fetched and Project Config is updated. To subscribe to these | ||
| notifications you can use the | ||
| notifications, use the |
There was a problem hiding this comment.
Maybe this instead?
To subscribe to these notifications, use:
|
@msohailhussain can you fix the PR summary? |
This is done. Are we good to merge in? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary