1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Commit Graph

113 Commits

Author SHA1 Message Date
Thomas Heartman
300c6abd74 fix: fix broken link in SDK list 2022-03-04 13:52:19 +01:00
Thomas Heartman
c0985ad08d docs: be explicit about what happens if an SDK doesn't have toggles. 2022-03-04 13:43:02 +01:00
Thomas Heartman
304e95f9d7 docs: add working offline section to the SDKs doc 2022-03-04 13:37:59 +01:00
Thomas Heartman
28df5dcb31 docs: add offline headings / rough skeleton 2022-03-04 12:56:16 +01:00
Thomas Heartman
e6d939508d fix: correct the description of disabled variants 2022-03-04 08:20:55 +01:00
sighphyre
c2b946bf28
Merge pull request #1381 from Unleash/docs/update-compat-table-for-constraints
docs: Advanced constraints compatibility
2022-02-24 11:36:38 +02:00
sighphyre
a7fa3f703d docs: update docs for Go SDK because wait until initialized already exists 2022-02-23 15:30:13 +02:00
sighphyre
435f64ad22 docs: mark PHP as advanced constraint compatible in compatibility table 2022-02-23 12:29:30 +02:00
sighphyre
5487fca318 docs: add in compatibility table entry for advanced constraints 2022-02-21 13:59:45 +02:00
Ivar Conradi Østhus
9f6b414e09
docs: correct unleash proxy sdk docs 2022-02-21 10:45:05 +01:00
Renato Arruda
50cbc78cd8
(docs) Ruby SDK now has a bootstrap impl 2022-02-17 07:58:52 +01:00
Thomas Heartman
0b69e1751e chore: remove trailing full stop. 2022-02-09 13:44:58 +01:00
Ivar Conradi Østhus
1487ae10c6
docs: update compatibility matrix 2022-02-08 20:57:06 +01:00
Fredrik Strand Oseberg
acb98db00f
docs: add docs for impression data (#1328)
* docs: add docs for impression data

* fix: update wording

* Update website/docs/advanced/impression_data.md

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>

* Update website/docs/advanced/impression_data.md

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>

* docs: use hyphen instead of underscore in file name and title/slug

We've been very inconsistent with our use of separators previously
(we should try and find a standard). Hyphens are most common online,
so I've switched to that instead.

* docs: use syntax highlighting for shell commands

* docs: start outlining impression data restructure.

* docs: Add impression data info to API: create toggles

* docs: Add impression data row to compatibility matrix

* docs: restructures the impression data reference doc.

* chore: remove question callout in source material

* docs: add redirect for `impression_data` -> 'impression-data'

* docs: Add sdk availability to availability note

* chore: Fix broken doc paths.

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-02-08 12:11:08 +01:00
Thomas Heartman
4e03e4b3a8 chore: fix broken link to community sdks section 2022-02-07 13:02:07 +01:00
Thomas Heartman
673b297209 docs: use some-secret instead of some-public-key
The rest of the docs all use `some-secret`, so having only this **one**
place use `some-public-key` is really misleading.
2022-02-04 10:13:27 +01:00
Antonio Ruiz
0f03bebcef Add Unleash SDK for C++ to Community SDKs list. 2022-01-27 09:53:08 +01:00
Thomas Heartman
6d43b93be2 docs(chore): fix broken links to control_rollout 2022-01-25 12:22:00 +01:00
Ivar Conradi Østhus
8a175aa217
docs: update Server-side SDK compatibility table 2022-01-23 22:50:39 +01:00
Ivar Conradi Østhus
a5367ef9f8
docs: improve proxy commands 2022-01-21 10:13:22 +01:00
Philippe Vaillancourt
ce555f5f70
docs: Add ngx-unleash-proxy-client to community sdks (#1275) 2022-01-20 12:26:00 +01:00
sighphyre
1207d83aab docs: Move proxy sdk compatibility to end of the compatability table 2022-01-19 16:49:18 +02:00
sighphyre
738d6eb91a
Update website/docs/sdks/index.md
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-01-19 16:09:24 +02:00
sighphyre
76a55946a9 docs: Add in missing N/A for rust context provider compatibility 2022-01-19 15:58:57 +02:00
sighphyre
53034e837f chore: Add compatability table for Rust SDK 2022-01-19 09:32:37 +02:00
Thomas Heartman
cf35efedee
Apply suggestions from code review
Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-01-17 14:55:06 +01:00
Thomas Heartman
611602c781 docs: add steps for running the proxy via Node
Also: restructure the steps relating to running it via docker to align
better and to avoid repeating information.
2022-01-14 13:53:09 +01:00
Thomas Heartman
5f581f765e
Merge pull request #1263 from Unleash/docs/group-sdks
docs: group sdks into non-collapsible categories: server and client
2022-01-14 08:56:04 +01:00
Thomas Heartman
9e55752dcf docs(chore): standardize on the naming of the .NET sdk. 2022-01-13 10:36:24 +01:00
Thomas Heartman
bfd168689c docs(chore): sort the sdk list the same as the sidebar list. 2022-01-13 10:34:05 +01:00
kakakakakku
18c87cedf6 Fixed syntax error for Ruby SDK example 2022-01-13 09:59:51 +01:00
Renato Arruda
4de960188a
Update ruby SDK capabilities
Ruby sdk now supports remote_address strategy with CIDR syntax

Feature can be found in main branch, not in a release yet.
2022-01-11 22:44:14 +01:00
Thomas Heartman
f404c37f97 docs(chore): Update headings, slight sdk doc restructure. 2022-01-11 09:17:07 +01:00
Thomas Heartman
d2369b5a69 docs(chore): sort SDK lists alphabetically 2022-01-10 15:00:10 +01:00
Thomas Heartman
d785b25a80 docs(chore): move Rust sdk from community to official listing
Also sorts the list of SDKs by name.
2022-01-10 14:56:43 +01:00
Thomas Heartman
c3d78bc028 docs: delete /sdks/community page
This page was more or less a duplicate of the final section of the
SDK overview. I've moved the section on implementing your own SDK into
the SDK overview instead.
2022-01-10 14:53:41 +01:00
Renato Arruda
c85c710327
Update the default metrics interval for Ruby SDK (#1247)
Note that the new metrics interval (60s) is only in master and a release with the new value is not yet created.
2022-01-08 11:51:19 +01:00
Thomas Heartman
7444b2cb74 docs(chore): add npm2yarn annotation to all npm commands 2022-01-04 10:18:13 +01:00
Youssef Khedher
903917c06a
Merge pull request #1205 from Unleash/docs/proxy-and-custom-strategies
docs: Add more docs on custom strategies and the proxy
2021-12-24 11:40:31 +01:00
Ivar Conradi Østhus
f730d0d450
chore: correct compatibility matrix for server SDKs 2021-12-23 21:31:49 +01:00
Thomas Heartman
0892b1aca0 docs(custom strats): add note to proxy docs about custom strats. 2021-12-22 13:23:34 +01:00
Renato Arruda
018675ad34 Update status of Ruby SDK after release 4.0.0 2021-12-16 22:07:35 +01:00
Thomas Heartman
2b0941a6fb docs(compat): link to sdks in table headers, use human strat names. 2021-12-10 15:17:34 +01:00
Thomas Heartman
d65703f860 docs(compat): center icons in table 2021-12-10 14:03:11 +01:00
Thomas Heartman
0722e8a24b docs(compat): add .net gradual rollout custom stickiness 2021-12-09 13:56:28 +01:00
Thomas Heartman
93685a4e86 docs(compat): add slack link to text 2021-12-09 13:54:06 +01:00
Thomas Heartman
0b51a69ae3 chore: format compat table. 2021-12-09 13:47:33 +01:00
Thomas Heartman
9cc9996c06 docs(compat): Add links to concepts in table. 2021-12-09 13:41:56 +01:00
Thomas Heartman
828468dfe5 docs(compat): Flesh out descriptions 2021-12-09 13:33:30 +01:00
Thomas Heartman
abc07ae73f docs(compat): add a first iteration of the compatibility table. 2021-12-09 13:14:20 +01:00
Thomas Heartman
b595277204 chore: (docs) keep list styling (internally) consistent 2021-12-06 14:08:25 +01:00
Thomas Heartman
815fc353ec
Apply suggestions from code review
Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2021-12-06 14:06:14 +01:00
Thomas Heartman
acedb240ca docs: iOS proxy: add info about client keys and environments. 2021-12-06 13:24:59 +01:00
Thomas Heartman
b46afd8887 docs: react proxy sdk: explain clientKey and other config vars. 2021-12-06 13:16:54 +01:00
Thomas Heartman
d936a0d4ed docs: Android SDK: reformat and add more details on client secrets 2021-12-06 12:59:32 +01:00
Thomas Heartman
a03e7927bb docs: JS proxy client: explain client keys 2021-12-06 12:58:17 +01:00
Thomas Heartman
24bf9b7012 docs: explain what the proxy configuration variables are. 2021-12-06 12:35:49 +01:00
Thomas Heartman
e41d6b0f4d docs: describe the shape of the data returned by the Unleash proxy
This commit attempts to explain what the proxy returns in more detail,
explaining how payloads work and what the `enabled` properties mean
and how they relate to the rest of the content.
2021-11-30 12:52:46 +01:00
Thomas Heartman
7274474792 docs: remove link to old activation strategies document. 2021-11-24 10:53:56 +01:00
Christopher Kolstad
7409f679f2
docs: Updated maven coordinates for java sdk 2021-11-12 08:34:11 +01:00
Ivar Conradi Østhus
c4035353a0
docs: add syntax highlighting to react-sdk 2021-11-09 14:21:07 +01:00
Thomas Heartman
106c9cebde
docs: Clarify that the proxy does not expose disabled flags (#1094)
* docs: fix typo 'preformat' -> 'performant'

* docs: clarify that proxy returns _only_ enabled toggles

This is based on feedback we got that said:

> Right now biggest disappointment is that docs doesn't match an exact
> JS proxy libraries and their usage. For example, we couldn't make
> feature flag return enabled: false, instead it just hides/not return
> the flag at all.
2021-11-08 22:58:02 +01:00
Ivar Conradi Østhus
ffec4f6342 fix: rename websitev2 to website 2021-10-26 11:25:19 +02:00