1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Commit Graph

84 Commits

Author SHA1 Message Date
Thomas Heartman
a658693f2f
Docs: Impression events only fire on enabled front-end toggles (#2153)
## What

This change updates the description of when impression events are
fired to clarify that impression events are **not** fired in front-end
SDKs if the toggle is enabled.

It also adds a 'caution' admonition repeating this information with
some more info on why.

## Why

We've had a couple questions about this as it hasn't been clearly
stated before. Additionally, I, as a member of the team and the
original author of this document, thought that impression
events **did** fire for disabled toggles in the front-end.

As such, I consider this to be unexpected and different from what was
originally written.
2022-11-09 23:09:48 +01:00
Simon Hornby
b1a877e56c
docs: adds documentation for personal api tokens (#2164)
* docs: adds documentation for personal api tokens

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-10-13 11:02:04 +02:00
Thomas Heartman
0e4734af38
docs: Update docs with new constraint availability (#2113)
* docs: fix duplicated image.

* docs: add announcement banner for constraints

* docs: style announcement bar via CSS

* docs: update doc availability notices

* docs: remove commented-out announcement bar code
2022-10-04 14:13:52 +02:00
Tymoteusz Czech
47152cf05b
Feat/invite user (#2061)
* refactor: user creation screen cleanup

* feat: deprecation notice for google sso

* fix: docs openid typo

* invite link bar

* invite link page

* fix prettier docs

* regenerated openapi

* hooks for invite page api

* update openapi

* feat: invite link update

* feat: add public signup token soft-delete

* public signup frontend feature flag

* fix: new user api issues

* feat: allow for creating new user from invite link

* Feat/invite user public controller (#2106)

* added PublicInviteController for public urls

* added PublicInviteController for public urls

* added PublicInviteController for public urls

* added PublicInviteController for public urls

* fix test

* fix test

* update openapi

* refactor: password reset props

* fix: public invite schema and validation

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

* user invite frontend

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

* invite link delete confirmation dialog

* refactor: password reset action

* fix: new user invite loading state

* fix: run ts check with ci

* revert openapi changes

* fix: invite token api interface

* fix: openapi schema index

* fix: update test snapshots

* update frontend snapshot

* fix: prettier ci

* fix: updates after review

Co-authored-by: andreas-unleash <104830839+andreas-unleash@users.noreply.github.com>
Co-authored-by: Fredrik Strand Oseberg <fredrik.no@gmail.com>
2022-09-30 13:01:32 +02:00
Ivar Conradi Østhus
9ba441b9cf
fix: typo in strategy-constraints.md (#2115) 2022-09-29 19:26:14 +02:00
Thomas Heartman
0302b3d2e3
fix: Update UI labeling: custom constraint -> (strategy) constraint (#2101)
* fix: change every instance of "custom constraint"

This changes every instance of "custom constraint" to "constraint" or
"strategy constraint" depending on the context.

* fix: rename custom-constraint.png to avoid confusion

* Update images-constraints

Co-authored-by: NicolaeUnleash <103567375+NicolaeUnleash@users.noreply.github.com>
2022-09-29 11:43:04 +02:00
Thomas Heartman
51a64eff47 Docs: fix typo: Unlash -> Unleash 2022-09-29 09:31:54 +02:00
Saketsuraj
501c08a4b1
Updated name and parameters description (#2083)
## Description

Updates descriptions for "name" and "parameters" fields of custom activation strategies to clarify what they are and should be used for.

## Commits

* Updated name and parameters description

* Update website/docs/advanced/custom-activation-strategy.md

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

* updated name's and parameter's description

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

Co-authored-by: Thomas Heartman <thomasheartman+github@gmail.com>
2022-09-27 13:41:32 +02:00
Tymoteusz Czech
ce3db75133
Create Signup page for users from Invite link (#2052)
* refactor: user creation screen cleanup

* feat: deprecation notice for google sso

* fix: docs openid typo

* user invite hook mock
2022-09-14 11:42:20 +02:00
NicolaeUnleash
51c7ea053e
docs: update images using latest UI screenshots (#1992)
* Update api_access_history.png

* updating images in - How to capture impression data

* Update Quickstart image

* Update images: How to add strategy constraints

* Update images: How to create a feature toggle

* Update images: How to define custom context fields

* Update images: How to use custom activation strategies

* Update images: How to schedule feature releases

* Update images: How to add new users to your Unleash instance

* Update images: How to create and assign custom project roles

* Update images: How to add SSO with OpenId Connect

* Update images: How to add SSO with SAML 2.0 Okta

* Update images: Slack

* Update images: Activation Strategies

* Update images: Archived toggles

* Update images: The audit log

* Update images: Impression data

* Update images: Custom Activation Strategies

* Update images: Environments

* Update images: Feature Toggle Types

* Update images: Feature Toggle Variants

* Update images: Projects

* Update images: Segments

* Update images: Stickiness

* Update images: Strategy Constraints

* Update images: Technical Debt

* Update images: Unleash Context

* Update images: Unleash introductory overview

* Update images: Unleash introductory overview

* docs: replace strategy constraints step 2 img

* Update website/docs/how-to/how-to-add-strategy-constraints.md

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

* change text request

* Updating docs text to match the screenshots

* Docs: change audit log to event log and add redirects

* Docs: update "archive" page with deletion info

* Docs: update constraints how to

* Docs: minor tech debt doc fixes

* docs-update-images-set1: update overview page

* Apply suggestions from code review

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

* Update website/docs/user_guide/quickstart.md

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

* Update website/docs/user_guide/user-management.md

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

* Update website/docs/user_guide/user-management.md

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

* Activation strategy update

* Apply suggestions from code review

* Update delete-archive img

* Fix prettier formatting for admonitions

* Update website/docs/user_guide/environments.md

* Update website/docs/user_guide/projects.md

Co-authored-by: Tymoteusz Czech <tymek+gpg@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-09-14 07:59:18 +00:00
Thomas Heartman
1d158f7e45
Docs: remove extra warning from impression data doc (#1906)
I don't think we need the extra caution under the "example setup"
section.

Also: apply formatting + minor rewording of availability.
2022-08-10 12:41:22 +02:00
Dominik Chrástecký
f206795d97
Docs: Update compatibility matrix for php (#1904)
* Docs: Update compatibility matrix for php

* Docs: Update php compatibility table to include IP CIDR syntax

* Docs: Update impression data documentation

* Docs: Mention JavaScript proxy clients in impression data support
2022-08-10 12:26:44 +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
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
4306836511 docs: Add .NET SDK to list of SDKs that crash on new operators 2022-04-01 10:24:08 +02: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
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
84f44c0396 docs: Add note saying that some SDKs will crash with new operators. 2022-03-17 11:45:40 +01:00
Thomas Heartman
104ff93332 docs: Add note to strategy constraints about undefined behavior 2022-03-16 10:05:41 +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
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
Thomas Heartman
fee4caf2f9 docs: Add note about how invalid context field values are handled 2022-03-08 13:44:02 +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
05187ce6a9 fix: remove placeholder comment 2022-03-08 11:20:06 +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
Thomas Heartman
812aa5c64c docs: reference how-to impression data from ref impression data 2022-02-10 16:26:44 +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
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
8c09bf4fe5 docs: fix link to addons page 2022-02-01 14:49:52 +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
5e556bc87d Rename all how-to guides to start with 'how to'. 2022-01-25 12:22:00 +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
4d63ed01a8 fix: fix broken link to how-to guide. 2021-12-22 13:24:14 +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
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