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
299afd97ff
docs(chore): update images; remove empty space.
2022-01-14 11:09:32 +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
9fbfc28a72
docs: add Rust SDK to sidebar list of official sdks.
2022-01-13 10:38:20 +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
b8f3313ae2
docs: group sdks into non-collapsible categories: server and client
2022-01-13 09:21:13 +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
Thomas Heartman
12e78663b0
Merge pull request #1260 from Unleash/rarruda-patch-1
...
Update ruby SDK capabilities
2022-01-12 10:56:19 +01:00
Thomas Heartman
5896b65087
Merge pull request #1259 from Unleash/docs/sort-sdks-sidebar
...
docs: sort SDKs sidebar
2022-01-12 10:55:54 +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
29ed242df6
docs(fix): add missing commas
2022-01-11 10:38:22 +01:00
Thomas Heartman
adec5aa25c
docs: add redirect from old integrations url
2022-01-11 10:36:23 +01:00
Thomas Heartman
c3c7e1b4bb
docs: update link to integrations
2022-01-11 10:35:25 +01:00
Thomas Heartman
b2a8bc1655
docs: reorder sdks listing in sidebar
...
The previous list order didn't seem to have any reason behind it. This
is a suggestion for new order.
Index (the introduction) is first, followed by the proxy. Then comes
all the official sdks in alphabetic order (punctuation placed before
alpha). At the end of the list is the 'community sdks' link.
I'm open to suggestions and discussion here, but was working on this
list, so thought it could use some love.
2022-01-11 10:07:24 +01:00
Thomas Heartman
e1ba5f2e11
docs: reuse pre-existing redirect to /sdks
2022-01-11 09:53:06 +01:00
Thomas Heartman
eb89d4505d
docs: add link to /sdks/community-sdks
...
This serves two purposes:
1. For people who know the structure, it won't look like anything's
missing
2. For people who don't know the structure, it'll make community sdks
more discoverable.
2022-01-11 09:22:30 +01:00
Thomas Heartman
f404c37f97
docs(chore): Update headings, slight sdk doc restructure.
2022-01-11 09:17:07 +01:00
Thomas Heartman
2488124ac6
docs(chore): add redirect from '/sdks/community' to '/sdks'
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
Renovate Bot
145a587d62
fix(deps): update dependency @svgr/webpack to v6.2.0
2022-01-10 11:39:38 +00:00
Christopher Kolstad
76d590d009
Upgrade docusaurus to 2.0.0.beta.14 from beta.9
2022-01-10 11:39:55 +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
renovate[bot]
e1139a4847
fix(deps): pin dependency @docusaurus/remark-plugin-npm2yarn to 2.0.0-beta.14 ( #1224 )
...
Co-authored-by: Renovate Bot <bot@renovateapp.com>
2022-01-04 16:06:48 +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
Thomas Heartman
291e8689fb
docs(sdks): gradual rollout: custom stickiness -> point to SDK table
...
It appears that we've forgotten to update this bit of info regarding
the SDKs' compatibility. To avoid having the same data in multiple
places, let's instead point the user to the compat table.
2021-12-17 13:46:54 +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
e061ccccb4
Merge pull request #1186 from Unleash/docs/4.3-minor-updates
...
docs: update existing articles and screenshots to match version 4.3
2021-12-15 10:58:54 +01:00
Thomas Heartman
9a370cb25c
Merge pull request #1185 from Unleash/docs/4.3-update-strat-constraints
...
docs: update strategy constraints for 4.3
2021-12-15 10:56:21 +01:00
Thomas Heartman
aa80cba222
chore: lowercase <br/> tag
...
Don't know why it got uppercased 🤷
2021-12-15 10:27:11 +01:00
Thomas Heartman
5b97ef6996
chore: unhyphenate kebab-menu -> kebab menu
2021-12-15 10:23:52 +01:00
Thomas Heartman
7a0e9aaf63
Apply suggestions from code review: missing comma
...
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
2021-12-15 10:22:41 +01:00
Thomas Heartman
5653331eea
docs(4.3): update tech debt section.
2021-12-14 14:23:39 +01:00
Thomas Heartman
d59d2f141e
docs(4.3): update the custom strategy documentation.
2021-12-14 14:13:24 +01:00
Thomas Heartman
74aa185392
docs(4.3): update control-rollout document.
2021-12-14 14:03:28 +01:00
Thomas Heartman
18da69ede0
docs(4.3): update text (and add alt text) in projects document.
2021-12-14 13:47:47 +01:00
Thomas Heartman
23d06264a1
docs(4.3): update project images.
2021-12-14 13:30:06 +01:00
Thomas Heartman
cfeef6b4ba
docs(4.3): update environments section.
2021-12-14 12:33:29 +01:00
Thomas Heartman
c9ef7c1f44
docs(4.3): update API access document.
2021-12-14 12:19:19 +01:00
Thomas Heartman
bfeb19f5f1
docs(4.3): update audit log chapter.
2021-12-14 12:10:04 +01:00
Thomas Heartman
c0b5f27a3c
docs(4.3): Update archive page.
2021-12-14 11:52:57 +01:00
Thomas Heartman
de420dde14
docs(4.3): update variants screenshot
2021-12-14 11:30:59 +01:00
Thomas Heartman
915be4c2ed
docs(4.3): update strategy constraints documentation.
2021-12-14 11:19:16 +01:00
Thomas Heartman
b86ffb9bc9
Merge pull request #1172 from Unleash/docs/a-b-testing-discussion
...
docs: Add topic guide for A/B testing
2021-12-13 13:18:40 +01:00
Thomas Heartman
23dafcb230
docs(4.3): delete env strat constraint image, rewrite paragraph.
2021-12-13 12:44:11 +01:00
Thomas Heartman
ead86ed621
docs(a/b-testing): rename 'concepts' -> 'topics'
2021-12-13 12:33:47 +01:00
Renovate Bot
ba6ed24e18
fix(deps): update dependency @svgr/webpack to v6.1.2
2021-12-12 18:16:19 +00: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
49e6323a1a
Apply suggestions from code review
...
Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2021-12-10 13:53:49 +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
e4d0c4fb50
docs(variants): rename 'discussion' -> 'concepts'
2021-12-09 12:07:25 +01:00
Thomas Heartman
735b8996a1
docs(variants): rename A/B testing file
2021-12-09 12:02:37 +01:00
Thomas Heartman
19ae282e09
docs(variants): first draft of a/b testing discussion
2021-12-09 12:01:12 +01:00
Thomas Heartman
9e7f48931a
docs(variants): add discussion topic on a/b testing
2021-12-09 11:34:02 +01:00
Thomas Heartman
2fa5b3c0a8
Merge pull request #1167 from Unleash/docs/variant-reference-docs
...
docs: Improved reference docs for variants
2021-12-08 11:03:06 +01:00
Thomas Heartman
15c5997707
docs(variants): clarify weight distribution
2021-12-08 10:35:52 +01:00
Thomas Heartman
aef303c3b9
Apply suggestions from code review
...
Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2021-12-08 10:30:21 +01:00
Thomas Heartman
a761bf2cc7
docs(variants): conflicting overrides; rm usage
2021-12-08 10:08:35 +01:00
Thomas Heartman
b5b8c5eb2d
docs(variants): stickiness, disabled variant.
2021-12-07 14:26:42 +01:00
Thomas Heartman
16c32552d5
docs: add some first info on overrides.
2021-12-07 14:02:15 +01:00
Thomas Heartman
80afb25999
docs: document variant payloads.
2021-12-07 13:53:19 +01:00
Thomas Heartman
69005af33e
docs: finish variant weight reference documentation
2021-12-07 13:43:57 +01:00
Thomas Heartman
4b6f166e95
docs: start documenting variant properties and weights
2021-12-07 13:32:11 +01:00
Ivar Conradi Østhus
642a2371ef
fix: updated API docs to reflect v4.3
2021-12-06 15:31:50 +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
dd08e9da38
chore: Fix syntax highlighting for a json code snippet.
2021-12-06 12:35:45 +01:00