Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity
9,061 Commits 481 Branches 871 Tags 357 MiB
f9bca20c78
Commit Graph

663 Commits

Author SHA1 Message Date
Thomas Heartman
5e382e64dc docs: api request and placeholders to proxy how-to 2022-04-13 15:06:42 +02:00
Thomas Heartman
0f9da03078 docs: link to the how-to guide for creating tokens 2022-04-13 13:53:15 +02:00
Thomas Heartman
e0a87c68a0 docs: minor tweaks for client keys 2022-04-13 13:47:27 +02:00
Thomas Heartman
88450a8946 docs: rename api token + client key doc 2022-04-13 13:46:12 +02:00
Thomas Heartman
f7081d5f3a docs: First draft of API tokens and client keys doc 2022-04-13 13:45:01 +02:00
Thomas Heartman
bba6d6de94 docs: add api tokens outline 2022-04-12 16:00:07 +02:00
Thomas Heartman
0a0ade18df docs: add API tokens placeholder document 2022-04-12 16:00:07 +02:00
Thomas Heartman
dc7e93b618 docs: start smoothing out proxy docs 2022-04-12 16:00:07 +02:00
Thomas Heartman
f1601392e1 docs: change title, add content to how-to guide 2022-04-12 16:00:07 +02:00
Thomas Heartman
8f3018d092 docs: ad configuration variables to proxy reference 2022-04-12 16:00:07 +02:00
Thomas Heartman
48f5e45b40 fix: remove wrong id 2022-04-12 15:59:12 +02:00
Thomas Heartman
29f77b8e27 docs: add configuration options header. 2022-04-12 15:59:12 +02:00
Thomas Heartman
3c63adddab docs: add more scaffolding to proxy docs 2022-04-12 15:59:12 +02:00
Thomas Heartman
4b0b08a2ea docs: start moving proxy details around 2022-04-12 15:59:12 +02:00
Thomas Heartman
6d5b89d88b docs: add how-to for running proxy (duplicated content) 2022-04-12 15:59:11 +02:00
Thomas Heartman
f3a7ec5559
Merge pull request #1492 from Unleash/docs/update-sdk-compat 
docs(sdk compat table): Add new strategy constraint ✅ for .NET; add ✅s for Proxy
 2022-04-12 13:53:08 +02:00
Thomas Heartman
747b5f128a
Merge pull request #1498 from Unleash/docs/update-sdk-overview-title 
docs: update client sdk overview title
 2022-04-12 12:12:44 +02:00
Thomas Heartman
a327f55b3a docs: update client sdk overview title 
When the title is only "Introduction" it's super hard to find via
search. Changing it to something more descriptive should make that easier.
 2022-04-12 10:41:50 +02:00
Ivar Conradi Østhus
55e43b033d
docs: correct secrets key 2022-04-11 22:32:58 +02:00
Ivar Conradi Østhus
947d9fc40c
docs: correct proxy url to demo instance 2022-04-11 22:23:22 +02:00
Thomas Heartman
2e1423095e fix: Add missing segments image 2022-04-11 12:17:02 +02:00
Thomas Heartman
d86f898316 docs: Add ✅s for proxy features 2022-04-08 15:24:56 +02:00
Thomas Heartman
3067001083 docs: add ✅ for .NET constraints since 2.1 2022-04-08 15:24:35 +02:00
Salvatore Novelli
7ddbff2669
feat: add "application_name" as an optional DB option #1170 (#1478) 
* implemented changes to resolve issue 1170

* added applicationName to the list of db options in the documentation'

Co-authored-by: Daniele Casal <daniele.casal@lloydsbanking.com>
Co-authored-by: Sukhvinder Panesar <79143027+esspee-lbg@users.noreply.github.com>
 2022-04-07 20:55:56 +02:00
