Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-28 00:06:53 +01:00
Code Issues Projects Releases Wiki Activity
9,502 Commits 485 Branches 871 Tags 360 MiB
74bbc7799e
Commit Graph

1148 Commits

Author SHA1 Message Date
Thomas Heartman
0a99dfd6e3
#1391: add generated doc cleaning script (#2077) 
* #1391: add generated doc cleaning script

## What

The cleaning script replaces all references to the Unleash ushosted instance in the
generated OpenAPI docs. It removes extra path segments (such as leading
`/ushosted` instances) and replaces the ushosted base url with something
user-agnostic.

## Why

When we host the OpenAPI docs in our official documentation, the generated
docs shouldn't necessarily point at _one specific instance_, and especially
not one that the reader is unlikely to ever use. Instead, we can remove all
the bits that are specific to the generation source we use, and make the docs
easier to use. In particular, removing the leading `/ushosted` is likely to
save us loooots of questions.

* #1391: change env var used for generating openapi from localhost

Using NODE_ENV=development doesn't necessarily make sense, so adding
an extra variable sounds reasonable to me.

* #1391: ensure that all generation commands also clean docs

* #1391: change <your-unleash-instance-url> to <your-unleash-url>

* #1391: fix ushosted replacement: not all paths start with /api

* #1391: chore: remove potential `ushosted` ending of api url

In the event that we change the base URL of OpenAPI, so that paths
don't start with `/ushosted/`, the script should still work, changing
those paths into <your-unleash-url> too.

Additionally, remove all instances of `/ushosted` that we find. In the
event that some things switch around or whatever.
 2022-09-20 12:43:39 +02:00
Thomas Heartman
1b1dcea769 Docs(fix): update docusaurus deploy command to generate openapi docs 
Without this, the build fails 🙈
 2022-09-19 14:53:34 +02:00
