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

792 Commits

Author SHA1 Message Date
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
renovate[bot]
9f92d5045e
fix(deps): update dependency docusaurus-theme-openapi-docs to v1.1.9 (#2032)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-08-31 22:55:20 +00:00
renovate[bot]
5c003e3b2e
fix(deps): update dependency docusaurus-plugin-openapi-docs to v1.1.9 (#2011)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-08-31 03:26:19 +00:00
Ivar Conradi Østhus
23e43b9114
fix(docs): pin got dependency to v11.8.5 2022-08-30 09:52:54 +02:00
Ivar Conradi Østhus
5fd38d1644
fix: adjust the proxy docs 2022-08-29 23:07:48 +02:00
renovate[bot]
6b30967ae0
chore(deps): update dependency trim-newlines to v4 (#1969)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-08-26 12:21:47 +02:00
Ivar Conradi Østhus
9e23c4e969
fix: website dependencies 2022-08-26 10:27:30 +02:00
renovate[bot]
b3949dc9f5
chore(deps): update dependency typescript to v4.8.2 (#1967)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-08-26 03:45:26 +00:00
renovate[bot]
976226d27e
chore(deps): update dependency @babel/core to v7.18.13 (#1954)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-08-23 01:56:01 +00: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
renovate[bot]
b7c59e1733
fix(deps): update dependency docusaurus-theme-openapi-docs to v1.1.8 (#1938)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-08-19 17:35:51 +00:00
renovate[bot]
a6c524c251
fix(deps): update dependency docusaurus-plugin-openapi-docs to v1.1.8 (#1937)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-08-19 14:14:52 +00:00
renovate[bot]
c8f0283049
fix(deps): update dependency docusaurus-theme-openapi-docs to v1.1.7 (#1925)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-08-16 02:30:05 +00:00
renovate[bot]
c6fc4a1b9b
fix(deps): update dependency docusaurus-plugin-openapi-docs to v1.1.7 (#1924)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-08-16 00:07:05 +00:00
renovate[bot]
32a5e3c4f5
fix(deps): update dependency docusaurus-theme-openapi-docs to v1.1.6 (#1919)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-08-13 04:21:33 +00:00
renovate[bot]
53853203bc
fix(deps): update dependency docusaurus-plugin-openapi-docs to v1.1.6 (#1918)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-08-13 01:18:21 +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
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
renovate[bot]
82c83b5611
fix(deps): update dependency unleash-proxy-client to v2.1.0 (#1908)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-08-10 15:36:33 +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
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
renovate[bot]
cd5e1a37d5
chore(deps): update storybook monorepo to v6.5.10 (#1885)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-08-04 04:58:18 +00:00
renovate[bot]
d922ea1225
chore(deps): update dependency @babel/core to v7.18.10 (#1872)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-08-02 00:25:58 +00:00
renovate[bot]
e43be56f13
fix(deps): update docusaurus monorepo to v2.0.1 (#1871)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-08-01 19:41:04 +00:00
renovate[bot]
f6192b50b0
fix(deps): update dependency unleash-proxy-client to v2.0.3 (#1841)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-07-27 13:44:00 +00:00
renovate[bot]
cc341e7913
fix(deps): update dependency @svgr/webpack to v6.3.1 (#1851)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-07-22 17:50:19 +00: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
4332072db4
docs: Update docusaurus to 2.0.0-rc.1 (#1831)
* Chore: update docusaurus packages

* Docs: add algolia doc search app id

* Chore: update/specify node engine version: 16.14
2022-07-19 07:57:03 +02:00
renovate[bot]
29b8223718
fix(deps): update dependency @svgr/webpack to v6.3.0 (#1833)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-07-19 01:09:47 +00:00
renovate[bot]
87cf6e58a2
chore(deps): update dependency @babel/core to v7.18.9 (#1830)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-07-18 12:11:16 +00: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
sighphyre
c8f6c5cc75
docs: include custom header functionality for the Ruby SDK in the compatibility table (#1819) 2022-07-14 11:28:22 +02:00
Floyd
f2629dfdbc
Fixing indentation of Python example (#1794) 2022-07-13 09:33:58 +02:00
ltickett
a3b9dbad24
Add GitLab to Unleash server options (#1799) 2022-07-13 09:33:36 +02:00
renovate[bot]
2a58b88ba3 fix(deps): update dependency clsx to v1.2.1 2022-07-12 00:17:56 +00:00
Thomas Heartman
f2536e7935 Docs(fix): fix formatting error introduced by prettier. 2022-07-06 09:16:49 +02:00
sellinjaanus
04fb065df4
Added missing archivedAt to featureSchema (#1779)
* Added missing archivedAt to featureSchema

* Added archivedAt to feature toggle.
Added archived_at to db

* Add test

* Add test

* Bug fix

* Bug fix

* update archivedAt to date-time

* Code refactoring done

* Conver to static and remove unused methods

* Add tests

* Fixes

* Fix

* Removed docker file from linting

* Fix segment test

* Fix failing test

* Make fixes

Co-authored-by: andreas-unleash <andreas@getunleash.ai>
Co-authored-by: andreas-unleash <104830839+andreas-unleash@users.noreply.github.com>
2022-07-01 11:51:26 +00:00
NicolaeUnleash
7c275917f3
docs: Update api_access_navigation.png (#1784) 2022-06-30 15:58:13 +03:00
Thomas Heartman
7816d8a1f9
Docs: add segments explainer video + fix formatting (#1775) 2022-06-30 08:00:47 +00:00
Nuno Góis
5ba5edcaca
docs: add svelte and vue front-end SDKs (#1760)
* docs: add svelte and vue front-end SDKs

* docs: add solid and react native SDKs as Community SDKs

* fix: reorder community SDKs so that they are sorted alphabetically

* fix: note and table

* fix: note scope, reorder community SDKs alphabetically by tech

* fix: make some text consistent across SDKs

* fix: svelte docs

* Update website/docs/sdks/proxy-svelte.md

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

* fix: headings

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-06-29 12:04:21 +01:00
renovate[bot]
855e33990e chore(deps): update dependency enhanced-resolve to v5.10.0 2022-06-28 23:12:53 +00:00
renovate[bot]
e0557a6e5d chore(deps): update dependency @babel/core to v7.18.6 2022-06-28 00:40:16 +00:00