Thomas Heartman
41485ec50a docs: change android docs to use clientKey, not clientSecret 2022-04-06 10:56:51 +02:00
Thomas Heartman
35bd047af9 docs: reword api return type description 2022-04-04 14:56:34 +02:00
Thomas Heartman
90794fc6ec docs: add segment ids examples for replacing strategy segments 2022-04-04 14:49:13 +02:00
Thomas Heartman
6f2a336fc4 docs: simplify activation strategy payload 2022-04-04 14:43:45 +02:00
Thomas Heartman
683e33915f docs: update payload for activation strategies 2022-04-04 14:33:38 +02:00
Thomas Heartman
bf9f9e9d6d docs: update return types to use JSON examples instead of TS 2022-04-04 13:55:53 +02:00
Thomas Heartman
d9aae95c26 docs: move when to use segments to top of document 2022-04-04 12:32:47 +02:00
Thomas Heartman
14cb523c91 docs: expand on time-based strategies with segments 2022-04-04 12:16:32 +02:00
Thomas Heartman
971b411db1 docs: explain that with multiple segments, all must be satisfied. 2022-04-04 11:48:59 +02:00
Thomas Heartman
93b20246a7 docs: make note of how to remove all segments from a strategy 2022-04-04 11:47:13 +02:00
Thomas Heartman
e4c2e8807d docs: segment names don't need to be url-friendly. 2022-04-04 11:44:37 +02:00
Thomas Heartman
020e94e358 docs: update segments availability in API docs too 2022-04-04 11:44:03 +02:00
Thomas Heartman
cc670a018c docs: update segments availability: indicate that it's experimental 2022-04-04 11:34:53 +02:00
Thomas Heartman
79b5582542 docs(fix): various typos and abstractions fixed 2022-04-02 16:33:51 +02:00
Thomas Heartman
facf546df4 docs(fix): fix internal links between segments docs 2022-04-02 16:29:45 +02:00
Thomas Heartman
8eb91fc860 fix(docs): fix the quotes of JSON property in table 2022-04-02 16:28:24 +02:00
Thomas Heartman
45dc2c8c33 fix: remove redundant heading 2022-04-02 16:27:53 +02:00
Thomas Heartman
e03876286c docs: finish the API docs for segments 2022-04-02 16:27:09 +02:00
Thomas Heartman
102438946e docs: add POST and GET by ID 2022-04-01 16:24:35 +02:00
Thomas Heartman
d88032710b docs: describe GET /api/admin/segments 2022-04-01 16:04:10 +02:00
Thomas Heartman
5d164db46c docs: add relevant types for this API 2022-04-01 16:03:50 +02:00
Thomas Heartman
fc6ea25ebd docs: add more endpoint data 2022-04-01 15:47:00 +02:00
Thomas Heartman
3440b4f42a docs: add segments api placeholder 2022-04-01 15:47:00 +02:00
Thomas Heartman
e37714d61a docs: First draft of segments reference doc 2022-04-01 15:47:00 +02:00
Thomas Heartman
4306836511 docs: Add .NET SDK to list of SDKs that crash on new operators 2022-04-01 10:24:08 +02:00
sighphyre
17e7777a75
Update website/docs/integrations/jira-server-plugin-installation.md 
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-03-25 12:51:47 +02:00
sighphyre
8c13fe74a8
Update website/docs/integrations/jira-server-plugin-installation.md 
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-03-25 12:51:37 +02:00
sighphyre
69532656bd
Update website/docs/integrations/jira-server-plugin-installation.md 
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-03-25 12:50:43 +02:00
sighphyre
f05d76255a
Update website/docs/integrations/jira-server-plugin-installation.md 
Nice!

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-03-25 12:50:30 +02:00
sighphyre
0d4360b997 docs: add installation instructions for jira plugin for marketplace 2022-03-25 09:24:26 +02:00
Thomas Heartman
2709f19ae7 docs(a11y): add alt texts to images + minor rewording 2022-03-24 16:09:37 +01:00
Thomas Heartman
d7b09f73db docs: Add prerequisites, new installation instructions (marketplace) 2022-03-24 15:18:12 +01:00
Thomas Heartman
c15d221b66
Merge pull request #1463 from Unleash/docs/bump-php-adv-constraints-version 
docs: list v1.3.1 of the PHP sdk as first compatible w/adv constr.
 2022-03-23 14:05:21 +01:00
Thomas Heartman
907a5c6da0
Merge pull request #1449 from Unleash/docs/improve-db-ssl-docs 
docs: add more content around database connections
 2022-03-23 13:53:22 +01:00
Thomas Heartman
2ffe11a336 docs: list v1.3.1 of the PHP sdk as first compatible w/adv constr. 
While 1.3 _does_ contain the advanced operators, it'll still break if
it doesn't recognize the operators or if you provide an invalid semver
version. 1.3.1 fixes this, so we should try and nudge people towards
that instead.
 2022-03-23 13:14:20 +01:00
Thomas Heartman
77f128c482 docs: add note about PHP crashing if it doesn't recognize the op 2022-03-22 15:37:26 +01:00
Thomas Heartman
47a4fe3234 docs: sort options alphabetically in example object. 2022-03-22 11:20:48 +01:00
Thomas Heartman
da0fe21832 docs: PR feedback: configure db url, db url file, precedence 2022-03-22 11:19:09 +01:00
Thomas Heartman
0998ca4618 Merge branch 'main' into docs/sdk-min-version-for-advanced-operators 2022-03-18 15:01:39 +01:00
Thomas Heartman
0950a95698 docs: add a link to the SDK incompatibility section 2022-03-18 14:30:02 +01:00
Thomas Heartman
7efd306969 docs: link to strategy constraints from the schedule how-to guide 2022-03-18 14:28:06 +01:00
Thomas Heartman
b432ec8795 docs: only list feature versions for constraint ops inclusion 2022-03-18 14:23:26 +01:00
Thomas Heartman
e604b95e7d docs: update min versions for node, python, ruby 2022-03-18 13:55:31 +01:00
Thomas Heartman
85c74864bd
Merge pull request #1452 from Unleash/docs/add-more-adv-constraints-sdk-details 
docs: add more comprehensive overview of sdk incompatibilities
 2022-03-18 13:31:06 +01:00