Thomas Heartman
2d04bd9ea2
Add OpenAPI docs (#1391) (#2066) 
## What

This PR (finally 🎉) adds generated OpenAPI docs to the official Unleash documentation. In addition to generating docs when things get merged to main, it also pushes new doc updates every day at 12:00 AM (cron `@daily`).

## Why

Now that we have OpenAPI'd all the things, we can finally start using it. This will allow us to remove hand-written api docs from the documentation and should make sure everything is always kept up to date.

### Generating from us-hosted (Unleash enterprise)

Unleash has several different versions (open source, pro, enterprise). The versions do not necessarily have the exact same api surface. In fact, the enterprise version has a few endpoints that open source does not.

Because we want to have _all_ endpoints listed in the documentation we need to generated the docs from an enterprise spec. Which brings us into the next point:

### The need for scheduled jobs

Regarding the daily scheduled tasks to update the documentation: why do we need that?

The docs are generated from the tip of the main branch. For most of the docs, this is good and something that we want. However, because the OpenAPI docs are generated from the enterprise edition, it _will not be in sync_ with the open source main branch.

Also, we probably do not want the docs to list the current bleeding edge api changes. Instead, we should prefer to use the latest enterprise release (roughly). However, because we don't get notified when this version is released and deployed, we'll instead run the API generation on a daily cadence.

This isn't the perfect solution, but it's simple and gets us 80% of the way there. More intricate solutions can be set up later.

## How

-   By adding a scheduled workflow to the generate docs config.
-   By adding .gitignore entries for the generated files

There's also some minor changes in styling etc.

## Dependencies

This is dependent on the changes introduced in #2062 having propagated to the enterprise release, which will probably not be for another week or so.

## Discussion

What should the API reference docs url be? I've set it to be `/reference/api/unleash/*` for now, but I'm on the fence about whether it should be `apis` or `api` in there. I also want to get the proxy and other APIs in there as we grow.

-------

## Commits

* docs: style openapi operation buttons

* docs: minor operation badge adjustments

* docs: use permalink to css snippet i copied

* docs: ignore files related to openapi generation

* docs: re-enable openapi docs

* Docs(#1391): prep for integration

* docs(#1391): run docs generation daily

* docs(#1391): add generation step to doc prs too

* docs(#1391): use the US hosted instance to generate docs

* docs(#1391): move doc generation into build command

* docs(#1391): use `/reference/api/*` instead of `/reference/apis/*`
 2022-09-19 14:50:24 +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
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
Thomas Heartman
611ef41703
docs: update python docs: fallback function / default values (#1752) 2022-06-27 11:16:46 +02:00
Ivar Conradi Østhus
ab323f253f
fix: add docs for session options (#1660) 
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-06-23 14:40:51 +02:00
Thomas Heartman
89d25c8634
docs: add proxy deployment diagrams (#1743) 
* docs: remove empty table row

* docs: add placeholder proxy hosting article

* docs: add images, describe first one

* docs: describe the customer-hosted proxy solution

* docs: describe the self-hosted single-region setup.

* docs: describe enterprise multi-region setup.

* docs: minor changes

* docs: update lists; restructure

* docs: more minor changes

* docs: add alt text to diagrams

* docs: update proxy hosting doc

* docs: some prettier formatting

* docs: add link to proxy hosting doc

* docs: format proxy config table

* docs: prettier formatting
 2022-06-23 08:28:01 +02:00
olav
ab75d4085e
refactor: add schemas to user admin controller (#1692) 
* refactor: add schemas to user admin controller

* refactor: remove unused SessionService

* refactor: fix search query type confusion

* refactor: add schemas to user controller (#1693)

* refactor: add schemas to user controller

* refactor: fix getAllUserSplashes method name

* refactor: name and email should not be required on create

* refactor: only some user fields may be updated

* refactor: should not require any fields on user update  (#1730)

* refactor: send 400 instead of 500 on missing username and email

* refactor: should not require any fields for user update

* refactor: note that earlier versions required name or email

* refactor: merge roleDescriptionSchema and roleSchema
 2022-06-22 14:55:43 +02:00
andreas-unleash
66452e2860
open-api addon controller (#1721) 
* open-api addon controller

* bug fixes

* bug fixes

* resolve merge conflict

* bug fix

* bug fix

* bug fix

* PR comments

* PR comments

* Resolve merge conflics

* Resolve merge conflics

* bug and tests
 2022-06-22 13:49:18 +03: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
renovate[bot]
5c9f30ceef chore(deps): update dependency typescript to v4.7.4 2022-06-18 01:54:21 +00:00
Thomas Heartman
bb3c722f67
Docs: Update description for create + update user (#1727) 
* Docs: Update description for create + update user

This change updates the documentation for the user creation API,
fixing errors mentioned in #1717:

- it's either `username` or `email` that is required on creation.
`name` is not required.
- `name` is the only required field when updating a user.

* docs: Fix overzealous prettier formatting

* docs: updated requirements for put: name OR email
 2022-06-17 13:50:39 +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
Christopher Kolstad
45c3df0598
docs: SDK Synchronization tips (#1720) 
* docs: SDK Synchronization tips

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

* docs: Update csharp example with tabs

* docs: update java docs with tabs and sync examples

* docs: update node docs for sync init

* docs: remove plea to pay attention to env config option

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-06-15 09:49:56 +00:00
Renovate Bot
7ce95cafc8 fix(deps): update react monorepo to v18.2.0 2022-06-15 00:42:43 +00:00
Christopher Kolstad
705eee654f
fix: pleas -> please (#1706) 2022-06-14 15:16:58 +02:00
Renovate Bot
c810959e26 chore(deps): update storybook monorepo to v6.5.9 2022-06-14 05:28:52 +00:00
Renovate Bot
0f35bd3172 chore(deps): update dependency @babel/core to v7.18.5 2022-06-14 01:52:04 +00:00
Renovate Bot
0b6f5448f0 chore(deps): update dependency @storybook/testing-library to v0.0.13 2022-06-13 21:10:33 +00:00
Renovate Bot
7843c2bbc8 chore(deps): update dependency @tsconfig/docusaurus to v1.0.6 2022-06-11 12:25:35 +00:00
Renovate Bot
4b466063df chore(deps): update dependency @storybook/testing-library to v0.0.12 2022-06-10 17:23:41 +00:00
sighphyre
18e63d5ea3
feat: add support for handling non standard postgres dates (#1689) 
* feat: add support for handling non standard postgres dates

* docs: update some http docs links to point to their respective https versions

* chore: refactor non standard date handling callback code to be a little clearer

* Update website/docs/deploy/configuring-unleash-v3.md

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

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-06-10 08:47:31 +02:00
Ivar Conradi Østhus
3d84668ba2
doc: proper api protection in google auth example. (#1688) 
fixes: #1679
 2022-06-09 13:01:15 +02:00
Renovate Bot
5208cfc708 chore(deps): update storybook monorepo to v6.5.8 2022-06-08 23:31:10 +00:00
Christopher Kolstad
37211491e7
feat: default to memoizing client features (#1674) 2022-06-08 09:43:37 +02:00
Thomas Heartman
fa74f81aa5
fix: env drop event data.name + /api/admin/events docs (#1662) 
* docs: add all /events endpoints and query params

* docs: events page skeleton structure

* docs: correct description of event payloads

* docs: add table with event properties.

* docs: remove duplicate table.

* docs: sort property table

* docs: more work on adding events: feature events

* docs: add examples for most feature events

Still missing are: events that require imports, and
feature-project-change

* docs: scaffold out all events descriptions

* docs: normalize casing

* docs: add brief descriptions to strategy and context events

* docs: Add remaining non-import event descriptions and examples

* docs: add code sample annotations for all example events.

* docs: remove all references to myself

* docs: change "toggle" -> "feature", adjust headings

The headings aren't semantic for this doc yet. We'll need to create a
new document for this.

* docs: update event type description table

* docs: change header level of event type section

* docs: add details around feature-project-change event

* docs: add import type events

* docs: use a better `createdBy` name

* docs: "sort" events so that they're in a consistent order.

* docs: remove reference to ID in addon-config-created event

* fix: drop-environments data.name all-projects -> all-environments

This is probably a bug. Should be double checked.

* docs: clarify that `data.name` is always `all-x` on drop events

* Apply suggestions from code review

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

Co-authored-by: sighphyre <liquidwicked64@gmail.com>
 2022-06-07 11:33:30 +01:00
Renovate Bot
e5fe268844 chore(deps): update storybook monorepo to v6.5.7 2022-06-07 01:33:38 +00:00
Renovate Bot
78b3b78ced chore(deps): update dependency typescript to v4.7.3 2022-06-04 05:56:08 +00:00
Pfuenzle
4ca0de27e5
docs: Add deprecation notice to eventHook (#1618) 
* Add deprecation notice to eventHook

* Update website/docs/deploy/configuring-unleash.md

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

* Added proxy documentation

* Update configuring-unleash.md

* Update website/docs/deploy/configuring-unleash.md

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

Co-authored-by: Thomas Heartman <thomasheartman+github@gmail.com>
 2022-06-03 14:03:45 +02:00
Christopher Kolstad
606270d86a
feat: Allow extra CSP domains (#1610) 
* feat: Allow extra CSP domains

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

* fix: eslint:

* fix: allow partial csp domains

* fix: add option and config type

* fix: snapshot

Co-authored-by: Fredrik Oseberg <fredrik.no@gmail.com>
 2022-05-31 11:32:15 +02:00
Sebastian Bury
bde6294e44
Update feature-toggles-archive-api.md 2022-05-30 16:26:02 +02:00
Renovate Bot
f122e884c7 chore(deps): update storybook monorepo to v6.5.6 2022-05-30 04:37:07 +00:00
Renovate Bot
b3161bc2e8 chore(deps): update dependency @babel/core to v7.18.2 2022-05-25 13:24:12 +00:00
Renovate Bot
0d623e184c chore(deps): update dependency typescript to v4.7.2 2022-05-24 23:53:46 +00:00
Renovate Bot
b39c03e561 chore(deps): update storybook monorepo to v6.5.5 2022-05-24 20:19:06 +00:00
Renovate Bot
eca933eb65 chore(deps): update storybook monorepo to v6.5.4 2022-05-23 13:37:39 +00:00
Renovate Bot
16a2e74041 chore(deps): update storybook monorepo to v6.5.3 2022-05-20 23:39:01 +00:00
renovate[bot]
f954de0ecf
chore(deps): update dependency @babel/core to v7.18.0 (#1612) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2022-05-20 12:20:44 +02:00
Nuno Góis
40c920f184
docs: use named export instead of default (#1615) 2022-05-20 10:31:05 +01:00
Nuno Góis
46c253b964
docs: use named export instead of default (#1614) 2022-05-20 11:22:14 +02:00
Nuno Góis
16860c1469
docs: update import to use named export instead of default (#1609) 
See: https://github.com/Unleash/proxy-client-react/pull/58
 2022-05-20 07:48:01 +01:00
Thomas Heartman
a6753d9af3
docs: switch all slack links to slack.unleash.run (#1613) 2022-05-20 08:17:36 +02:00
Andreas Fauske
70f58b3a84
Update dot_net.md (#1598) 
Fixed a typo.
 2022-05-19 14:59:36 +02:00
Renovate Bot
d68b304607 chore(deps): update dependency @babel/core to v7.17.12 2022-05-17 00:57:22 +00:00
Thomas Heartman
d384a76a28
docs: fix python sdk syntax highlighting, header levels (#1596) 
* docs: fix python sdk syntax highlighting, header levels
* docs(fix): remove invalid toggle names
 2022-05-16 10:30:28 +02:00
Thomas Heartman
943af1e804
docs: Update the react client install instructions (#1584) 
The install instructions didn't previously add the
`unleash-proxy-client` package (presuming it'd be implicitly installed
by `npm`). This doesn't seem to be the case, so we'll list it explicitly.
 2022-05-10 13:26:52 +02:00
Christopher Kolstad
c0207bf3ff
docs: Add NODE_EXTRA_CA_CERTS documentation for webhook addons (#1578) 
* docs: Add NODE_EXTRA_CA_CERTS documentation for webhook addons

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-05-09 13:04:56 +02:00
Thomas Heartman
75e6df5b5b
docs: document Proxy openAPI integration (#1571) 
* docs: document the new OpenAPI functionality

* docs: add availability note for openapi integration

* docs: rewrite openapi section
 2022-05-09 09:24:48 +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
Thomas Heartman
3b545b7dcd
docs: add more details to variant creation API (#1548) 
* docs: add more details to variants api PUT example

* docs(fix): correct header title for code sample
 2022-05-06 11:46:37 +02:00
Thomas Heartman
68bad77a84
docs: Update Unleash architecture diagram (#1549) 
* docs: Update Unleash architecture digram

* fix: typo an -> a

* docs(fix): fix img link in readme

* docs: update architecture graph
 2022-05-06 11:17:35 +02:00
Pfuenzle
0fd26e26bc
added db-schema to the docs page (#1567) 
I added the "schema" option to the configuring unleash docs page

Co-authored-by: Pfluenze <pfuenzle@protonmail.com>
 2022-05-05 11:52:02 +02:00
Thomas Heartman
188352cb7a
docs: remove duplicate sidebar item; sort sdks (#1558) 
* fix: remove duplicate sidebar entry

* fix: sort sdk list
 2022-05-03 10:21:14 +02:00
sebastian-unleash
67f9277b25
docs: Add link to kill switch best practices blog post. (#1554) 2022-05-03 10:16:02 +02:00
Renovate Bot
042d0137f3 chore(deps): update dependency @babel/core to v7.17.10 2022-04-29 20:24:13 +00:00
Thomas Heartman
581fc76ae1
docs(fix): correct custom activation strategies param types (#1547) 2022-04-29 11:20:26 +02:00
Renovate Bot
ec878110d9 chore(deps): update dependency typescript to v4.6.4 2022-04-29 00:28:58 +00:00
Thomas Heartman
05f4cbb708
docs(fix): change the remoteAddress description (#1539) 
remoteAddress previously used the sessionId description.
 2022-04-28 16:20:28 +02:00
Fredrik Strand Oseberg
5f96cb3785
docs: update compat table with custom stickiness for go (#1544) 2022-04-28 15:49:05 +02:00
Fredrik Strand Oseberg
e6495d9d26
docs: add docs for vue and svelte clients (#1541) 
* docs: add docs for vue and svelte clients

* fix: update version for svelte
 2022-04-28 15:33:38 +02:00
Thomas Heartman
038d9eb8ec
Merge pull request #1531 from Unleash/docs/deprecate-features-v1 
docs: Add deprecation notices to features v1
 2022-04-28 08:42:37 +02:00
Renovate Bot
2e551c9f4e fix(deps): update dependency unleash-proxy-client to v2.0.1 2022-04-27 13:38:16 +00:00
Thomas Heartman
75719a0297 docs: link to the correct new endpoints in the features v2 API 2022-04-27 11:09:04 +02:00
Thomas Heartman
5d0ed34b66 chore: remove code leftover code 2022-04-27 11:05:15 +02:00
Thomas Heartman
9ec3409fff docs: add more Api information + add disable toggle info 2022-04-27 11:04:17 +02:00
Thomas Heartman
65da8a845a feat: update ApiRequest to accept POST w/o payloads 2022-04-27 10:55:33 +02:00
Renovate Bot
820932aadb fix(deps): update react monorepo to v18.1.0 2022-04-27 01:04:30 +00:00
Thomas Heartman
9a0226d158 docs: remove deprecation notices for tags. 2022-04-26 16:19:34 +02:00
Thomas Heartman
d7029d89b4 docs: Add deprecation notices to features v1 
todo: still need to add a couple links
 2022-04-25 23:05:54 +02:00
renovate[bot]
d05b4bde64
fix(deps): update react monorepo to v18 (#1489) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2022-04-25 14:19:13 +02:00
sjaanus
a1f28ef56d
fix: rename variable for consistency purposes (#1507) 2022-04-25 10:21:18 +02:00
Thomas Heartman
8b2d02ee5f chore: update deprecation notice. 2022-04-22 11:20:30 +02:00
Thomas Heartman
f1c243fabf docs: Add deprecation notice to old slack guide 2022-04-22 11:16:42 +02:00
Renovate Bot
9a3f7cda20 chore(deps): update dependency @storybook/testing-library to v0.0.11 2022-04-21 17:18:25 +00:00
renovate[bot]
0d87cc8e1d
fix(deps): update dependency unleash-proxy-client to v2 (#1513) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2022-04-21 16:20:55 +02:00
Fredrik Strand Oseberg
60c1265ac4
chore: update matrix (#1511) 
* chore: update matrix

* chore: update matrix without format
 2022-04-20 15:41:32 +02:00
Renovate Bot
178539b88a chore(deps): update dependency babel-loader to v8.2.5 2022-04-20 03:46:48 +00:00
Renovate Bot
c3e9d67e4b chore(deps): update dependency @storybook/testing-library to v0.0.10 2022-04-19 23:22:45 +00:00
Thomas Heartman
3d1b6e59a3
Merge pull request #1501 from Unleash/docs/proxy-overhaul 
docs: add API tokens and client keys + How to run the Unleash Proxy
 2022-04-19 12:09:28 +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
Renovate Bot
2935226ee6 chore(deps): update storybook monorepo to v6.4.22 2022-04-14 11:18:50 +00:00
Renovate Bot
bb85321926 chore(deps): update dependency enhanced-resolve to v5.9.3 2022-04-13 13:53:33 +00:00
Thomas Heartman
9db36013b1 chore: delete reference doc scaffolding 2022-04-13 15:41:02 +02:00
Thomas Heartman
f1a4347534 chore: delete duplicate configuration section 2022-04-13 15:40:11 +02:00
Thomas Heartman
b43d9b05db docs: link to the how-to guide from the proxy reference docs 2022-04-13 15:39:04 +02:00
Thomas Heartman
ac9f800ba8 docs: add details to the configuration option table 2022-04-13 15:37:04 +02:00
Thomas Heartman
6a71c27593 docs: Update ApiRequest in how-to guide for proxy 2022-04-13 15:15:27 +02:00
Thomas Heartman
ecbae418d4 feat: allow ApiRequest component to create proxy requests 2022-04-13 15:15:08 +02:00
Thomas Heartman
93d2ef55b9 chore: clarify proxy clients vs front-end clients 2022-04-13 15:07:11 +02:00
Thomas Heartman
5e382e64dc docs: api request and placeholders to proxy how-to 2022-04-13 15:06:42 +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
07de36f6c4 docs: add api-tokens to sidebar 2022-04-12 16:02:16 +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
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
8f3018d092 docs: ad configuration variables to proxy reference 2022-04-12 16:00:07 +02:00
Thomas Heartman
c7fe197fbd docs: add new how-to category: Unleash Proxy 2022-04-12 16:00:05 +02:00
Thomas Heartman
48f5e45b40 fix: remove wrong id 2022-04-12 15:59:12 +02:00
Thomas Heartman
29f77b8e27 docs: add configuration options header. 2022-04-12 15:59:12 +02:00
Thomas Heartman
3c63adddab docs: add more scaffolding to proxy docs 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
f3a7ec5559
Merge pull request #1492 from Unleash/docs/update-sdk-compat 
docs(sdk compat table): Add new strategy constraint ✅ for .NET; add ✅s for Proxy
 2022-04-12 13:53:08 +02:00
Thomas Heartman
747b5f128a
Merge pull request #1498 from Unleash/docs/update-sdk-overview-title 
docs: update client sdk overview title
 2022-04-12 12:12:44 +02:00
Thomas Heartman
a327f55b3a docs: update client sdk overview title 
When the title is only "Introduction" it's super hard to find via
search. Changing it to something more descriptive should make that easier.
 2022-04-12 10:41:50 +02:00
Ivar Conradi Østhus
55e43b033d
docs: correct secrets key 2022-04-11 22:32:58 +02:00
Ivar Conradi Østhus
947d9fc40c
docs: correct proxy url to demo instance 2022-04-11 22:23:22 +02:00
Thomas Heartman
2e1423095e fix: Add missing segments image 2022-04-11 12:17:02 +02:00
Renovate Bot
3d078550dc chore(deps): update storybook monorepo to v6.4.21 2022-04-09 05:23:44 +00:00
Thomas Heartman
d86f898316 docs: Add ✅s for proxy features 2022-04-08 15:24:56 +02:00
Thomas Heartman
3067001083 docs: add ✅ for .NET constraints since 2.1 2022-04-08 15:24:35 +02:00
Salvatore Novelli
7ddbff2669
feat: add "application_name" as an optional DB option #1170 (#1478) 
* implemented changes to resolve issue 1170

* added applicationName to the list of db options in the documentation'

Co-authored-by: Daniele Casal <daniele.casal@lloydsbanking.com>
Co-authored-by: Sukhvinder Panesar <79143027+esspee-lbg@users.noreply.github.com>
 2022-04-07 20:55:56 +02:00
renovate[bot]
007cc0a83c
chore(deps): pin dependencies (#1427) 
Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2022-04-06 21:42:26 +02:00
Thomas Heartman
41485ec50a docs: change android docs to use clientKey, not clientSecret 2022-04-06 10:56:51 +02:00
Thomas Heartman
35bd047af9 docs: reword api return type description 2022-04-04 14:56:34 +02:00
Thomas Heartman
90794fc6ec docs: add segment ids examples for replacing strategy segments 2022-04-04 14:49:13 +02:00
Thomas Heartman
6f2a336fc4 docs: simplify activation strategy payload 2022-04-04 14:43:45 +02:00
Thomas Heartman
683e33915f docs: update payload for activation strategies 2022-04-04 14:33:38 +02:00
Thomas Heartman
bf9f9e9d6d docs: update return types to use JSON examples instead of TS 2022-04-04 13:55:53 +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
93b20246a7 docs: make note of how to remove all segments from a strategy 2022-04-04 11:47:13 +02:00
Thomas Heartman
e4c2e8807d docs: segment names don't need to be url-friendly. 2022-04-04 11:44:37 +02:00
Thomas Heartman
020e94e358 docs: update segments availability in API docs too 2022-04-04 11:44:03 +02:00
Thomas Heartman
cc670a018c docs: update segments availability: indicate that it's experimental 2022-04-04 11:34:53 +02:00
Thomas Heartman
524be02b74 docs(docs): document the use of AliasPlugin for theme resolution 2022-04-02 16:47:38 +02:00
Thomas Heartman
c8578f06c9 chore: remove comment code 2022-04-02 16:42:04 +02:00
Thomas Heartman
f59f43bb4c chore: use docusaurusPath function consistently. 2022-04-02 16:40:37 +02:00
Thomas Heartman
c0228a0ca3 chore: remove unused code 2022-04-02 16:39:16 +02:00
Thomas Heartman
79b5582542 docs(fix): various typos and abstractions fixed 2022-04-02 16:33:51 +02:00
Thomas Heartman
facf546df4 docs(fix): fix internal links between segments docs 2022-04-02 16:29:45 +02:00
Thomas Heartman
8eb91fc860 fix(docs): fix the quotes of JSON property in table 2022-04-02 16:28:24 +02:00
Thomas Heartman
45dc2c8c33 fix: remove redundant heading 2022-04-02 16:27:53 +02:00
Thomas Heartman
3846ad8252 fix: re-add the groupId prop for the API request tabs component. 2022-04-02 16:27:20 +02:00
Thomas Heartman
e03876286c docs: finish the API docs for segments 2022-04-02 16:27:09 +02:00
Thomas Heartman
102438946e docs: add POST and GET by ID 2022-04-01 16:24:35 +02:00
Thomas Heartman
d88032710b docs: describe GET /api/admin/segments 2022-04-01 16:04:10 +02:00
Thomas Heartman
5d164db46c docs: add relevant types for this API 2022-04-01 16:03:50 +02:00
Thomas Heartman
fc6ea25ebd docs: add more endpoint data 2022-04-01 15:47:00 +02:00
Thomas Heartman
cfbe04272a feat: make API request component work without payloads 
There's been no previous need for GET or DELETE requests, but now that
we do need them, the payload shouldn't show up as `undefined`
 2022-04-01 15:47:00 +02:00
Thomas Heartman
d167de76d8 docs: add stories file for API request component 2022-04-01 15:47:00 +02:00
Thomas Heartman
032176576b chore: add more docusaurus alias resolutions 2022-04-01 15:47:00 +02:00
Thomas Heartman
3440b4f42a docs: add segments api placeholder 2022-04-01 15:47:00 +02:00
Thomas Heartman
e37714d61a docs: First draft of segments reference doc 2022-04-01 15:47:00 +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
sighphyre
17e7777a75
Update website/docs/integrations/jira-server-plugin-installation.md 
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-03-25 12:51:47 +02:00
sighphyre
8c13fe74a8
Update website/docs/integrations/jira-server-plugin-installation.md 
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-03-25 12:51:37 +02:00
sighphyre
69532656bd
Update website/docs/integrations/jira-server-plugin-installation.md 
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-03-25 12:50:43 +02:00
sighphyre
f05d76255a
Update website/docs/integrations/jira-server-plugin-installation.md 
Nice!

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-03-25 12:50:30 +02:00
sighphyre
0d4360b997 docs: add installation instructions for jira plugin for marketplace 2022-03-25 09:24:26 +02:00
Thomas Heartman
0d2e72eeea docs: delete images that are no longer in use. 2022-03-24 16:12:40 +01:00
Thomas Heartman
2709f19ae7 docs(a11y): add alt texts to images + minor rewording 2022-03-24 16:09:37 +01:00
Thomas Heartman
d7b09f73db docs: Add prerequisites, new installation instructions (marketplace) 2022-03-24 15:18:12 +01:00
Thomas Heartman
c15d221b66
Merge pull request #1463 from Unleash/docs/bump-php-adv-constraints-version 
docs: list v1.3.1 of the PHP sdk as first compatible w/adv constr.
 2022-03-23 14:05:21 +01:00
Thomas Heartman
907a5c6da0
Merge pull request #1449 from Unleash/docs/improve-db-ssl-docs 
docs: add more content around database connections
 2022-03-23 13:53:22 +01:00
Thomas Heartman
2ffe11a336 docs: list v1.3.1 of the PHP sdk as first compatible w/adv constr. 
While 1.3 _does_ contain the advanced operators, it'll still break if
it doesn't recognize the operators or if you provide an invalid semver
version. 1.3.1 fixes this, so we should try and nudge people towards
that instead.
 2022-03-23 13:14:20 +01: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
47a4fe3234 docs: sort options alphabetically in example object. 2022-03-22 11:20:48 +01:00
Thomas Heartman
da0fe21832 docs: PR feedback: configure db url, db url file, precedence 2022-03-22 11:19:09 +01:00
Thomas Heartman
0998ca4618 Merge branch 'main' into docs/sdk-min-version-for-advanced-operators 2022-03-18 15:01:39 +01: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
b432ec8795 docs: only list feature versions for constraint ops inclusion 2022-03-18 14:23:26 +01:00
Thomas Heartman
e604b95e7d docs: update min versions for node, python, ruby 2022-03-18 13:55:31 +01:00
Thomas Heartman
85c74864bd
Merge pull request #1452 from Unleash/docs/add-more-adv-constraints-sdk-details 
docs: add more comprehensive overview of sdk incompatibilities
 2022-03-18 13:31:06 +01:00
Thomas Heartman
d6f6d5d1d2
Merge pull request #1441 from shailscript/patch-1 
docs: bold important text in slack integration docs
 2022-03-18 12:37:28 +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
c999b4c43e docs: add php support version for advanced constraints 2022-03-18 11:34:51 +01:00
Thomas Heartman
a9a480d33f docs: note the minimum SDK versions necessary for adv constraints 
Also formats the rest of the table to align with the new column
content. Please ignore whitespace for this.
 2022-03-18 11:29:25 +01:00
Thomas Heartman
59609a85f4
Merge pull request #1440 from Unleash/docs/how-to-time-feature-releases 
docs: add how to schedule feature releases guide
 2022-03-18 09:30:23 +01:00
Thomas Heartman
b8673c86b1 docs: remove duplicate db connection options description 2022-03-17 16:43:19 +01:00
Thomas Heartman
b235eba6ac docs: add code samples, move db configuration to separate section 2022-03-17 16:11:56 +01:00
Thomas Heartman
3d1d115a30 docs: add more content around database connections 2022-03-17 15:54:56 +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
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
sighphyre
8f60dd6958
Merge pull request #1431 from Unleash/enabled-environments-override 
Add enabled environments override flag
 2022-03-16 14:45:55 +02:00
Thomas Heartman
104ff93332 docs: Add note to strategy constraints about undefined behavior 2022-03-16 10:05:41 +01:00
Shailendra Shukla
5e551b01f8
docs: bold important text 2022-03-15 17:44:58 -05: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
sighphyre
bf95a40527 docs: describe details of enabled_environments in unleash config docs 2022-03-14 09:48:54 +02:00
Thomas Heartman
27a74ecf0d docs: create initial outline for how to schedule feature releases 2022-03-11 13:58:41 +01:00
Thomas Heartman
451fa64018 docs: add a note saying passord is password for Norwegian 2022-03-10 14:22:03 +01:00
Thomas Heartman
d28c046e51
Merge pull request #1428 from Unleash/docs/document-semver-gte-lte 
docs: document how to get SEMVER_GTE/LTE functionality
 2022-03-10 11:45:01 +01:00
Thomas Heartman
9f292465eb docs: document how to get SEMVER_GTE/LTE functionality 2022-03-10 10:56:59 +01:00
Thomas Heartman
b94f7bdb48
Merge pull request #1401 from Unleash/docs/add-feedback-component 
feat: add feedback component
 2022-03-10 10:26:00 +01:00
Thomas Heartman
18c16b3040 fix: make sure customer type is included in the payload. 
Because it previously set it via a reducer and submitted the form in
the same step, the customer type wouldn't be set correctly before the
form was submitted, causing it to show up as "undefined".

We're doing double the work now, but I think that's an acceptable
trade-off for now.
 2022-03-10 10:12:10 +01:00
Thomas Heartman
027eac47ac feat: add data: "was the form opened manually" and "current page" 2022-03-10 09:48:58 +01:00
Thomas Heartman
22c4752c53 fix: remove empty ruleset 2022-03-10 09:40:28 +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
613ee550bc docs: merge currentTime with "advanced constraints" row 2022-03-09 11:55:21 +01:00
Thomas Heartman
aafa2005e0 Merge branch 'main' into docs/new-constraint-operators 2022-03-09 11:32:42 +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
sighphyre
3910e23d2d
Merge pull request #1408 from Unleash/feat/init-client-tokens 
Load Client Tokens From Environment on Startup
 2022-03-09 09:53:47 +02:00
Thomas Heartman
db9a0e2c54 chore: merge main -> this branch 2022-03-08 13:58:16 +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
c0eac49313 fix: delete empty table row 2022-03-08 13:34:11 +01:00
Thomas Heartman
419dda09a0 docs: Update description of currentTime in the Unleash context. 2022-03-08 13:31:55 +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
774bed5bee fix: mark .NET sdk as not having currentTime context field 2022-03-08 12:53:56 +01:00
Thomas Heartman
4ce4a9c2d6 docs: remove 'introduced in' column in Unleash Context table. 2022-03-08 11:22:24 +01:00
Thomas Heartman
05187ce6a9 fix: remove placeholder comment 2022-03-08 11:20:06 +01:00
Thomas Heartman
94f13075ac docs: add unleash context and compat table updates 2022-03-08 11:14:55 +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
Dominik Chrastecky
2623fb17c4 Mark custom headers - function as supported in PHP SDK 2022-03-07 12:44:37 +01:00
Dominik Chrastecky
29c8f1ec72 Merge remote-tracking branch 'origin/main' into docs/php-compatibility-matrix 2022-03-07 12:42:16 +01:00
Thomas Heartman
c63c9b6fab docs: minor rewording and clarification around strategy impl/eval 2022-03-07 11:11:51 +01:00
Thomas Heartman
300c6abd74 fix: fix broken link in SDK list 2022-03-04 13:52:19 +01:00
Thomas Heartman
c88da63888
Merge pull request #1417 from Unleash/docs/add-offline-info-to-sdks 
docs: describe how sdks work in offline modes
 2022-03-04 13:50:49 +01:00
Thomas Heartman
c0985ad08d docs: be explicit about what happens if an SDK doesn't have toggles. 2022-03-04 13:43:02 +01:00
Thomas Heartman
304e95f9d7 docs: add working offline section to the SDKs doc 2022-03-04 13:37:59 +01:00
Thomas Heartman
db7848680a
Merge pull request #1416 from Unleash/docs/clarify-activation-evaluation 
docs: reword and add additional deets re: activation strategy impl
 2022-03-04 13:10:03 +01:00
Thomas Heartman
6a4e2b7163 fix: change : to , 2022-03-04 13:04:40 +01:00
Thomas Heartman
f35a932e8d fix: stitch the info paragraph together with the existing content 2022-03-04 13:02:06 +01:00
Thomas Heartman
cda31e46d3 fix: remove unintended line break. 2022-03-04 12:56:55 +01:00
Thomas Heartman
28df5dcb31 docs: add offline headings / rough skeleton 2022-03-04 12:56:16 +01:00
Thomas Heartman
9b691a4f89 fix: fix broken link custom activation strategies doc. 2022-03-04 12:43:58 +01:00
Thomas Heartman
28b16d922d docs: reword and add additional deets re: activation strategy impl 2022-03-04 12:41:13 +01:00
Thomas Heartman
c15cbfc6d3
Merge pull request #1319 from Unleash/docs/describe-project-users-endpoints 
docs: describe `/api/admin/projects/:projectId/users/:userId/roles/:roleId` endpoint
 2022-03-04 12:10:11 +01:00
Thomas Heartman
cf2a8de161
Merge pull request #1342 from Unleash/docs/user-admin-send-email-props 
docs: Add payload properties for user-admin post payload
 2022-03-04 12:10:02 +01:00
Thomas Heartman
4705fe22cc docs: remove error payload that no longer applies. 2022-03-04 10:41:52 +01:00
Thomas Heartman
6d433c50ab docs: add info about requiring name OR email 2022-03-04 10:36:40 +01:00
Thomas Heartman
c9dd60e1ea
Apply suggestions from code review 
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
 2022-03-04 08:43:28 +01:00
Thomas Heartman
e6d939508d fix: correct the description of disabled variants 2022-03-04 08:20:55 +01:00
Thomas Heartman
4c4f6a3aaa docs: update description of sendEmail option 2022-03-03 15:24:15 +01:00
Thomas Heartman
38ed3816a8 docs: Remove doubled section and clarify role removal 2022-03-03 14:17:43 +01:00
Thomas Heartman
9da796eb90 docs: add details for change role endpoint. 2022-03-03 09:25:22 +01:00
Thomas Heartman
e84b8f30e1 docs: add correct return values for role deletion endpoints. 2022-03-03 09:25:22 +01:00
Thomas Heartman
92349b5561 Apply suggestions from code review 
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
 2022-03-03 09:25:22 +01:00
Thomas Heartman
81c6ef2d6e chore: align url parameters table. 2022-03-03 09:25:22 +01:00
Thomas Heartman
01f7293e2e docs: add description of the project users/roles endpoint 2022-03-03 09:25:20 +01:00
Thomas Heartman
f92d86061a docs(chore): improve syntax highlighting and formatting of code bits 
Use `bash` instead of `sh` for nicer highlighting by prism.

I've also broken large json blobs over multiple lines.
 2022-03-03 09:24:43 +01:00
Thomas Heartman
6b624081fa chore: remove node-fetch, don't do Unleash server-side 2022-03-02 15:57:16 +01:00
Thomas Heartman
f49fde0923 fix: make buttons visually align in Chrome and Firefox 2022-03-02 15:47:45 +01:00
Thomas Heartman
a437ecfd46 fix: downgrade to node-fetch 2.x 2022-03-02 13:57:04 +01:00
Thomas Heartman
fd0b5fd6e4 Revert "fix: remove node-fetch and SSR to fix the build" 
This reverts commit e106943e4b.
 2022-03-02 13:56:54 +01:00
Thomas Heartman
e106943e4b fix: remove node-fetch and SSR to fix the build 2022-03-02 13:50:08 +01:00
sighphyre
010a699a19
Update website/docs/deploy/configuring-unleash.md 
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-03-02 14:09:50 +02:00
Thomas Heartman
d3484946fc fix: add new doc dependencies to correct package.json 2022-03-02 12:51:54 +01:00
sighphyre
6de5fdb565 feat: allow startup to load client tokens from env var 2022-03-02 13:44:46 +02:00
Thomas Heartman
756204c529 feat: type feedback component. 2022-03-02 12:05:29 +01:00
Thomas Heartman
1054f74141 fix: correct the check for fetch to use SSR config in SSR situations 2022-03-02 11:43:12 +01:00
Thomas Heartman
d210fcb05c fix: make the build not die if window.fetch isn't available. 2022-03-02 11:43:12 +01:00
Thomas Heartman
d640a8f8aa chore: convert feedback component to typescript 2022-03-02 11:43:12 +01:00
Thomas Heartman
4871f178a1 chore: convert feedback component to typescript 2022-03-02 10:50:46 +01:00
Thomas Heartman
67269d9530 fix: change refresh interval from 1 to 0. 
At the moment, we only need to check the features once. There's no
need to have things suddenly appear for users who have it loaded already.
 2022-03-02 08:40:36 +01:00
Thomas Heartman
c520e11892 fix: retranspose transposed words 2022-03-01 17:22:58 +01:00
Thomas Heartman
9c0a5b4c12 fix: use position: fixed to set UI components of feedback. 2022-03-01 17:21:28 +01:00
Thomas Heartman
d0132ef61d docs: integrate unleash to show feedback 2022-03-01 17:21:14 +01:00
Thomas Heartman
553b8020fd docs: fix styling issues on narrow screens 2022-03-01 08:44:57 +01:00
Thomas Heartman
e12aa94695 feat: set completion flag upon submitting form 2022-02-28 23:59:59 +01:00
Thomas Heartman
44cac1e7d2 chore: remove debug logs 2022-02-28 23:50:10 +01:00
Thomas Heartman
98298dc42b feat: implement saving and loading from localStorage 2022-02-28 23:41:42 +01:00
Thomas Heartman
f9561c3661 feat: clear form on manual closing. 2022-02-28 23:33:48 +01:00
Thomas Heartman
74a3c27b06 clear form after submission and re-opening 2022-02-28 23:18:53 +01:00
Thomas Heartman
0e96a39ecf fix: remove pointer events from hidden content. 2022-02-28 23:18:36 +01:00
Thomas Heartman
b2a1628ff5 feat: set up request execution on form submission 2022-02-28 23:13:07 +01:00
Thomas Heartman
0e4d2cf102 step forward after submitting response 2022-02-28 22:29:27 +01:00
Thomas Heartman
5c35ea84b7 fix: don't reset radio group values to undefined 2022-02-28 22:14:53 +01:00
Thomas Heartman
a2a7499e95 chore: minor cleanup and simplification 2022-02-28 22:11:55 +01:00
Thomas Heartman
05d8cfe10c feat: fix keyboard focus between screens 2022-02-28 22:09:18 +01:00
Thomas Heartman
f215980d6c feat: overlay form sections 2022-02-28 15:36:46 +01:00
Thomas Heartman
355b516dae feat: render all steps at the same time, add thank you; first anims 2022-02-28 15:19:15 +01:00
Thomas Heartman
5456b093be feat: style open-feedback-button. 2022-02-28 14:35:02 +01:00
Thomas Heartman
911f65856f feat: further styling and hooking up of open feedback-button 2022-02-28 12:27:10 +01:00
Thomas Heartman
56d9335162 docs: set customer type correctly 2022-02-28 10:25:16 +01:00
Thomas Heartman
6916873ec7 docs: style input text area 2022-02-28 10:19:02 +01:00
Thomas Heartman
9b1f9b764b feat: start hooking up open/close logic 2022-02-27 19:59:30 +01:00
Thomas Heartman
a629c36fe7 feat: hide 'very unsatisfied'/'very satisfied' on smaller sreens 2022-02-27 19:40:14 +01:00
Thomas Heartman
e007123c59 fix: make close button visible again 2022-02-27 16:27:28 +01:00
Thomas Heartman
1534fd1674 feat: style page 3 2022-02-27 16:15:46 +01:00
Thomas Heartman
5bc48076a2 feat: reverse source order of form control buttons. 
this makes 'submit' or 'next' the first button you reach when tabbing
out of the control
 2022-02-27 16:02:00 +01:00
Thomas Heartman
19e03e94e0 style page 2 2022-02-27 15:57:30 +01:00
Thomas Heartman
da38a419ed feat: create step 1 and set up step 2 2022-02-27 15:16:51 +01:00
Thomas Heartman
5340ca28fc move subcomponent into wrapper 2022-02-27 14:59:33 +01:00
Thomas Heartman
35a939b895 feat: start splitting component up into multiple pieces. 2022-02-27 14:37:44 +01:00
Thomas Heartman
211b18c4a3 feat: start adding state logic to component. 2022-02-26 21:38:07 +01:00
Thomas Heartman
6e2072bca4 chore: first feedback page 2022-02-25 17:10:29 +01:00
Thomas Heartman
532f0cb634 fix: explicitly set background for the light theme 
the default is for it to be transparent, which causes issues when
you're overlaying components with the default background color.
 2022-02-25 16:39:25 +01:00
Thomas Heartman
43597687df fix: make css module loading work as expected. 2022-02-25 16:38:32 +01:00
Thomas Heartman
790bd4da0f chore: support css modules in storybook 2022-02-25 15:37:04 +01:00
Thomas Heartman
4a795966d1 docs: change primary color for light theme to unleash purple 2022-02-25 13:32:52 +01:00
Thomas Heartman
a6191f5ab8 feat: rough style first question page of feedback component. 2022-02-25 12:57:13 +01:00
Thomas Heartman
3302e66ab1 docs: remove "future enhancements" section of environments doc 
These things are either implemented or just around the corner now. I
suggest removing them to not be misleading anymore. Case in point: we
just had a customer asking us when the permissions system would be
ready because the docs say it's planned as a future improvement.
 2022-02-25 09:10:22 +01:00
Thomas Heartman
aa3fb6c4e2 chore: rename styles to module, add more focus styles 2022-02-24 18:00:03 +01:00
Thomas Heartman
39f4d73d59 feat: add basic (sorta styled) first feedback screen 2022-02-24 17:42:53 +01:00
Thomas Heartman
0160eb8ef3 docs: swizzle root and add feedback component 2022-02-24 16:28:05 +01:00
sighphyre
c2b946bf28
Merge pull request #1381 from Unleash/docs/update-compat-table-for-constraints 
docs: Advanced constraints compatibility
 2022-02-24 11:36:38 +02:00
sighphyre
a7fa3f703d docs: update docs for Go SDK because wait until initialized already exists 2022-02-23 15:30:13 +02:00
sighphyre
435f64ad22 docs: mark PHP as advanced constraint compatible in compatibility table 2022-02-23 12:29:30 +02:00
Thomas Heartman
105f3bac21 chore: use standard css file name 2022-02-23 10:37:52 +01:00
sighphyre
5487fca318 docs: add in compatibility table entry for advanced constraints 2022-02-21 13:59:45 +02:00
Ivar Conradi Østhus
9f6b414e09
docs: correct unleash proxy sdk docs 2022-02-21 10:45:05 +01:00
Dominik Chrastecky
81e0b6c402 docs: update php compatibility matrix table 2022-02-18 20:12:19 +01:00
Thomas Heartman
c19278e8e8
Merge pull request #1376 from Unleash/docs/add-how-to-video-for-impression-data 
docs: Add how-to video for impression data
 2022-02-18 10:01:52 +01:00
Thomas Heartman
4305166186 chore(storybook): wire storybook up with docusaurus 2022-02-18 08:35:59 +01:00
Thomas Heartman
9bcb489d8c docs: add data-theme attribute to storybook html 2022-02-17 13:47:04 +01:00
Thomas Heartman
1b8a15aa12 docs: Add storybook 2022-02-17 12:30:49 +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
Renato Arruda
50cbc78cd8
(docs) Ruby SDK now has a bootstrap impl 2022-02-17 07:58:52 +01:00
Thomas Heartman
63cd0d229e docs: adjust primary color scale, fix search dropdown a11y issues 
This changes the darker end of the primary color scale to make it even
darker. This means that at the lower end of the scale, white text also
gets enough contrast to be accessible.

For the record: these variables do not seem to be in use anywhere else
in the code base (based on a text search), so it shouldn't affect any
other bits or pieces.
 2022-02-14 11:43:05 +01:00
Thomas Heartman
c63d552576
Merge pull request #1345 from Unleash/docs/impression-data-how-to 
docs: Add "How to send impression data to your third-party sink" guide
 2022-02-11 12:36:53 +01:00
Thomas Heartman
ea7d599bad chore: add missing comma 2022-02-11 11:56:16 +01:00
Thomas Heartman
04f6ff2f69
Merge pull request #1348 from Unleash/docs/update-a-b-testing-doc 
docs: Reference impression data from A/B testing doc
 2022-02-11 09:59:46 +01:00
Thomas Heartman
17d32f5e43 fix: don't apply extra image styling to images outside the main 
Without this modifier, the border, background color, etc, also applies
to logos in the header and footer, and that's not what we want.
 2022-02-10 16:42:11 +01:00
Thomas Heartman
ebcab898e7 docs: Reference impression data from A/B testing doc 
Mention impression data in the A/B discussion topic.
 2022-02-10 16:35:29 +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
812aa5c64c docs: reference how-to impression data from ref impression data 2022-02-10 16:26:44 +01:00
Thomas Heartman
a125ea10e8 fix: add missing backslashes to curl command 2022-02-10 16:10:53 +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
d0c4eb2637 docs: Add cURL command to ApiRequest component. 2022-02-10 15:33:08 +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
fe69c1d9ef docs(chore): Use ifm variable for border width. 2022-02-09 13:44:58 +01:00
Thomas Heartman
0b69e1751e chore: remove trailing full stop. 2022-02-09 13:44:58 +01:00
Thomas Heartman
986d628faa docs(a11y): fix issues with transparent pngs; add borders, centering 2022-02-09 13:44:58 +01:00
Thomas Heartman
3e1500625a docs(chore): remove 'documentation' link in na bar. 2022-02-09 13:44:58 +01:00
Thomas Heartman
d0023f615b docs(a11y): use a purple color for primary theme color 2022-02-09 13:44:58 +01:00
Thomas Heartman
7ee4e12a05 docs(a11y): dark mode fix contrast in sidebar and with vid comp 
This commit introduces a new primary color gradient palette to replace the
dark / mossy green that we use in the light theme. It's got a very
small range, so we should probably expand on it in the future, but for
now it'll do a _lot_ better than it did previously.
 2022-02-09 13:44:58 +01:00
Thomas Heartman
52e85ab555 docs(a11y): move light-specific theme changes to 'light-theme' css 2022-02-09 13:44:58 +01:00
Thomas Heartman
f7301ef937 docs(a11y): fix contrast issues with dark theme link color. 
New contrast is 7.99 (AAA).
 2022-02-09 13:44:58 +01:00
Thomas Heartman
4754d203e4
Merge pull request #1344 from Unleash/docs/change-api-how-tos-sidebar-title 
docs: change API how-tos label from "API" to "Using the APIs"
 2022-02-09 12:15:26 +01:00
Thomas Heartman
5a220caf39 docs: Add payload properties for user-admin post payload 
Adds an explanation of what the various properties in the payload
object to the `user-admin` endpoint does. Most seem fairly
self-explanatory, but I'm not entirely sure what `sendEmail` does.

Requires validation by a third party before merging.
 2022-02-09 09:05:24 +01:00
Ivar Conradi Østhus
1487ae10c6
docs: update compatibility matrix 2022-02-08 20:57:06 +01:00
Ivar Conradi Østhus
609422071f
docs: add "sendEmail" field to user-admin.md (#1329) 2022-02-08 20:47:01 +01:00
Christopher Kolstad
b0edddb283
fix: typo (#1346) 2022-02-08 14:57:52 +01:00