1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Commit Graph

212 Commits

Author SHA1 Message Date
Alvin Bryan
a1d6795533
Docusaurus v3 (#8485)
- Upgrades to latest Docusaurus
- Upgrades our OpenAPI plugin to latest too
- Removes old, unneeded dependencies
- Our configs and sidebar files now use TypeScript

[Preview
link](https://unleash-docs-git-alvin-docusaurus-v3-unleash-team.vercel.app/)

---------

Co-authored-by: melindafekete <melinda.fekete@getunleash.io>
Co-authored-by: Christopher Kolstad <chriswk@getunleash.io>
2024-10-30 11:55:51 +00:00
Melinda Fekete
8b0af59897
Update and restructure environments (#8496) 2024-10-22 17:55:11 +02:00
Melinda Fekete
e81f606d33
Fix incorrect md file extensions in docs (#8462) 2024-10-17 11:52:02 +02:00
Melinda Fekete
c580e762b3
Restructure features documentation (#8394) 2024-10-16 13:59:30 +02:00
Melinda Fekete
8736d2a916
Events docs revamp (#8360) 2024-10-08 12:11:05 +02:00
Melinda Fekete
415e3489d4
Align availability information in the docs (#8177) 2024-10-03 10:33:22 +02:00
Melinda Fekete
60206f88d3
Docs fixes (#7845) 2024-10-01 11:33:50 +02:00
Mateusz Kwasniewski
15144e4e93
docs: feature lifecycle availability (#8288) 2024-09-27 12:28:50 +02:00
Melinda Fekete
7d38048ee8
Update Entra ID SAML SSO docs (#8151) 2024-09-20 17:37:10 +02:00
Melinda Fekete
499c9cebfd
Update collaboration mode docs (#7864) 2024-08-23 17:17:57 +02:00
Thomas Heartman
7f7891dc8e
docs: mention what the minimum values are if you override the limits (#7971)
Adds a note to the resource limit docs about what resources have a minimum limit of 1.

Also updates the availability note in preparation for 6.2 GA

---------

Co-authored-by: Melinda Fekete <melinda.fekete@getunleash.io>
2024-08-23 09:06:13 +02:00
Jaanus Sellin
cb8d689bd8
feat: command menu docs (#7963)
Also rebranded command bar to command menu, because that seems more
suitable.
Command bar is more like a horizontal/vertical list/bar of icons, like
sidebar. Command menu is more of a dropdown.


https://unleash-docs-git-command-docs-unleash-team.vercel.app/reference/command-menu

---------

Co-authored-by: melindafekete <melinda.fekete@getunleash.io>
2024-08-22 14:07:15 +03:00
Melinda Fekete
341703978a
docs: Update projects docs (#7941) 2024-08-21 14:56:17 +02:00
Mateusz Kwasniewski
7d3368bbfd
docs: change request preview playground (#7738) 2024-08-08 11:42:04 +02:00
Mateusz Kwasniewski
fee318ab09
docs: insights v2 docs update (#7692) 2024-08-05 11:57:00 +02:00
Alvin Bryan
901f4dd682
docs: Cleanup 🧹 (#7659)
Removed old references to proxy

---------

Co-authored-by: Simon Hornby <simon@getunleash.io>
2024-07-26 09:51:48 +01:00
Nuno Góis
5b37a90390
docs: integration events (#7670)
https://linear.app/unleash/issue/2-2444/write-documentation-on-integration-events

Adds documentation for integration events.

Should be pretty straightforward, so a section in the existing
integrations reference doc should be good enough.

See it here:
https://unleash-docs-git-docs-integration-events-unleash-team.vercel.app/reference/integrations#integration-events
2024-07-25 15:29:09 +01:00
Thomas Heartman
d5cfacd6ba
docs: add a footnote about how archived flags don't count towards the flag limit (#7587)
This change adds a footnote to the resource limits doc, explaining
that archived flags don't count towards the flag limit.
2024-07-15 11:03:30 +02:00
Thomas Heartman
f0b49db06a
docs: document resource limits (#7567)
This PR adds the first version of the resource limit documentation. It
also corrects the link in the `Limit` component.

In addition to the new limits from the soft limits project, I've also
added the limits from the signals project.

## Discussion points

I've set the Pro resource limits to projects and envs to the same value
as on the [plans & pricing](https://www.getunleash.io/pricing) page
instead of the actual hard soft limit. I think that makes messaging
easier and more consistent.

However, this does present us with a bit of a problem. Because we've
been pretty consistent at saying "no, you can't have more projects" for
Pro. But we're saying it's easy to change (when in actuality the limit
isn't enforced 💁🏼 )

## Screenie

It looks a little bit like this (but check the files or preview for the
actual text content)

![image](https://github.com/Unleash/unleash/assets/17786332/56cadc00-5a8e-4820-8b11-d059112934da)
2024-07-11 14:10:49 +02:00
Simon Hornby
2cf15fe8cb
docs: move provisioning reference to scim reference (#7338) 2024-06-10 15:48:46 +02:00
Simon Hornby
717c44b3cc
docs: scim entra docs (#7300) 2024-06-06 09:45:45 +02:00
Jaanus Sellin
ab3cbcfa56
feat: insights docs (#7189)
Documentation for insights features
2024-05-29 11:15:46 +03:00
David Leek
4a41e624a6
chore(docs): additional removal notices of state api/service (#7197) 2024-05-29 08:37:40 +02:00
Simon Hornby
faefbc5f3a
docs: Okta SCIM setup (#7130) 2024-05-27 13:15:20 +02:00
Jaanus Sellin
bd90d1304e
chore: rename toggle to flag #final (#7146) 2024-05-24 15:07:01 +03:00
Jaanus Sellin
4ae65d6d5e
chore: rename toggle to flags in docs #3 (#7143) 2024-05-24 14:21:18 +03:00
Jaanus Sellin
83dfdc7905
chore: rename toggle to flags in docs #2 (#7141) 2024-05-24 13:28:49 +03:00
Jaanus Sellin
d2176880e2
chore: rename toggle to flag docs #1 (#7136)
This is first iteration for docs.
2024-05-24 12:30:10 +03:00
Mateusz Kwasniewski
88e3b1b79e
feat: deprecate feature toggle variants at environment level (#7058) 2024-05-16 10:57:32 +02:00
Fredrik Strand Oseberg
85d3ccbd79
chore: update documentation for feature toggle variants (#7064)
Add documentation of feature flag variant types

Closes #7056
2024-05-16 10:41:50 +02:00
Mateusz Kwasniewski
701c845f09
feat: uncomplete tracking (#7053) 2024-05-14 15:04:31 +02:00
Alvin Bryan
5b8c63f748
Docs fixes (#7050)
- Fixed a typo
- Updated the docs to remove a mention of v4
- Removed old v3 page
2024-05-14 10:05:27 +01:00
Mateusz Kwasniewski
21961207ca
docs: feature lifecycle (#7034) 2024-05-13 11:51:21 +02:00
Jaanus Sellin
5c61667282
feat: add completed event as webhook event (#6968)
Now feature completed event can be used with webhook.
2024-05-02 14:48:33 +03:00
Nuno Góis
95ebe25ada
docs: update feature availability (#6971)
Updates feature availability. 

Banners is a feature that is already GA'd since Unleash 5.7, so beta
availability seems irrelevant now.

We removed the mention of planning to GA Signals & Actions in 5.12,
since that's not happening and we would prefer not to include these
mentions in the future.
2024-05-02 11:19:44 +01:00
Alvin Bryan
d1cad6ece3
Example Docs fixes (#6919)
Hello, 

As discussed with @sighphyre, there were a number of problems with the
examples docs. This addresses the most pressing ones, namely:

- Corrected the link to the Jira plugin
- Added deprecation warning to Jira Server pages
- Removed the incomplete markdown table at the end of articles, and the
references to it

---------

Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
2024-04-26 17:22:16 +01:00
Alvin Bryan
8c6feb7925
Docs: Fixed missing values in webhooks (#6833)
Fixed missing values in the webhook docs, the list of values is from
[the type
definitions](d3eac6caf8/src/lib/addons/webhook-definition.ts (L100-L129))

Credit goes to @gastonfournier for finding these 🙏
2024-04-12 18:32:01 +01:00
Thomas Heartman
c773145cf6
docs: indicate that scheduled config changes are GA (#6843)
Scheduled config changes aren't in dev anymore; they went GA in 5.10.
This PR updates the docs to reflect that.
2024-04-12 09:20:18 +02:00
Mateusz Kwasniewski
fe6aaf7739
docs: variant dependencies (#6758) 2024-04-03 10:31:58 +02:00
Michael Ferranti
317a204070
fixed typo (#6694)
found a small typo and fixed it.
2024-04-02 10:44:23 +01:00
Gastón Fournier
5db197839c
docs: signals and actions documentation (#6641)
## About the changes
This is the initial documentation for actions and signals.

Preview the changes:
https://unleash-docs-git-signals-docs-unleash-team.vercel.app/

- Actions:
https://unleash-docs-git-signals-docs-unleash-team.vercel.app/reference/actions
- Signals:
https://unleash-docs-git-signals-docs-unleash-team.vercel.app/reference/signals

---------

Co-authored-by: Alvin Bryan <107407814+alvinometric@users.noreply.github.com>
Co-authored-by: Nuno Góis <github@nunogois.com>
2024-03-21 19:40:09 +00:00
Jaanus Sellin
f0240eb90e
feat: docs for sdk reporting (#6580)
![image](https://github.com/Unleash/unleash/assets/964450/43fc0d50-6016-4140-9f22-7d56169c375b)

![image](https://github.com/Unleash/unleash/assets/964450/fc9a574e-995c-4278-ba2e-c6d5e0b1088e)
2024-03-15 11:02:59 +02:00
Thomas Heartman
56c3dc438f
docs: add notes about how Unleash deals with string context values and conversion (#6551)
This change addresses the question in #6542 about using non-string
operators on string values by clarifying that Unleash SDK converts the
string values before performing the comparison.
2024-03-14 13:27:36 +02:00
Sebastian Bury
34729e8205
add custom root roles to docs on private projects (#5829)
<!-- Thanks for creating a PR! To make it easier for reviewers and
everyone else to understand what your changes relate to, please add some
relevant content to the headings below. Feel free to ignore or delete
sections that you don't think are relevant. Thank you! ❤️ -->

## About the changes
<!-- Describe the changes introduced. What are they and why are they
being introduced? Feel free to also add screenshots or steps to view the
changes if they're visual. -->

<!-- Does it close an issue? Multiple? -->
Closes #

<!-- (For internal contributors): Does it relate to an issue on public
roadmap? -->
<!--
Relates to [roadmap](https://github.com/orgs/Unleash/projects/10) item:
#
-->

### Important files
<!-- PRs can contain a lot of changes, but not all changes are equally
important. Where should a reviewer start looking to get an overview of
the changes? Are any files particularly important? -->


## Discussion points
<!-- Anything about the PR you'd like to discuss before it gets merged?
Got any questions or doubts? -->

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.io>
2024-03-12 16:42:41 +01:00
Gastón Fournier
70499dc1d4
feat: allow api token middleware to fetch from db (#6344)
## About the changes
When edge is configured to automatically generate tokens, it requires
the token to be present in all unleash instances.
It's behind a flag which enables us to turn it on on a case by case
scenario.

The risk of this implementation is that we'd be adding load to the
database in the middleware that evaluates tokens (which are present in
mostly all our API calls. We only query when the token is missing but
because the /client and /frontend endpoints which will be the affected
ones are high throughput, we want to be extra careful to avoid DDoSing
ourselves

## Alternatives:
One alternative would be that we merge the two endpoints into one.
Currently, Edge does the following:
If the token is not valid, it tries to create a token using a service
account token and /api/admin/create-token endpoint. Then it uses the
token generated (which is returned from the prior endpoint) to query
/api/frontend. What if we could call /api/frontend with the same service
account we use to create the token? It may sound risky but if the same
application holding the service account token with permission to create
a token, can call /api/frontend via the generated token, shouldn't it be
able to call the endpoint directly?

The purpose of the token is authentication and authorization. With the
two tokens we are authenticating the same app with 2 different
authorization scopes, but because it's the same app we are
authenticating, can't we just use one token and assume that the app has
both scopes?

If the service account already has permissions to create a token and
then use that token for further actions, allowing it to directly call
/api/frontend does not necessarily introduce new security risks. The
only risk is allowing the app to generate new tokens. Which leads to the
third alternative: should we just remove this option from edge?
2024-02-27 16:08:44 +01:00
Nuno Góis
6a9f80c554
fix: misc UI/UX fixes (#6241)
https://linear.app/unleash/issue/UNL-338/adjustments-incoming-webhooks-actions

Includes misc UI/UX fixes, including a typo, the vertical alignment of
the Enterprise badge in project settings and the way incoming webhooks
are displayed in non-Enterprise plans.
2024-02-15 08:17:11 +00:00
Thomas Heartman
fd977c57e8
docs: mention that environment-level variants also suspend CRs now (#6211)
Small update to extend an existing description.
2024-02-14 10:12:39 +09:00
Thomas Heartman
ba2cde7c50
docs: update change request doc to mention strategy/segment suspension (#6163)
This change updates the change request scheduling docs to include
information about what happens when a strategy or segment is updated
in the background, as well as updated information about the emails
that it sends out.
2024-02-09 14:50:18 +09:00
Thomas Heartman
b123acfd00
docs: update availability notice to say patterns were released in 5.7 (#6160)
We forgot to update this after the release, so just cleaning it up now.
2024-02-08 09:05:57 +09:00
Jaanus Sellin
884bc86745
chore: add documentation to search filters/operators (#6088)
![image](https://github.com/Unleash/unleash/assets/964450/d8920542-78b6-48e1-96a9-6d8d60082849)

![image](https://github.com/Unleash/unleash/assets/964450/406d7f21-01e2-4b75-9b1e-b48f319669dd)
2024-01-31 13:28:15 +02:00