1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-03-04 00:18:40 +01:00
Commit Graph

523 Commits

Author SHA1 Message Date
Thomas Heartman
92e6eef905 docs: add link to node js sdk 2022-10-13 15:52:35 +02:00
Thomas Heartman
7acb317198 Docs(fix): remove redundant comma 2022-10-13 15:52:35 +02:00
Thomas Heartman
3ca7727099
Update website/docs/topics/the-anatomy-of-unleash.mdx 2022-10-13 15:48:23 +02:00
Thomas Heartman
b6622009f1
Apply suggestions from code review
Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
2022-10-13 15:46:51 +02:00
Thomas Heartman
46bacbf789 docs: add note about strategies vs constraints 2022-10-12 15:03:57 +02:00
Thomas Heartman
9460dcc807 docs: rename anatomy doc 2022-10-12 14:59:50 +02:00
Thomas Heartman
6da5921e8f Docs(fix): typo: extra brackets 2022-10-11 17:01:07 +02:00
Thomas Heartman
927b323b09 docs: reorder images 2022-10-11 16:53:28 +02:00
Thomas Heartman
6b6ccfd74c docs: add captions for all figures. 2022-10-11 16:48:34 +02:00
Thomas Heartman
4ca1f7e3e6 docs: add projects to list of top-level resources 2022-10-11 16:37:57 +02:00
Thomas Heartman
8c014679b1 docs: Convert all images to using the figure component 2022-10-11 11:32:48 +02:00
Thomas Heartman
ca81f981b5 Docs(test): images take 3 2022-10-11 11:24:24 +02:00
Thomas Heartman
b05c4dba5b Docs(test): try new way of importing images 2022-10-11 11:04:47 +02:00
Thomas Heartman
ad28e39965 docs: rephrase heading 2022-10-11 10:26:13 +02:00
Thomas Heartman
9789112651 Fix: add fuller figure caption 2022-10-10 14:57:24 +02:00
Thomas Heartman
520d37cdb0 docs: align on styles 2022-10-10 14:54:09 +02:00
Thomas Heartman
8b5c30e5d7 docs: add a Figure element for figures with captions 2022-10-10 14:43:53 +02:00
Thomas Heartman
ce183d2c23 docs: fix broken links 2022-10-10 13:57:39 +02:00
Thomas Heartman
226c5feefd docs: add inter-doc links, some reformatting 2022-10-10 12:43:01 +02:00
Thomas Heartman
98ce389eff docs: add raw export of anatomy document 2022-10-05 15:18:23 +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
Ivar Conradi Østhus
c59d40fba9
fix: updated develper guide to force UTC timezone for test db 2022-09-30 20:21:03 +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
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
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
Thomas Heartman
a3585343e1
docs: Move user groups section to after permissions section (#2081)
The permissions section is a subsection of the CPR section and
shouldn't be separated. This seems to have been an oversight.
2022-09-23 11:15:15 +02:00
Thomas Heartman
2484720c74
docs: fix broken link to how-to-create-API token guide (#2073) 2022-09-19 13:18:44 +02:00
Ivar Conradi Østhus
26c88ff6aa
fix: update SDK matrix
with impression events supported for node.js
2022-09-15 13:35:51 +02:00
Ivar Conradi Østhus
2cf372364f
Update index.md 2022-09-15 13:34:07 +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
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
469bd1622e
docs: update link for symfony sdk (#2048)
The doc link appears to have pointed at an address that is no longer reachable. Instead, let's point to the equivalent GitHub link

Relates to and closes #2047
2022-09-07 13:21:40 +00:00
Thomas Heartman
68cec1349b
Fix broken doc links (#2046)
## What

This PR fixes some broken links that have been hanging around in the
docs for what seems like a very long time.

## Why

As discovered by the link check in #1912, there are a fair few broken
links in the docs. Everyone hates broken links because it makes it
harder to understand what they were supposed to be pointing at.

## How

There are 3 types of links that have been fixed:
- Links that should have been internal but were absolute. E.g.
  `https://docs.getunleash.io/path/article` that should have been
  `./article.md`
- External links that have changed, such as Slack's API description
- GitHub links to files that either no longer exist or that have been
  moved. These links generally pointed to `master`/`main`, meaning
  they are subject to change. They have been replaced with permalinks
  pointing to specific commits.

-----

* docs: fix slack api doc link

* docs: update links in migration guide

* docs: fix broken link to ancient feature schema validation

* docs: update links to v3 auth hooks

* docs: update broken link in the go sdk article

* Fix: use permalink for GitHub link

* docs: fix wrong google auth link
2022-09-07 14:26:23 +02:00
Ivar Conradi Østhus
5fd38d1644
fix: adjust the proxy docs 2022-08-29 23:07:48 +02:00
Allan Luartes
d73200ed16
docs: fix typo for overview guide (#1942)
Edit (_we're talk nano-seconds_) to (_we're talking nano-seconds_)
2022-08-20 07:31:21 +02: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
9448461aaa
docs: prep to add OpenAPI spec to Unleash docs (#1907)
* Docs: start experimenting with OpenAPI and docusaurus

* Docs: add docusaurus-theme-openapi-docs pkg

* Wip: current status

* Docs: Add 'docusaurus-plugin-api-docs'

* Move openapi into own sidebar; generate from localhost

* Chore: Update docusaurus plugin for OpenAPI

* Add website/yarn.lock to git

* Fix: fix CSS warning by using flex-end instead of end

* docs: make openapi generated code work again

* docs: make tags work properly with openapi sidebar

* Docs/chore: update OpenAPI tag scheme.

Add a whole bunch of new tags to make it easier to understand
available tags in OpenAPI.

* docs: point to new openapi docs from old api docs

* docs: typo

* Docs:  link restructure

* docs: add operation indicators to openapi docs

* docs: change badge color for operations

* docs: update openapi-docs package

It now sorts tags the same as the schema

* docs: pluralize APIs in slug

* docs: update links to generated api docs

* docs: update openapi snapshot tests with new tags

* docs: conditionally load spec from localhost or from file

* docs: Remove changes relating to immediate switchover

* refactor: rename types; extract into separate file

* docs: fix api doc links
2022-08-12 11:37:57 +02: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
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
b06cbb0f75
docs: remove references to deprecated proxy config variable (#1902) 2022-08-09 16:20:28 +02:00
Thomas Heartman
b406f67fb7 Docs(fix): fix formatting of docusaurus admonitions
They seem to have been broken by prettier
2022-08-04 11:11:10 +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
Erik
19b95b1bd9
docs: Update activation-strategies.md (#1824)
Fixing a typo in `Multiple activation strategies` section
2022-07-18 13:03:27 +02:00