Thomas Heartman
d6f6d5d1d2
Merge pull request #1441 from shailscript/patch-1 
docs: bold important text in slack integration docs
 2022-03-18 12:37:28 +01:00
Thomas Heartman
7e8cae3913 docs: change spec to specification, add link to spec 2022-03-18 12:21:29 +01:00
Thomas Heartman
8c8d165937 docs: add more comprehensive overview of sdk incompatibilities 2022-03-18 12:19:49 +01:00
Thomas Heartman
c999b4c43e docs: add php support version for advanced constraints 2022-03-18 11:34:51 +01:00
Thomas Heartman
a9a480d33f docs: note the minimum SDK versions necessary for adv constraints 
Also formats the rest of the table to align with the new column
content. Please ignore whitespace for this.
 2022-03-18 11:29:25 +01:00
Thomas Heartman
59609a85f4
Merge pull request #1440 from Unleash/docs/how-to-time-feature-releases 
docs: add how to schedule feature releases guide
 2022-03-18 09:30:23 +01:00
Thomas Heartman
b8673c86b1 docs: remove duplicate db connection options description 2022-03-17 16:43:19 +01:00
Thomas Heartman
b235eba6ac docs: add code samples, move db configuration to separate section 2022-03-17 16:11:56 +01:00
Thomas Heartman
3d1d115a30 docs: add more content around database connections 2022-03-17 15:54:56 +01:00
Thomas Heartman
84f44c0396 docs: Add note saying that some SDKs will crash with new operators. 2022-03-17 11:45:40 +01:00
Thomas Heartman
0a34661937 docs: clear up that constraints are available to pro customers too 2022-03-17 08:53:42 +01:00
Thomas Heartman
b3faf3e622 docs: add screenies and update descriptions accordingly 2022-03-17 08:41:57 +01:00
sighphyre
8f60dd6958
Merge pull request #1431 from Unleash/enabled-environments-override 
Add enabled environments override flag
 2022-03-16 14:45:55 +02:00
Thomas Heartman
104ff93332 docs: Add note to strategy constraints about undefined behavior 2022-03-16 10:05:41 +01:00
Shailendra Shukla
5e551b01f8
docs: bold important text 2022-03-15 17:44:58 -05:00
Thomas Heartman
905fa6fc6f docs: create first draft of schedule how-to 2022-03-15 16:29:55 +01:00
Thomas Heartman
8c5657911f docs: add more placeholder / structural content. 2022-03-14 18:36:01 +01:00
sighphyre
bf95a40527 docs: describe details of enabled_environments in unleash config docs 2022-03-14 09:48:54 +02:00
Thomas Heartman
27a74ecf0d docs: create initial outline for how to schedule feature releases 2022-03-11 13:58:41 +01:00
Thomas Heartman
451fa64018 docs: add a note saying passord is password for Norwegian 2022-03-10 14:22:03 +01:00
Thomas Heartman
9f292465eb docs: document how to get SEMVER_GTE/LTE functionality 2022-03-10 10:56:59 +01:00
Thomas Heartman
ad9709f235
Tell the user what was available prior to 4.9 2022-03-09 13:44:25 +01:00
Thomas Heartman
613ee550bc docs: merge currentTime with "advanced constraints" row 2022-03-09 11:55:21 +01:00
Thomas Heartman
aafa2005e0 Merge branch 'main' into docs/new-constraint-operators 2022-03-09 11:32:42 +01:00
Thomas Heartman
52281512ac
Apply suggestions from code review 
Co-authored-by: Fredrik Strand Oseberg <fredrik.no@gmail.com>
 2022-03-09 10:56:48 +01:00
Thomas Heartman
fd042f9b1a docs: update semver format after discussion and alignment 2022-03-09 10:51:24 +01:00
sighphyre
3910e23d2d
Merge pull request #1408 from Unleash/feat/init-client-tokens 
Load Client Tokens From Environment on Startup
 2022-03-09 09:53:47 +02:00
