1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
Commit Graph

461 Commits

Author SHA1 Message Date
Thomas Heartman
b3320bf74b
docs: update segments availability notices (#1729)
* docs: change segment availability notice

* docs: update availability note + add some prettier changes

* docs: format imports with prettier
2022-06-22 10:53:24 +02:00
Thomas Heartman
bb3c722f67
Docs: Update description for create + update user (#1727)
* Docs: Update description for create + update user

This change updates the documentation for the user creation API,
fixing errors mentioned in #1717:

- it's either `username` or `email` that is required on creation.
`name` is not required.
- `name` is the only required field when updating a user.

* docs: Fix overzealous prettier formatting

* docs: updated requirements for put: name OR email
2022-06-17 13:50:39 +02:00
Thomas Heartman
5a3f418e13
docs: add feature toggle reference, new how-to (#1694)
* Docs: write down the currently available steps

* docs: quick updates to the projects page.

* docs: further scaffold the how-to guide

* docs: add feature-toggle.mdx (toggle reference doc)

* docs: Add note that feature toggle names must be unique

* docs: add API doc links

* docs: delete old content

* docs: delete old images

* docs: update variants text

* docs: update introduction

* docs: add new images, update api annotations

* docs: add links to context fields, improve link text for other links.

* docs: remove redundant wording.

* docs: fix default project for toggles

* docs: typo: singular -> plural

* docs: mention admin ui curl command

* docs: remove leftover words

* docs: improve linking to default project.

* Apply suggestions from code review

Co-authored-by: sighphyre <liquidwicked64@gmail.com>

* Apply suggestions from code review

Co-authored-by: sighphyre <liquidwicked64@gmail.com>

* docs: clarify constraint timing

* docs: apply suggestion from code review

* docs: add link to variants document

* docs: Add sections on environments and projects, link from ft docs

* docs: minor rewording into unleash context.

* docs: remove misleading section about "all strats evaluated"

* docs: evaluate -> resolve

Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-17 12:36:19 +02:00
Christopher Kolstad
45c3df0598
docs: SDK Synchronization tips (#1720)
* docs: SDK Synchronization tips

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

* docs: Update csharp example with tabs

* docs: update java docs with tabs and sync examples

* docs: update node docs for sync init

* docs: remove plea to pay attention to env config option

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-06-15 09:49:56 +00:00
Christopher Kolstad
705eee654f
fix: pleas -> please (#1706) 2022-06-14 15:16:58 +02:00
sighphyre
18e63d5ea3
feat: add support for handling non standard postgres dates (#1689)
* feat: add support for handling non standard postgres dates

* docs: update some http docs links to point to their respective https versions

* chore: refactor non standard date handling callback code to be a little clearer

* Update website/docs/deploy/configuring-unleash-v3.md

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

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-06-10 08:47:31 +02:00
Ivar Conradi Østhus
3d84668ba2
doc: proper api protection in google auth example. (#1688)
fixes: #1679
2022-06-09 13:01:15 +02:00
Christopher Kolstad
37211491e7
feat: default to memoizing client features (#1674) 2022-06-08 09:43:37 +02:00
Thomas Heartman
fa74f81aa5
fix: env drop event data.name + /api/admin/events docs (#1662)
* docs: add all /events endpoints and query params

* docs: events page skeleton structure

* docs: correct description of event payloads

* docs: add table with event properties.

* docs: remove duplicate table.

* docs: sort property table

* docs: more work on adding events: feature events

* docs: add examples for most feature events

Still missing are: events that require imports, and
feature-project-change

* docs: scaffold out all events descriptions

* docs: normalize casing

* docs: add brief descriptions to strategy and context events

* docs: Add remaining non-import event descriptions and examples

* docs: add code sample annotations for all example events.

* docs: remove all references to myself

* docs: change "toggle" -> "feature", adjust headings

The headings aren't semantic for this doc yet. We'll need to create a
new document for this.

* docs: update event type description table

* docs: change header level of event type section

* docs: add details around feature-project-change event

* docs: add import type events

* docs: use a better `createdBy` name

* docs: "sort" events so that they're in a consistent order.

* docs: remove reference to ID in addon-config-created event

* fix: drop-environments data.name all-projects -> all-environments

This is probably a bug. Should be double checked.

* docs: clarify that `data.name` is always `all-x` on drop events

* Apply suggestions from code review

Co-authored-by: sighphyre <liquidwicked64@gmail.com>

Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-07 11:33:30 +01:00
Pfuenzle
4ca0de27e5
docs: Add deprecation notice to eventHook (#1618)
* Add deprecation notice to eventHook

* Update website/docs/deploy/configuring-unleash.md

Co-authored-by: Thomas Heartman <thomasheartman+github@gmail.com>

* Added proxy documentation

* Update configuring-unleash.md

* Update website/docs/deploy/configuring-unleash.md

Co-authored-by: Thomas Heartman <thomasheartman+github@gmail.com>

Co-authored-by: Thomas Heartman <thomasheartman+github@gmail.com>
2022-06-03 14:03:45 +02:00
Christopher Kolstad
606270d86a
feat: Allow extra CSP domains (#1610)
* feat: Allow extra CSP domains

Co-authored-by: Fredrik Oseberg <fredrik.no@gmail.com>

* fix: eslint:

* fix: allow partial csp domains

* fix: add option and config type

* fix: snapshot

Co-authored-by: Fredrik Oseberg <fredrik.no@gmail.com>
2022-05-31 11:32:15 +02:00
Sebastian Bury
bde6294e44
Update feature-toggles-archive-api.md 2022-05-30 16:26:02 +02:00
Nuno Góis
40c920f184
docs: use named export instead of default (#1615) 2022-05-20 10:31:05 +01:00
Nuno Góis
46c253b964
docs: use named export instead of default (#1614) 2022-05-20 11:22:14 +02:00
Nuno Góis
16860c1469
docs: update import to use named export instead of default (#1609)
See: https://github.com/Unleash/proxy-client-react/pull/58
2022-05-20 07:48:01 +01:00
Thomas Heartman
a6753d9af3
docs: switch all slack links to slack.unleash.run (#1613) 2022-05-20 08:17:36 +02:00
Andreas Fauske
70f58b3a84
Update dot_net.md (#1598)
Fixed a typo.
2022-05-19 14:59:36 +02:00
Thomas Heartman
d384a76a28
docs: fix python sdk syntax highlighting, header levels (#1596)
* docs: fix python sdk syntax highlighting, header levels
* docs(fix): remove invalid toggle names
2022-05-16 10:30:28 +02:00
Thomas Heartman
943af1e804
docs: Update the react client install instructions (#1584)
The install instructions didn't previously add the
`unleash-proxy-client` package (presuming it'd be implicitly installed
by `npm`). This doesn't seem to be the case, so we'll list it explicitly.
2022-05-10 13:26:52 +02:00
Christopher Kolstad
c0207bf3ff
docs: Add NODE_EXTRA_CA_CERTS documentation for webhook addons (#1578)
* docs: Add NODE_EXTRA_CA_CERTS documentation for webhook addons

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-05-09 13:04:56 +02:00
Thomas Heartman
75e6df5b5b
docs: document Proxy openAPI integration (#1571)
* docs: document the new OpenAPI functionality

* docs: add availability note for openapi integration

* docs: rewrite openapi section
2022-05-09 09:24:48 +02:00
Thomas Heartman
2113732f3b
docs: clarify that multiple overrides for a variant create unions (#1551)
* docs: clarify that multiple overrides for a variant create unions

* Update website/docs/advanced/feature-toggle-variants.md

Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-05-06 14:00:08 +02:00
Thomas Heartman
3b545b7dcd
docs: add more details to variant creation API (#1548)
* docs: add more details to variants api PUT example

* docs(fix): correct header title for code sample
2022-05-06 11:46:37 +02:00
Thomas Heartman
68bad77a84
docs: Update Unleash architecture diagram (#1549)
* docs: Update Unleash architecture digram

* fix: typo an -> a

* docs(fix): fix img link in readme

* docs: update architecture graph
2022-05-06 11:17:35 +02:00
Pfuenzle
0fd26e26bc
added db-schema to the docs page (#1567)
I added the "schema" option to the configuring unleash docs page

Co-authored-by: Pfluenze <pfuenzle@protonmail.com>
2022-05-05 11:52:02 +02:00
sebastian-unleash
67f9277b25
docs: Add link to kill switch best practices blog post. (#1554) 2022-05-03 10:16:02 +02:00
Thomas Heartman
581fc76ae1
docs(fix): correct custom activation strategies param types (#1547) 2022-04-29 11:20:26 +02:00
Thomas Heartman
05f4cbb708
docs(fix): change the remoteAddress description (#1539)
remoteAddress previously used the sessionId description.
2022-04-28 16:20:28 +02:00
Fredrik Strand Oseberg
5f96cb3785
docs: update compat table with custom stickiness for go (#1544) 2022-04-28 15:49:05 +02:00
Fredrik Strand Oseberg
e6495d9d26
docs: add docs for vue and svelte clients (#1541)
* docs: add docs for vue and svelte clients

* fix: update version for svelte
2022-04-28 15:33:38 +02:00
Thomas Heartman
75719a0297 docs: link to the correct new endpoints in the features v2 API 2022-04-27 11:09:04 +02:00
Thomas Heartman
5d0ed34b66 chore: remove code leftover code 2022-04-27 11:05:15 +02:00
Thomas Heartman
9ec3409fff docs: add more Api information + add disable toggle info 2022-04-27 11:04:17 +02:00
Thomas Heartman
9a0226d158 docs: remove deprecation notices for tags. 2022-04-26 16:19:34 +02:00
Thomas Heartman
d7029d89b4 docs: Add deprecation notices to features v1
todo: still need to add a couple links
2022-04-25 23:05:54 +02:00
sjaanus
a1f28ef56d
fix: rename variable for consistency purposes (#1507) 2022-04-25 10:21:18 +02:00
Thomas Heartman
8b2d02ee5f chore: update deprecation notice. 2022-04-22 11:20:30 +02:00
Thomas Heartman
f1c243fabf docs: Add deprecation notice to old slack guide 2022-04-22 11:16:42 +02:00
Fredrik Strand Oseberg
60c1265ac4
chore: update matrix (#1511)
* chore: update matrix

* chore: update matrix without format
2022-04-20 15:41:32 +02:00
Thomas Heartman
9d2ef0c47f docs: add note about client tokens changing with v 4.10 2022-04-19 11:08:02 +02:00
Thomas Heartman
54bfe7323d docs: update introduction 2022-04-19 09:57:10 +02:00
Thomas Heartman
4b8c3c3949
Apply suggestions from code review
Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-04-19 09:43:09 +02:00
Thomas Heartman
9db36013b1 chore: delete reference doc scaffolding 2022-04-13 15:41:02 +02:00
Thomas Heartman
f1a4347534 chore: delete duplicate configuration section 2022-04-13 15:40:11 +02:00
Thomas Heartman
b43d9b05db docs: link to the how-to guide from the proxy reference docs 2022-04-13 15:39:04 +02:00
Thomas Heartman
ac9f800ba8 docs: add details to the configuration option table 2022-04-13 15:37:04 +02:00
Thomas Heartman
6a71c27593 docs: Update ApiRequest in how-to guide for proxy 2022-04-13 15:15:27 +02:00
Thomas Heartman
93d2ef55b9 chore: clarify proxy clients vs front-end clients 2022-04-13 15:07:11 +02:00
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