Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-10-27 11:02:16 +01:00
Code Issues Projects Releases Wiki Activity
11,914 Commits 576 Branches 895 Tags 353 MiB
2ec2639fa3
Commit Graph

127 Commits

Author SHA1 Message Date
Simon Hornby
3624cdc21f
docs: move sso how to guides to the how-to folder (#2323) 
We're in the process of moving how-to guides into the how-to folder,
where they belong. This continues that work and shifts the how to guides
for SSO to the correct place and gives them appropriate names

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-11-14 14:11:27 +02:00
Simon Hornby
90cb737202
docs: add documentation for user group syncing (#2314) 
* docs: add documentation for user group syncing and a end to end example for keycloak

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-11-03 14:59:12 +02:00
Nuno Góis
20310bf1a4
docs: add environment cloning and how-to guide (#2249) 
* docs: add environment cloning and how-to guide

* add next steps in how-to, update reference

* update how-to, add images

* Update website/docs/how-to/how-to-clone-environment.mdx

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

* Update website/docs/how-to/how-to-clone-environment.mdx

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

* Update website/docs/user_guide/environments.md

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

* Update website/docs/how-to/how-to-clone-environment.mdx

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

* Update website/docs/user_guide/environments.md

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

* Update website/docs/how-to/how-to-clone-environment.mdx

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

* Update website/docs/how-to/how-to-clone-environment.mdx

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

* Update website/docs/how-to/how-to-clone-environment.mdx

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

* Update website/sidebars.js

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

* Update website/docs/how-to/how-to-clone-environment.mdx

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

* Update website/docs/how-to/how-to-clone-environment.mdx

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

* Update website/docs/how-to/how-to-clone-environment.mdx

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

* Update website/docs/user_guide/environments.md

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

* Update website/docs/user_guide/environments.md

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

* address PR comments

* Update website/docs/how-to/how-to-clone-environments.mdx

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

* Update website/docs/user_guide/environments.md

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

* Update website/docs/user_guide/environments.md

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

* Update website/docs/user_guide/environments.md

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

* fix uppercase in guide

Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-11-03 14:14:08 +02:00
Thomas Heartman
8916de76be
docs: Remove/update references to Heroku (#2099) 
## What

This PR removes or updates references in the docs to Heroku. Most of the code samples have been replaced with a more generic `unleash.example.com` url, while other references have been removed or updated.

Also removes old OpenAPI files that are out of date and redundant with the new generation.

## Background

Come November and Heroku will no longer offer free deployments of Unleash, so it's about time we remove that claim.

Links to the heroku instance are also outdated because we don't have that instance running anymore.

Finally, the OpenAPI files we do have there are old and static, so they don't match the current reality.

## Commits

* Meta: update ignore file to ignore autogenerated docs

I must've missed the ignore file when looking for patterns.

* docs: delete old openapi file.

This seems to have been a holdover from 2020 and is probably
hand-written. It has been superseded by the new autogenerated OpenAPI docs.

* docs: add notes for heroku changes to the frontend readme and pkg

* docs: remove old openapi article and add redirects to new openapi

* docs: fix link in overview doc: point to GitHub instead of heroku

* docs: update quickstart docs with new heroku details

* docs: remove reference to crashing heroku instance

* docs: remove references to herokuapp in  code samples

* docs: add a placeholder comment

* docs: update references for heroku updates

* docs: keep using unleash4 for enterprise

* docs: remove start:heroku script in favor of start:sandbox

* docs: remove 'deploy on heroku button'

Now that it's not free anymore (or won't be very shortly), let's
remove it.

* docs: remove extra newline
 2022-10-19 12:02:00 +00: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
andreas-unleash
0651c83bd1
Docs/public signup (#2070) 
* update snapshot

* add api doc

* describe api

* reference initial

* updated public signup api docs
created public invite api docs

* docs

* docs update

* docs update

* add description to openapi endpoints

* add description to openapi endpoints

* fix snapshot

* Update src/lib/openapi/spec/public-signup-token-create-schema.ts

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

* Update src/lib/openapi/spec/public-signup-token-schema.ts

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

* Update src/lib/routes/admin-api/public-signup.ts

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

* Update src/lib/routes/public-invite.ts

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

* Update src/lib/openapi/spec/public-signup-token-schema.ts

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

* Update src/lib/routes/admin-api/public-signup.ts

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

* Update website/docs/reference/public-signup.mdx

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

* PR comments

* delete api docs

* fix snapshot

* Update src/lib/routes/admin-api/public-signup.ts

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

* bug fix

* bug fix

* bug fix

* Update src/lib/openapi/spec/public-signup-token-create-schema.ts

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

* Update src/lib/openapi/spec/public-signup-token-schema.ts

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

* Update src/lib/openapi/spec/public-signup-token-update-schema.ts

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

* Update src/lib/routes/admin-api/public-signup.ts

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

* Update src/lib/routes/admin-api/public-signup.ts

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

* Update src/lib/routes/public-invite.ts

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

* bug fix

* fix links

* update snapshot

* update snapshot

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-10-10 16:12:11 +03: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
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
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
Simon Hornby
46b1a25181
docs: update group docs with new screenshots and requirements for users (#1910) 2022-08-11 14:01:32 +02:00
Thomas Heartman
b06cbb0f75
docs: remove references to deprecated proxy config variable (#1902) 2022-08-09 16:20:28 +02:00
Thomas Heartman
22014f3c62
docs: add how-to guide for enabling OpenAPI (#1836) 
* Docs: add how-to enable the openapi spec

* Docs: fix and format how to run unleash proxy

* Fix: add backticks instead of single quotes

* Docs: remove unnecessary imports, format

* Docs: fix minor errors and update location section
 2022-07-22 09:02:01 +02:00
sighphyre
5806b6748f
Feat/grouping (#1845) 
* Implement user grouping feature for permissions

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Jaanus Sellin <sellinjaanus@gmail.com>
Co-authored-by: Nuno Góis <github@nunogois.com>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-07-21 16:23:56 +02:00
Thomas Heartman
6a71c27593 docs: Update ApiRequest in how-to guide for proxy 2022-04-13 15:15:27 +02:00
Thomas Heartman
5e382e64dc docs: api request and placeholders to proxy how-to 2022-04-13 15:06:42 +02:00
Thomas Heartman
dc7e93b618 docs: start smoothing out proxy docs 2022-04-12 16:00:07 +02:00
Thomas Heartman
f1601392e1 docs: change title, add content to how-to guide 2022-04-12 16:00:07 +02:00
Thomas Heartman
48f5e45b40 fix: remove wrong id 2022-04-12 15:59:12 +02:00
Thomas Heartman
4b0b08a2ea docs: start moving proxy details around 2022-04-12 15:59:12 +02:00
Thomas Heartman
6d5b89d88b docs: add how-to for running proxy (duplicated content) 2022-04-12 15:59:11 +02:00
Thomas Heartman
0950a95698 docs: add a link to the SDK incompatibility section 2022-03-18 14:30:02 +01:00
Thomas Heartman
7efd306969 docs: link to strategy constraints from the schedule how-to guide 2022-03-18 14:28:06 +01:00
Thomas Heartman
0a34661937 docs: clear up that constraints are available to pro customers too 2022-03-17 08:53:42 +01:00
Thomas Heartman
b3faf3e622 docs: add screenies and update descriptions accordingly 2022-03-17 08:41:57 +01:00
Thomas Heartman
905fa6fc6f docs: create first draft of schedule how-to 2022-03-15 16:29:55 +01:00
Thomas Heartman
8c5657911f docs: add more placeholder / structural content. 2022-03-14 18:36:01 +01:00
Thomas Heartman
27a74ecf0d docs: create initial outline for how to schedule feature releases 2022-03-11 13:58:41 +01:00
Thomas Heartman
7c70dffd5b fix: add missing word 2022-02-17 10:32:34 +01:00
Thomas Heartman
f5c7f3a320 docs: Add how-to video for impression data 
This change adds a video to the impression data how-to guide
 2022-02-17 10:30:26 +01:00
Thomas Heartman
ea7d599bad chore: add missing comma 2022-02-11 11:56:16 +01:00
Thomas Heartman
e114025967 docs: reference A/B testing doc from impression data how-to 2022-02-10 16:26:57 +01:00
Thomas Heartman
9998e4cd63 chore: rename impression data how-to 2022-02-10 15:55:25 +01:00
Thomas Heartman
845168385b docs: Finish initial draft of how-to guide 2022-02-10 15:53:51 +01:00
Thomas Heartman
b56f809fb8 docs: rename file extension from .md to .mdx 2022-02-10 15:34:19 +01:00
Thomas Heartman
1eb4ae99ec docs: Clarify placeholder info. 2022-02-09 16:06:05 +01:00
Thomas Heartman
31b3792a11 docs: Add steps to enable impression events for existing toggles. 2022-02-09 16:03:32 +01:00
Thomas Heartman
752a1df343 docs: Add API request component: display in http and httpie easy! 
The ApiRequest component is created to make it easier to show code
samples for API requests. It shows them in raw HTTP form and with
HTTPie for now.
 2022-02-09 15:54:16 +01:00
Thomas Heartman
323b9e4247 docs: Add more outlines, steps, etc to how-to impression data 2022-02-09 14:20:24 +01:00
Thomas Heartman
a48d6af7e4 fix: fix google analytics link 2022-02-09 14:20:24 +01:00
Thomas Heartman
6ee9a4326c docs: Add impression data guide outline and sidebar entry 2022-02-09 14:20:24 +01:00
Thomas Heartman
0073de000e docs: remove redundant video heading and commented-out content. 2022-01-27 13:19:55 +01:00
Thomas Heartman
9ba9abbe29 docs: Update how-to for cprs with new video element. 2022-01-27 12:48:23 +01:00
Thomas Heartman
0c6bbc215c docs: move video component to /src/components 2022-01-26 13:52:17 +01:00
Thomas Heartman
2c318546b6 docs: remove unnecessary wrapping divs. 2022-01-26 13:52:17 +01:00
Thomas Heartman
1a399fcabc docs: add video content component (to be moved) 2022-01-26 13:52:17 +01:00
Thomas Heartman
2259cc4e68 docs: add initial video component idea (+ cq polyfill) 
note: polyfill is currently broken for some reason 🤷
 2022-01-26 13:51:44 +01:00
Thomas Heartman
3ce2ea0f61 docs: simplify text 2022-01-19 15:08:25 +01:00
Thomas Heartman
c113081866 docs: Add how-to videos to cpr how-tos 
For simplicity I've added them as separate sections, but I'd love for
them to be listed higher up.
 2022-01-19 15:05:28 +01:00
Thomas Heartman
7897ee2e87 docs: add how-to screenies for cpr 2022-01-14 10:59:18 +01:00
Thomas Heartman
53001a47f8 docs: update steps to edit roles. 2022-01-10 14:38:03 +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
45fe483924 docs: add placeholder how-to-guide for custom project roles 2022-01-06 12:34:20 +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
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
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
9791783be5 docs(strats): separate reference and how-to 2021-12-22 09:59:32 +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
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
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
e1d1ee2718 docs(context): Update doc; add how-to make custom context fields. 2021-12-17 14:03:42 +01:00