Thomas Heartman
db9a0e2c54 chore: merge main -> this branch 2022-03-08 13:58:16 +01:00
Thomas Heartman
fee4caf2f9 docs: Add note about how invalid context field values are handled 2022-03-08 13:44:02 +01:00
Thomas Heartman
c0eac49313 fix: delete empty table row 2022-03-08 13:34:11 +01:00
Thomas Heartman
419dda09a0 docs: Update description of currentTime in the Unleash context. 2022-03-08 13:31:55 +01:00
Thomas Heartman
2f6b067eb5 docs: Update SemVer section: clarify what requirements we have 2022-03-08 13:27:19 +01:00
Thomas Heartman
39d01f46ec docs: move string operator case sensitivity note to table 2022-03-08 12:57:09 +01:00
Thomas Heartman
774bed5bee fix: mark .NET sdk as not having currentTime context field 2022-03-08 12:53:56 +01:00
Thomas Heartman
4ce4a9c2d6 docs: remove 'introduced in' column in Unleash Context table. 2022-03-08 11:22:24 +01:00
Thomas Heartman
05187ce6a9 fix: remove placeholder comment 2022-03-08 11:20:06 +01:00
Thomas Heartman
94f13075ac docs: add unleash context and compat table updates 2022-03-08 11:14:55 +01:00
Thomas Heartman
decdc083d0 docs: finish first draft of new strat constraints doc. 2022-03-08 11:02:24 +01:00
Thomas Heartman
3f5e8524d3 docs: add availability note, finish first draft of constraint ops 2022-03-07 18:25:41 +01:00
Thomas Heartman
731d1374e1 docs: update "constraint structure" section 2022-03-07 17:21:25 +01:00
Thomas Heartman
1b19cac3fa docs: add description of each of the strat constraint operators. 2022-03-07 17:00:45 +01:00
Thomas Heartman
0b5b74ebab docs: start scaffolding out new constraint operator info 2022-03-07 15:39:32 +01:00
Dominik Chrastecky
2623fb17c4 Mark custom headers - function as supported in PHP SDK 2022-03-07 12:44:37 +01:00
Dominik Chrastecky
29c8f1ec72 Merge remote-tracking branch 'origin/main' into docs/php-compatibility-matrix 2022-03-07 12:42:16 +01:00
Thomas Heartman
c63c9b6fab docs: minor rewording and clarification around strategy impl/eval 2022-03-07 11:11:51 +01:00
Thomas Heartman
300c6abd74 fix: fix broken link in SDK list 2022-03-04 13:52:19 +01:00
Thomas Heartman
c88da63888
Merge pull request #1417 from Unleash/docs/add-offline-info-to-sdks 
docs: describe how sdks work in offline modes
 2022-03-04 13:50:49 +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
db7848680a
Merge pull request #1416 from Unleash/docs/clarify-activation-evaluation 
docs: reword and add additional deets re: activation strategy impl
 2022-03-04 13:10:03 +01:00
Thomas Heartman
6a4e2b7163 fix: change : to , 2022-03-04 13:04:40 +01:00
Thomas Heartman
f35a932e8d fix: stitch the info paragraph together with the existing content 2022-03-04 13:02:06 +01:00
Thomas Heartman
cda31e46d3 fix: remove unintended line break. 2022-03-04 12:56:55 +01:00
Thomas Heartman
28df5dcb31 docs: add offline headings / rough skeleton 2022-03-04 12:56:16 +01:00
Thomas Heartman
9b691a4f89 fix: fix broken link custom activation strategies doc. 2022-03-04 12:43:58 +01:00
Thomas Heartman
28b16d922d docs: reword and add additional deets re: activation strategy impl 2022-03-04 12:41:13 +01:00
Thomas Heartman
c15cbfc6d3
Merge pull request #1319 from Unleash/docs/describe-project-users-endpoints 
docs: describe `/api/admin/projects/:projectId/users/:userId/roles/:roleId` endpoint
 2022-03-04 12:10:11 +01:00
Thomas Heartman
cf2a8de161
Merge pull request #1342 from Unleash/docs/user-admin-send-email-props 
docs: Add payload properties for user-admin post payload
 2022-03-04 12:10:02 +01:00
Thomas Heartman
4705fe22cc docs: remove error payload that no longer applies. 2022-03-04 10:41:52 +01:00
Thomas Heartman
6d433c50ab docs: add info about requiring name OR email 2022-03-04 10:36:40 +01:00
Thomas Heartman
c9dd60e1ea
Apply suggestions from code review 
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
 2022-03-04 08:43:28 +01:00
Thomas Heartman
e6d939508d fix: correct the description of disabled variants 2022-03-04 08:20:55 +01:00
Thomas Heartman
4c4f6a3aaa docs: update description of sendEmail option 2022-03-03 15:24:15 +01:00
Thomas Heartman
38ed3816a8 docs: Remove doubled section and clarify role removal 2022-03-03 14:17:43 +01:00
Thomas Heartman
9da796eb90 docs: add details for change role endpoint. 2022-03-03 09:25:22 +01:00
Thomas Heartman
e84b8f30e1 docs: add correct return values for role deletion endpoints. 2022-03-03 09:25:22 +01:00
Thomas Heartman
92349b5561 Apply suggestions from code review 
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
 2022-03-03 09:25:22 +01:00
Thomas Heartman
81c6ef2d6e chore: align url parameters table. 2022-03-03 09:25:22 +01:00
Thomas Heartman
01f7293e2e docs: add description of the project users/roles endpoint 2022-03-03 09:25:20 +01:00
Thomas Heartman
f92d86061a docs(chore): improve syntax highlighting and formatting of code bits 
Use `bash` instead of `sh` for nicer highlighting by prism.

I've also broken large json blobs over multiple lines.
 2022-03-03 09:24:43 +01:00
