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
Christopher Kolstad
061fc560ab
docs: added screenshot successful install
2021-11-12 15:40:10 +01:00
Christopher Kolstad
fd421a677d
Merge branch 'master' into docs/jiraServerPlugin
2021-11-12 15:37:52 +01:00
Christopher Kolstad
614d71b464
docs: mark Jira Cloud plugin as not recommended
2021-11-12 14:12:03 +01:00
Christopher Kolstad
00558a28d4
docs: Add docs for Jira server plugin
2021-11-12 14:00:41 +01:00
Ivar Conradi Østhus
d8478dd928
feat: clean up events ( #1089 )
...
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
2021-11-12 13:15:51 +01:00
Thomas Heartman
b37918c20e
Merge branch 'master' into doc/environments-polish
2021-11-12 09:56:36 +01:00
Christopher Kolstad
7409f679f2
docs: Updated maven coordinates for java sdk
2021-11-12 08:34:11 +01:00
Thomas Heartman
77890bf88a
docs: add notes about users having to add strats to enable envs.
2021-11-12 08:33:55 +01:00
Thomas Heartman
854f2d5d65
docs: add paragraph to intro: things will still work (default env)
2021-11-12 08:26:19 +01:00
Thomas Heartman
b776984187
docs: simplify language + pre-configure -> preconfigure
2021-11-12 08:25:55 +01:00
Thomas Heartman
257497153c
Use absolute URL for intra-doc link.
...
I don't know how this works in docusaurus 🤷
2021-11-11 15:41:54 +01:00
Thomas Heartman
8a41799731
docs: Polish text on environments.
...
There's a number of small text adjustments and typo fixes in here with
the goal of clarifying how environments and the migration process work.
2021-11-11 15:36:41 +01:00
Nikolay Shebanov
e1df5696cd
Wrap the client into an event listener in the quickstart doc ( #1079 )
2021-11-11 13:20:19 +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
d0b2ce3170
fix: add enpoint for fetching a single user ( #1074 )
...
* fix: add enpoint for fetching a single user
* fix add api docs
2021-10-28 14:24:09 +02:00
Ivar Conradi Østhus
131eeeaa78
fix: demo-auth should use /auth path
2021-10-26 23:04:44 +02:00
Ivar Conradi Østhus
d5bc0c6f76
docs: minor typo
2021-10-26 11:32:19 +02:00
Ivar Conradi Østhus
a9bfe47c88
chore: add video to envrionments
2021-10-26 11:25:19 +02:00
Ivar Conradi Østhus
ffec4f6342
fix: rename websitev2 to website
2021-10-26 11:25:19 +02:00
