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
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
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
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
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
Thomas Heartman
df74d29f1e
docs: adjust variant outline; add rough ideas.
2021-12-01 10:35:05 +01:00
Thomas Heartman
f83ffb6746
Merge pull request #1144 from Unleash/docs/document-proxy-payload-format
...
docs: describe the shape of the data returned by the Unleash proxy
2021-12-01 09:24:24 +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
2898b77dd6
docs: Add section on (potentially) stale toggles to tech debt
...
Previously, when you searched for 'stale toggle' in the docs, the
first result would be the API docs and it'd be hard to find any form
of explanation of what a stale toggle is at all.
To combat that, this commit adds a section to the tech debt chapter
explaining what they are.
2021-11-29 14:55:50 +01:00
Thomas Heartman
736faaca5b
docs: typo; change "metics" -> "metrics"
2021-11-29 08:40:59 +01:00
Thomas Heartman
1af8b23149
docs: remove references to environments being a beta feature.
...
Also specify that if you're on version 4.3, you don't need to do anything.
2021-11-26 13:53:46 +01:00
Thomas Heartman
7bfe306545
Merge branch 'master' into docs/detail-health-rating-updates
2021-11-26 11:07:48 +01:00
Thomas Heartman
1ac46ec3c1
docs: Clarify that health rating is only updated once an hour.
...
This commit also gives health rating its own, separate headline. This
should improve searchability 🤞
2021-11-25 10:45:47 +01:00
Thomas Heartman
c5129e00d7
Merge branch 'master' into docs/fix-internal-links
2021-11-25 09:10:57 +01:00
Thomas Heartman
e8478126a5
Merge branch 'master' into docs/add-stickiness
2021-11-24 13:59:56 +01:00
Thomas Heartman
42b1f44d84
docs: add note about Unleash using MurmurHash for stickiness.
2021-11-24 13:41:25 +01:00
Thomas Heartman
d58ed5f84b
Apply suggestions from code review
...
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
2021-11-24 13:39:02 +01:00
Christopher Kolstad
6c6001619c
Feat/variant api ( #1119 )
...
Add a new .../:feature/variants API
This adds
- `GET /api/admin/projects/:projectId/features/:featureName/variants` which returns
```json
{ version: '1', variants: IVariant[] }
```
- `PATCH /api/admin/projects/:projectId/features/:featureName/variants` which accepts a json patch set and updates the feature's variants field and then returns
```json
{ version: '1', variants: IVariant[] }
```
- `PUT /api/admin/projects/:projectId/features/:featureName/variants`
which accepts a IVariant[] and overwrites the current variants list for the feature defined in :featureName and returns
```json
{ version: '1', variants: IVariant[] }
- This also makes sure the total weight of all variants is == 1000
- Validates that there is at least 1 'variable' variant if there are variants
- Validates that 'fix' variants total weight can't exceed 1000
- Adds tests for all these invariants.
Co-authored-by: Simon Hornby <simon@getunleash.ai>
2021-11-24 13:08:04 +01:00
Thomas Heartman
8b50696e99
docs: use internal links for linking to other doc pages.
2021-11-24 13:02:06 +01:00
Thomas Heartman
c077860d54
docs: Remove link to non-existing page about sdk capabilities.
2021-11-24 12:04:33 +01:00
Thomas Heartman
9c0848b053
docs: fix links to old versions of pages; link to new versions.
2021-11-24 12:03:31 +01:00
Thomas Heartman
6634d1d580
docs: fix a typo in activation strategies: use -> user
2021-11-24 11:52:27 +01:00
Thomas Heartman
d15cb50792
docs: update stickiness docs.
2021-11-24 11:52:17 +01:00
Thomas Heartman
eadf118759
docs: delete old unleash-context doc.
...
Similar to the activation strategy page: this seems to be deprecated
and was not listed in the sidebar. There is also a newer, more fleshed
out version that _does_ appear in the sidebar instead.
2021-11-24 11:27:55 +01:00
Thomas Heartman
b9325c89fb
docs: delete old activation strategies file.
...
This file has not been touched in a while and seems to be superseded
by the new file by the same name in the `user_guide` directory.
2021-11-24 10:59:47 +01:00
Thomas Heartman
7274474792
docs: remove link to old activation strategies document.
2021-11-24 10:53:56 +01:00
Thomas Heartman
7fe74c1358
docs: update reference to gradual rollout (was 'flexible rollout')
2021-11-24 10:48:02 +01:00
Thomas Heartman
ff4114e7d2
Merge branch 'master' into docs/more-feature-toggle-type-info
2021-11-24 08:47:16 +01:00
Thomas Heartman
df742279a5
Apply suggestions from code review
...
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
2021-11-24 08:33:31 +01:00
Thomas Heartman
9075261d30
docs: add basic info to stickiness.
2021-11-23 14:59:23 +01:00
Thomas Heartman
7056d516b4
fix: image inclusion and alt text syntax was wrong.
...
Turns out the image description needed to be wrapped in an extra pair
of square brackets and that quotes must be escaped or removed.
2021-11-23 14:18:35 +01:00
Thomas Heartman
9268b333ef
docs: add initial outline id for custom stickiness.
2021-11-23 14:08:35 +01:00
Thomas Heartman
c7c4ad9963
docs: touch up the section on deprecating feature toggles.
2021-11-23 13:36:36 +01:00
Thomas Heartman
6962f39cc1
docs: link to feature-flag-types from important concepts.
2021-11-23 11:53:34 +01:00
Thomas Heartman
5fc02a10d3
docs: fix internal links.
2021-11-23 11:53:23 +01:00
Thomas Heartman
aef10d1d83
docs: first pass at updating the feature toggle types entry.
2021-11-23 11:15:20 +01:00
Fredrik Oseberg
a12250aa0a
docs: add always pull to getting started
2021-11-23 09:43:35 +01:00
Fredrik Oseberg
6f062e4d66
docs: add always pull to docker commands
2021-11-23 09:40:05 +01:00
Thomas Heartman
7fdb53f664
Docs: add a tip about docker names having to be unique.
2021-11-23 09:08:19 +01:00
Thomas Heartman
c1e225ea9b
docs: fix up docker commands to have consistent formatting.
...
Moved each option onto its own line, the last two options are always
`--network` and then `--name`.
2021-11-23 08:08:23 +01:00
Thomas Heartman
98cdc1674f
docs: add initial (untested) steps on how to run the proxy locally.
...
I haven't yet tested connecting to the `unleash:4242` address.
2021-11-22 16:16:38 +01:00
Christopher Kolstad
52ae753466
docs: remove jira cloud plugin docs for now ( #1118 )
2021-11-22 11:43:06 +01:00
jonkjenn
e4e8d12ca7
Docs: Update feature-toggles-api.md ( #1105 )
...
Co-authored-by: Ivar Conradi Østhus <ivarconr@gmail.com>
2021-11-15 22:36:25 +01:00
Simmon Hornby
000cb3bb69
docs: Improve readability of jira server installation plugin slightly
2021-11-12 16:56:25 +02:00
sighphyre
152dac0a37
Update website/docs/integrations/jira-server-plugin-usage.md
...
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2021-11-12 16:54:03 +02:00
sighphyre
afca898924
Update website/docs/integrations/jira-server-plugin-usage.md
...
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2021-11-12 16:53:48 +02:00
sighphyre
7a72a7a4ce
Update website/docs/integrations/jira-server-plugin-installation.md
...
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2021-11-12 16:53:29 +02:00
sighphyre
43cf86ed6f
Update website/docs/integrations/jira-server-plugin-installation.md
...
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2021-11-12 16:53:06 +02:00