sighphyre
010a699a19
Update website/docs/deploy/configuring-unleash.md 
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-03-02 14:09:50 +02:00
sighphyre
6de5fdb565 feat: allow startup to load client tokens from env var 2022-03-02 13:44:46 +02:00
Thomas Heartman
3302e66ab1 docs: remove "future enhancements" section of environments doc 
These things are either implemented or just around the corner now. I
suggest removing them to not be misleading anymore. Case in point: we
just had a customer asking us when the permissions system would be
ready because the docs say it's planned as a future improvement.
 2022-02-25 09:10:22 +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
Dominik Chrastecky
81e0b6c402 docs: update php compatibility matrix table 2022-02-18 20:12:19 +01:00
Thomas Heartman
c19278e8e8
Merge pull request #1376 from Unleash/docs/add-how-to-video-for-impression-data 
docs: Add how-to video for impression data
 2022-02-18 10:01:52 +01:00
Thomas Heartman
7c70dffd5b fix: add missing word 2022-02-17 10:32:34 +01:00
Thomas Heartman
f5c7f3a320 docs: Add how-to video for impression data 
This change adds a video to the impression data how-to guide
 2022-02-17 10:30:26 +01:00
Renato Arruda
50cbc78cd8
(docs) Ruby SDK now has a bootstrap impl 2022-02-17 07:58:52 +01:00
Thomas Heartman
c63d552576
Merge pull request #1345 from Unleash/docs/impression-data-how-to 
docs: Add "How to send impression data to your third-party sink" guide
 2022-02-11 12:36:53 +01:00
Thomas Heartman
ea7d599bad chore: add missing comma 2022-02-11 11:56:16 +01:00
Thomas Heartman
ebcab898e7 docs: Reference impression data from A/B testing doc 
Mention impression data in the A/B discussion topic.
 2022-02-10 16:35:29 +01:00
Thomas Heartman
e114025967 docs: reference A/B testing doc from impression data how-to 2022-02-10 16:26:57 +01:00
Thomas Heartman
812aa5c64c docs: reference how-to impression data from ref impression data 2022-02-10 16:26:44 +01:00
Thomas Heartman
9998e4cd63 chore: rename impression data how-to 2022-02-10 15:55:25 +01:00
Thomas Heartman
845168385b docs: Finish initial draft of how-to guide 2022-02-10 15:53:51 +01:00
Thomas Heartman
b56f809fb8 docs: rename file extension from .md to .mdx 2022-02-10 15:34:19 +01:00
Thomas Heartman
1eb4ae99ec docs: Clarify placeholder info. 2022-02-09 16:06:05 +01:00
Thomas Heartman
31b3792a11 docs: Add steps to enable impression events for existing toggles. 2022-02-09 16:03:32 +01:00
Thomas Heartman
752a1df343 docs: Add API request component: display in http and httpie easy! 
The ApiRequest component is created to make it easier to show code
samples for API requests. It shows them in raw HTTP form and with
HTTPie for now.
 2022-02-09 15:54:16 +01:00
Thomas Heartman
323b9e4247 docs: Add more outlines, steps, etc to how-to impression data 2022-02-09 14:20:24 +01:00
Thomas Heartman
a48d6af7e4 fix: fix google analytics link 2022-02-09 14:20:24 +01:00
Thomas Heartman
6ee9a4326c docs: Add impression data guide outline and sidebar entry 2022-02-09 14:20:24 +01:00
Thomas Heartman
0b69e1751e chore: remove trailing full stop. 2022-02-09 13:44:58 +01:00
Thomas Heartman
5a220caf39 docs: Add payload properties for user-admin post payload 
Adds an explanation of what the various properties in the payload
object to the `user-admin` endpoint does. Most seem fairly
self-explanatory, but I'm not entirely sure what `sendEmail` does.

Requires validation by a third party before merging.
 2022-02-09 09:05:24 +01:00
