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
13ea873057
docs: Document the min and max lengths of a feature name. ( #2188 )
...
## What
This change adds a the min and max lengths allowed for a feature
toggle name to the feature toggle docs.
## Why
As was mentioned in #2185 , this isn't documented anywhere as of today,
making it a potentially surprising issue to come across.
2022-10-13 10:26:11 +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
Fredrik Strand Oseberg
7fbe227e0f
Fix/frontendapi synchronization ( #2100 )
...
* feat: add db fetch polling for proxy endpoints
* feat: add test for retrieving cache on interval
* feat: configurable interval
* fix: add config options
* feat: docs
* fix: add config to proxy-repository
* fix: update snapshots
* Update website/docs/reference/front-end-api.md
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* fix: update docs
* Update website/docs/deploy/configuring-unleash.md
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update website/docs/reference/front-end-api.md
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-09-28 14:23:41 +02:00
Thomas Heartman
86824d693f
docs(fix): fix broken link to front-end API tokens ( #2094 )
...
This change fixes a broken link to front-end API tokens from the front-end API page. The anchor had changed.
2022-09-27 15:52:06 +02:00
Tymoteusz Czech
2cd5028125
Docs: update API access for new token type ( #1958 )
...
* refactor how-to guide for creating a token
* fix token links
* update SDK reference
* beginning of direct api guide
* refactored frontend api guide
* lint staged breaking notes
* update docs - cors for frontend
* update token guide images
* update after review
* Apply suggestions from code review
`website/docs/user_guide/token.mdx`
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Apply suggestions from code review
`website/docs/topics/frontend-api.md`
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Apply suggestions from code review
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Apply suggestions from code review
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* pr review
* docs: Add info about front-end tokens + formatting
* docs: add info about token anatomy
* docs: link to correct place in doc
* docs: replace "direct access API" -> "front-end API"
* docs: rename file frontend-api -> front-end-api
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-09-15 09:02:10 +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
6516ac21ee
docs( #1873 ): Document the Unleash playground ( #1901 )
...
* Docs: start adding stuff for the playground docs
* docs(#1873 ): start filling in playground doc
* docs(#1873 ): draft 1
* docs(#1873 ): add playground images
* docs(#1873 ): typo (pr comment)
* docs(#1873 ): Add a sentence or two about stickiness
* docs(#1873 ): merge required and implicit fields
* docs(#1873 ): reduce cognitive complexity
* docs(#1873 ): add link to stickiness calculation section
* docs(#1873 ): add detailed results image
* docs(#1873 ): reword playground requirement env and proj
2022-08-12 12:17:25 +02:00
Thomas Heartman
7816d8a1f9
Docs: add segments explainer video + fix formatting ( #1775 )
2022-06-30 08:00:47 +00:00
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
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
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
93d2ef55b9
chore: clarify proxy clients vs front-end clients
2022-04-13 15:07:11 +02:00
Thomas Heartman
0f9da03078
docs: link to the how-to guide for creating tokens
2022-04-13 13:53:15 +02:00
Thomas Heartman
e0a87c68a0
docs: minor tweaks for client keys
2022-04-13 13:47:27 +02:00
Thomas Heartman
88450a8946
docs: rename api token + client key doc
2022-04-13 13:46:12 +02:00
Thomas Heartman
f7081d5f3a
docs: First draft of API tokens and client keys doc
2022-04-13 13:45:01 +02:00
Thomas Heartman
bba6d6de94
docs: add api tokens outline
2022-04-12 16:00:07 +02:00
Thomas Heartman
0a0ade18df
docs: add API tokens placeholder document
2022-04-12 16:00:07 +02:00
Thomas Heartman
2e1423095e
fix: Add missing segments image
2022-04-11 12:17:02 +02:00
Thomas Heartman
d9aae95c26
docs: move when to use segments to top of document
2022-04-04 12:32:47 +02:00
Thomas Heartman
14cb523c91
docs: expand on time-based strategies with segments
2022-04-04 12:16:32 +02:00
Thomas Heartman
971b411db1
docs: explain that with multiple segments, all must be satisfied.
2022-04-04 11:48:59 +02:00
Thomas Heartman
cc670a018c
docs: update segments availability: indicate that it's experimental
2022-04-04 11:34:53 +02:00
Thomas Heartman
facf546df4
docs(fix): fix internal links between segments docs
2022-04-02 16:29:45 +02:00
Thomas Heartman
e37714d61a
docs: First draft of segments reference doc
2022-04-01 15:47:00 +02:00
