Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-03-18 00:19:49 +01:00
Code Issues Projects Releases Wiki Activity

Apply suggestions from code review

Browse Source 
Co-authored-by: sighphyre <liquidwicked64@gmail.com>
This commit is contained in:
Thomas Heartman 2021-12-06 14:06:14 +01:00 committed by GitHub
parent acedb240ca
commit 815fc353ec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
website/docs/sdks/android-proxy.md
View File

@ -7,7 +7,7 @@ In this guide we'll explain how to use feature toggles in an Android application
:::note
The Android proxy SDK requires Unleash Proxy to function. You'll need the proxy's URL and a configured proxy secret. Refer to the [proxy documentation](/sdks/unleash-proxy) for how to set it up and [how to configure the proxy secrets](/sdks/unleash-proxy#configuration-variables).
The Android proxy SDK requires the Unleash Proxy to function. You'll need the proxy's URL and a configured proxy secret. Refer to the [proxy documentation](/sdks/unleash-proxy) for how to set it up and [how to configure the proxy secrets](/sdks/unleash-proxy#configuration-variables).
:::
## How to use the Android Proxy SDK
@ -61,7 +61,7 @@ To create a client, use the `UnleashConfig.newBuilder` method. When building a c
- `clientSecret`: the [proxy secret](/sdks/unleash-proxy#configuration-variables) you wish to use
- `pollMode`: how you want to load the toggle status
As of v0.1 the SDK supports an automatic polling with an adjustable poll period or loading the state from disk. Most users will probably use the polling client, but it's nice to know that you can instantiate your client without actually needing Internet if you choose loading from File
As of v0.1 the SDK supports an automatic polling with an adjustable poll period or loading the state from disk. Most users will probably want to use the polling client, but it's nice to know that you can instantiate your client without actually needing Internet if you choose loading from File
#### Step 4a: Configure client polling proxy

2
website/docs/sdks/proxy-javascript.md
View File

@ -21,7 +21,7 @@ npm install unleash-proxy-client
**Step 2: Initialize the SDK**
You need to have an Unleash-hosted instance, and the proxy need to be enabled. In addition you will need a proxy-specific `clientKey` in order to connect to the Unleash-hosted Proxy. For more on how to set up client keys, [consult the Unleash Proxy docs](unleash-proxy.md#configuration-variables).
You need to have an Unleash-hosted instance, and the proxy needs to be enabled. In addition you will need a proxy-specific `clientKey` in order to connect to the Unleash-hosted Proxy. For more on how to set up client keys, [consult the Unleash Proxy docs](unleash-proxy.md#configuration-variables).
```js
import { UnleashClient } from 'unleash-proxy-client';

2
website/docs/sdks/unleash-proxy.md
View File

@ -37,7 +37,7 @@ Regardless of how you choose to run the it, the proxy will need access to these
- **`proxySecrets`** / **`UNLEASH_PROXY_SECRETS`**
A list of client keys that the proxy will accept. For the proxy to accept an incoming request, the client must use one of these keys for authorization. In client SDKs, this is usually known as a `clientKey` or a `clientSecret` . If you query the proxy directly via HTTP, this is the `authorization` header.
A list of client keys that the proxy will accept. For the proxy to accept an incoming request, the client must use one of these keys for authorization. In client SDKs, this is usually known as a `clientKey` or a `clientSecret`. If you query the proxy directly via HTTP, this is the `authorization` header.
When using an environment variable to set the proxy secrets, the value should be a comma-separated list of strings, such as `secret-one,secret-two`.