Ivar Conradi Østhus
1487ae10c6
docs: update compatibility matrix 2022-02-08 20:57:06 +01:00
Ivar Conradi Østhus
609422071f
docs: add "sendEmail" field to user-admin.md (#1329) 2022-02-08 20:47:01 +01:00
Christopher Kolstad
b0edddb283
fix: typo (#1346) 2022-02-08 14:57:52 +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
Ivar Conradi Østhus
2bc7b951b2
doc: Fix delete call for deleting feature toggles 
Fixes: #1330
 2022-02-04 12:56:58 +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
olav
73bd6a0bc4 docs: fix markdown file name 2022-02-01 16:00:56 +01:00
olav
e7a1bd86a4
docs: link directly to the markdown file 
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-02-01 15:53:16 +01:00
olav
1f6c91b517
docs: link directly to the markdown file 
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-02-01 15:52:21 +01:00
olav
1bba30a3de docs: fix link to getting started page 2022-02-01 14:49:55 +01:00
olav
8c09bf4fe5 docs: fix link to addons page 2022-02-01 14:49:52 +01:00
Thomas Heartman
b26869fec7
Merge pull request #1308 from Unleash/docs/add-video-component 
Docs: Add a new video component
 2022-01-27 13:37:11 +01:00
Thomas Heartman
0073de000e docs: remove redundant video heading and commented-out content. 2022-01-27 13:19:55 +01:00
Thomas Heartman
9ba9abbe29 docs: Update how-to for cprs with new video element. 2022-01-27 12:48:23 +01:00
Thomas Heartman
fdb435a6be
Merge pull request #1305 from aruizs/patch-1 
Doc: Add Unleash SDK for C++ to Community SDKs list.
 2022-01-27 10:03:09 +01:00
Thomas Heartman
73ee4c9250 docs(a11y): remove role 'alert' from availability notice. 
According to [MDN's article on the `alert`
role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Alert_Role),
`alert` should only be used for "information that requires the user's
immediate attention", such as the user's login session being about to
expire or the connection to the server being lost so that local
changes will not be saved.

They also add that:

> Warning: Because of its intrusive nature, the alert role must be used sparingly and only in situations where the user's immediate attention is required.

While availability may be an important (or at least relevant) piece of
information, I do not think it classifies as urgent or requiring
immediate attention.
 2022-01-27 09:59:38 +01:00
Antonio Ruiz
0f03bebcef Add Unleash SDK for C++ to Community SDKs list. 2022-01-27 09:53:08 +01:00
Thomas Heartman
0c6bbc215c docs: move video component to /src/components 2022-01-26 13:52:17 +01:00
Thomas Heartman
2c318546b6 docs: remove unnecessary wrapping divs. 2022-01-26 13:52:17 +01:00
Thomas Heartman
1a399fcabc docs: add video content component (to be moved) 2022-01-26 13:52:17 +01:00
Thomas Heartman
2259cc4e68 docs: add initial video component idea (+ cq polyfill) 
note: polyfill is currently broken for some reason 🤷
 2022-01-26 13:51:44 +01:00
Thomas Heartman
4c48d5bf89 chore: fix typo in introductory docs (missing accent) 2022-01-26 13:49:56 +01:00
Thomas Heartman
ee55f6a9fb docs: make top-level categories open by default, re-order references 2022-01-26 11:52:03 +01:00
Thomas Heartman
f62a65a23a docs: order the docs structure overview the same as the actual doc. 2022-01-25 12:25:08 +01:00
Thomas Heartman
f944a40d78 docs: Extend docs landing page; add more links, structure, etc. 2022-01-25 12:22:00 +01:00
Thomas Heartman
100e136951 docs: flesh out integrations category page. 2022-01-25 12:22:00 +01:00
Thomas Heartman
ea0ff8f991 docs: Potential fix to SSO guide ordering (with deprecated guides) 2022-01-25 12:22:00 +01:00
Thomas Heartman
3dec1ee7b2 docs: remove emoji, add placeholder links to landing page. 2022-01-25 12:22:00 +01:00
Thomas Heartman
6d43b93be2 docs(chore): fix broken links to control_rollout 2022-01-25 12:22:00 +01:00
Thomas Heartman
5e556bc87d Rename all how-to guides to start with 'how to'. 2022-01-25 12:22:00 +01:00
Thomas Heartman
286edba290 docs: place emoji before their following headings 2022-01-25 12:22:00 +01:00
Thomas Heartman
e43f1dd60f docs: delete control-rollout, redirect to activation strategies 2022-01-25 12:22:00 +01:00
Thomas Heartman
50d0f39140 docs: add content from control rollout to activation strategies 
The two documents covered almost the exact same things (and even had
the same text. verbatim!).
 2022-01-25 12:22:00 +01:00
Thomas Heartman
4848104ec8 docs: move all docs into sidebar 2022-01-25 12:22:00 +01:00
Thomas Heartman
ca7657e424 docs: change title of addons index doc. 2022-01-25 12:22:00 +01:00
Thomas Heartman
19eea8b3a2 docs: rename doc introduction. 2022-01-25 12:21:00 +01:00
Thomas Heartman
24e614c977 docs: start restructuring the docs landing page. 2022-01-25 12:20:06 +01:00
Dtaggart
59cd88d720
docs: Update getting-started.md (#1294) 
Correct password spelling. Was missing w
 2022-01-24 09:27:50 +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
Thomas Heartman
d27542bb5d
Merge pull request #1281 from Unleash/docs/add-cpr-vids 
docs: Add how-to videos to cpr how-tos
 2022-01-20 12:44:37 +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
Thomas Heartman
3ce2ea0f61 docs: simplify text 2022-01-19 15:08:25 +01:00
Thomas Heartman
c113081866 docs: Add how-to videos to cpr how-tos 
For simplicity I've added them as separate sections, but I'd love for
them to be listed higher up.
 2022-01-19 15:05:28 +01: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
184a18ba41
Merge branch 'master' into chore/update-workflows 2022-01-18 11:16:24 +01: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
e8a3d6e6f1
Merge pull request #1238 from Unleash/docs/custom-project-roles 
docs: describe new custom project roles
 2022-01-14 12:28:45 +01:00
Thomas Heartman
55a7cefc53 docs: add note about when the new configuration option was added. 2022-01-14 12:20:31 +01:00
Thomas Heartman
39e79c064f
Apply suggestions from code review 
Co-authored-by: sighphyre <liquidwicked64@gmail.com>
 2022-01-14 11:28:47 +01:00
Thomas Heartman
7897ee2e87 docs: add how-to screenies for cpr 2022-01-14 10:59:18 +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
308f5ab4d3 docs: add new cpr permissions, update existing ones 2022-01-14 08:23:17 +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
Thomas Heartman
211de55bb7 docs: add new disableLegacyFeaturesApi config option. 2022-01-12 14:20:45 +01:00
Thomas Heartman
d99602355e docs(chore): sort configuration options alphabetically. 2022-01-12 14:01:13 +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
6944688671
Merge pull request #1249 from Unleash/docusaurusVersionBump 
Upgrade docusaurus to 2.0.0.beta.14 from beta.9
 2022-01-11 10:53:36 +01:00
Thomas Heartman
4917287098 fix(docs): fix broken links to addons 2022-01-11 10:43:34 +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
Thomas Heartman
53001a47f8 docs: update steps to edit roles. 2022-01-10 14:38:03 +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
eb08fb4c89 docs: improve wording of how-to for cprs. 2022-01-07 13:45:12 +01:00
Thomas Heartman
3fd31ced01 docs: first draft basic how-to for creating/assigning cprs 2022-01-07 12:08:55 +01:00
Thomas Heartman
575ad1093e docs: add dummy how-to; link from reference docs 2022-01-07 11:49:33 +01:00
Thomas Heartman
5573af675e docs: restructure startup import section to group actions by intent 
This groups ways of importing together and ways of dropping together
instead of grouping the instructions by whether they use env variables
or command line options.

Should (?) make it easier to find what you want, but most importantly:
means we only need to explain the database drops once.
 2022-01-07 08:03:49 +01:00
Thomas Heartman
5566d33e23 docs: add info on variants to project permissions. 2022-01-06 15:03:45 +01:00
Thomas Heartman
72fc329d15 docs: explain what the project and env permissions mean for CPR 2022-01-06 14:44:18 +01:00
Thomas Heartman
ccc46ab832 docs: revamp the rbac article; add roles table, describe CPR. 2022-01-06 14:26:04 +01:00
Thomas Heartman
45fe483924 docs: add placeholder how-to-guide for custom project roles 2022-01-06 12:34:20 +01:00
Thomas Heartman
cc6d073bb5 docs: update version tag for when CPR* is expected to be released 
* custom project roles
 2022-01-06 12:33:33 +01:00
Thomas Heartman
fd3333bfeb docs: add initial stub for custom project roles to rbac article. 2022-01-06 11:22:11 +01:00
Thomas Heartman
72bbcaf517 docs: change wording slightly. 2022-01-06 10:57:39 +01:00
Thomas Heartman
70b9a2d37e docs: add information on using env vars for startup imports. 2022-01-06 10:54:31 +01:00
Thomas Heartman
d027c0ed7b docs: add difference between initApiTokens and env var option. 2022-01-05 11:30:04 +01:00
Thomas Heartman
e73f3c6aa7 docs(fix): add description of open-source authentication type. 2022-01-05 11:21:55 +01:00
Ivar Conradi Østhus
66d4aa61de
fix: correct format for API tokens 2022-01-05 10:40:22 +01:00
Ivar Conradi Østhus
ce1cc8f3a8
doc: minor language improvements 2022-01-05 10:23:16 +01:00
Juraj Malenica
e757c00840
feat: Add init api tokens option (#1181) 
Adds support for initializing a fresh Unleash instance with predefined API tokens. 

Co-authored-by: sighphyre <liquidwicked64@gmail.com>
Co-authored-by: Juraj Malenica <juraj.malenica@mindsmiths.com>
Co-authored-by: Ivar Conradi Østhus <ivarconr@gmail.com>
 2022-01-05 10:00:59 +01:00
Thomas Heartman
be3452e36f
Merge pull request #1221 from Unleash/docs/add-npm2yarn 
docs: add `npm2yarn` annotation to all npm commands
 2022-01-04 14:00:43 +01:00
Thomas Heartman
1241827b6a docs(chore): remove spacing, change 'node' -> Node.js 2022-01-04 10:19:32 +01:00
Thomas Heartman
7444b2cb74 docs(chore): add npm2yarn annotation to all npm commands 2022-01-04 10:18:13 +01:00
Thomas Heartman
0344dc79e4 docs(typo): pluralize SDK -> SDKs 2022-01-03 14:42:59 +01:00
Thomas Heartman
5a30706150 docs(fix): fix comparison operator from > to < 2022-01-03 13:08:25 +01:00
Thomas Heartman
dd975ec344 docs: highlight customStrategies option. 2022-01-03 10:26:29 +01:00
Thomas Heartman
bdbd659a71 docs(chore): indent code block properly. 2022-01-03 10:19:04 +01:00
Thomas Heartman
8ae2de8a3e docs: add steps for running the proxy in node with custom strats. 2022-01-03 10:12:13 +01:00
Anton Vasin
8bc9264e4a Fix typo in Webhook docs 2021-12-24 14:18:43 +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
14081c014e chore(workflows): update with new branch names 2021-12-23 14:12:19 +01:00
Thomas Heartman
e63c855497 chore: format table 2021-12-23 11:42:57 +01:00
Thomas Heartman
37387bc3d1 docs(strats): update param type overview 2021-12-23 11:42:34 +01:00
Thomas Heartman
68df8e50f8 docs(strats): mention required params 2021-12-23 11:26:18 +01:00
Thomas Heartman
b83a45fc59 fix(docs): realign indentation of code and comments 
Seems something went wrong the last time 🤷
 2021-12-22 14:21:04 +01:00
Thomas Heartman
120345953a fix(docs): align code and highlight indentation. 2021-12-22 14:20:07 +01:00
Thomas Heartman
2b08b6f67b docs(strats): describe using custom strats when proxy is not docker. 2021-12-22 13:24:22 +01:00
Thomas Heartman
4d63ed01a8 fix: fix broken link to how-to guide. 2021-12-22 13:24:14 +01:00
Thomas Heartman
0892b1aca0 docs(custom strats): add note to proxy docs about custom strats. 2021-12-22 13:23:34 +01:00
Thomas Heartman
30c6e7c0af docs(custom strats): add steps for custom strats with proxy. 2021-12-22 12:37:40 +01:00
Thomas Heartman
d60dcfa9d4 docs(strats): start filling in how-to for custom strats 2021-12-22 11:36:08 +01:00
Thomas Heartman
adc429c90c docs(strats): semi-scaffold how-to section 2021-12-22 09:59:35 +01:00
Thomas Heartman
6d7fabb4c3 docs(activation strats): add note about unimplemented strats. 2021-12-22 09:59:35 +01:00
Thomas Heartman
9791783be5 docs(strats): separate reference and how-to 2021-12-22 09:59:32 +01:00
Thomas Heartman
caa5ae15c1 docs(custom strats): adjust heading levels, add ideas. 2021-12-22 09:58:50 +01:00
Thomas Heartman
daeb73af48 chore: remove unnecessary escape sequences. 2021-12-22 09:58:50 +01:00
Thomas Heartman
73b05ec415
Merge pull request #1200 from Unleash/docs/unleash-context 
docs: Flesh out Unleash Context, Strategy constraints, add how-to guides for both
 2021-12-22 09:50:03 +01:00
Thomas Heartman
4585efc036 docs(context): update availability notes for custom context fields. 2021-12-20 15:20:57 +01:00
Thomas Heartman
ffb8e09246 docs(constraints): update how-to doc title for strat constraints. 2021-12-20 14:55:38 +01:00
Thomas Heartman
4f4c092147 docs(context): add link to how-to guide for strat constraints. 2021-12-20 14:51:32 +01:00
Thomas Heartman
8d350f447c docs(context): update strat constraints with SDK info. 
I'm not entirely sure this is the place to put this section, but it
works for now. It should probably be a separate how-to in the end.
 2021-12-20 14:39:09 +01:00
Thomas Heartman
d2981d7b51 docs(context): add note about creating standard context fields. 2021-12-20 14:28:20 +01:00
Thomas Heartman
498ac4ff6d docs(context): spilt strat constraints into ref and how-to. 2021-12-20 14:28:00 +01:00
Thomas Heartman
1c5d48ec93 docs(context): add note to context docs re: creating and updating. 2021-12-20 13:07:33 +01:00
Thomas Heartman
429426d793 docs(context): full draft for how to create custom context fields. 2021-12-20 13:06:32 +01:00
Thomas Heartman
6b7f4f3544 docs(context): rough draft of how to create custom context fields. 2021-12-20 12:54:59 +01:00
Thomas Heartman
9a06899ce6 docs(fix): reference the SDK compat table in stickiness docs 2021-12-20 12:54:35 +01:00
Thomas Heartman
41035358b7 docs(context): add img of legal values' effect on the UI. 2021-12-20 12:53:41 +01:00
Thomas Heartman
404a5bd390 docs(context): add custom stickiness section to context docs. 2021-12-20 11:25:47 +01:00
Thomas Heartman
ae885b3eff docs(fix): fix quickstart image not being displayed. 
The issue was that the image link was encased in an extra set of
brackets. However, the extra bracket set was added because docusaurus
wouldn't compile otherwise. Instead it complained about an
unterminated string literal in the alt text.

As it turns out, this had nothing to do with the contents of the alt
text, but rather with the fact that the alt text was split over
multiple lines.
 2021-12-20 08:36:57 +01:00
Thomas Heartman
2431cf8e22 docs(context): add note about custom stickiness being in beta. 2021-12-20 08:29:27 +01:00
Thomas Heartman
2cc309fec9 docs(context): add custom stickiness header. 2021-12-17 14:03:42 +01:00
Thomas Heartman
e1d1ee2718 docs(context): Update doc; add how-to make custom context fields. 2021-12-17 14:03:42 +01:00