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

136 Commits

Author SHA1 Message Date
David Leek
0938b2e545
docs: improve datadog integration docs (#4802)
## About the changes

Improvement to the description of the datadog integration. Adds 2
missing event types, removes an event type that is deprecated and about
to be completely removed, adds missing description of extra json headers
and source type name, and adds description for the new configuration
option for JSON body support

---------

Co-authored-by: Nuno Góis <github@nunogois.com>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-09-26 11:15:22 +01:00
Nuno Góis
b9946ee35c
docs: Unleash Slack App integration (#4801)
https://linear.app/unleash/issue/2-1235/docs-slack-app-integration-documentation

This adds a new reference doc for the new Unleash Slack App integration
and marks the previous Slack integration as deprecated.

As a side-effect this PR also fixes an issue where we wouldn't be able
to delete tags with special characters.

---------

Co-authored-by: David Leek <david@getunleash.io>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-09-22 23:19:17 +01:00
Ivar Conradi Østhus
013efac46b
feat: open-source segments 🚀 (#4690)
We love all open-source Unleash users. in 2022 we built the [segment
capability](https://docs.getunleash.io/reference/segments) (v4.13) as an
enterprise feature, simplify life for our customers.

Now it is time to contribute it to the world 🌏

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.io>
2023-09-19 11:24:26 +00:00
Thomas Heartman
53c40372dd
Update webhook.md (#4739)
fix a couple typos
2023-09-15 11:15:50 +02:00
Thomas Heartman
1539d1955f
docs(1-1262): Change addons -> integrations (#4523)
This PR replaces references to _addons_ in the docs with references to
_integrations_.

In doing so, I have also:
- moved `/reference/addons` documents into `/reference/integrations`
- combined the previous "Addons" and "Integrations" categories into a
new "Integrations" category
- added redirects from all the old addons pages to their new locations

I have updated the wording, but have not changed things such as API
paths, event names, etc, because these will not change at the moment
(maybe a breaking change to schedule for v6?).

---------

Co-authored-by: Tymoteusz Czech <2625371+Tymek@users.noreply.github.com>
2023-09-14 15:27:51 +02:00
Tymoteusz Czech
e8d5f0cf56
fix: integrations text review (#4706)
## About the changes
Update copy

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-09-14 12:01:29 +00:00
Tymoteusz Czech
66c790fbf1
fix: Integrations quality updates (#4677)
Fix issues uncovered when reviewing integrations list and form.

- YouTube CSP
- Text content and formatting
- Margins
- Update old integration icons
- Fix headers in dark theme
2023-09-14 10:17:33 +02:00
Thomas Heartman
85f03ba567
Update webhook.md (#4684)
fix a typo
2023-09-14 08:09:39 +02:00
Thomas Heartman
44db4fb0c3
1-1360: explain implicit ^ and $ in docs (#4668)
Update docs to explain that ^ and $ are implicit in the regexes used.
2023-09-12 14:23:19 +02:00
Nuno Góis
c6af38b12b
docs: add mention of multiple project roles (#4648)
https://linear.app/unleash/issue/2-1130/documentation-about-multiple-project-roles

- Adds a section for the feature in the "Role-based Access control"
reference doc;
- Removes the mention that "Groups that *do* have a root role can't be
assigned to a project." which is no longer true;
- Adds a reference to multiple project roles in the "How to create and
assign custom project roles" guide;
- Fixes a wrong sentence in the "Assigning custom project roles" section
of the aforementioned guide;

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-09-11 14:41:47 +01:00
Thomas Heartman
4de3ff3d2f
docs: feature flag naming patterns (#4632)
This PR adds a reference doc and a how-to doc for feature flag naming
patterns.

Extra thanks to @sebastian-bury for the draft from the offsite 👏🏼
2023-09-11 15:28:10 +02:00
Simon Hornby
2b210a85fd
docs: update compatibility matrix with strategy variants (#4626) 2023-09-08 10:34:04 +02:00
Nuno Góis
1ae700a027
feat: add request logger env variable (#4614)
Adds a new env variable for request logger.

---------

Co-authored-by: Gastón Fournier <gaston@getunleash.io>
2023-09-05 15:32:20 +01:00
Mateusz Kwasniewski
3ebeea4d64
docs: strategy variants ruby and dotnet sdk versions (#4570) 2023-08-25 08:28:47 +02:00
Mateusz Kwasniewski
a2bd7d42a1
feat: change request reject docs and step update (#4493) 2023-08-16 09:46:05 +02:00
Mateusz Kwasniewski
90f5af6b61
docs: change requests for segments (#4476) 2023-08-11 09:48:37 +02:00
Nuno Góis
95f4f641b5
docs: custom root roles (#4451)
https://linear.app/unleash/issue/2-1136/custom-root-roles-documentation

- [Adds documentation referencing custom root
roles](https://unleash-docs-git-docs-custom-root-roles-unleash-team.vercel.app/reference/rbac);
- [Adds a "How to create and assign custom root roles" how-to
guide](https://unleash-docs-git-docs-custom-root-roles-unleash-team.vercel.app/how-to/how-to-create-and-assign-custom-root-roles);
 - Standardizes "global" roles to "root" roles;
- Standardizes "standard" roles to "predefined" roles to better reflect
their behavior and what is shown in our UI;
 - Updates predefined role descriptions and makes them consistent;
 - Updates the side panel description of the user form;
- Includes some boy scouting with some tiny fixes of things identified
along the way (e.g. the role form was persisting old data when closed
and re-opened);
 
 Questions:

- Is it worth expanding the "Assigning custom root roles" section in the
"How to create and assign custom root roles" guide to include the steps
for assigning a root role for each entity (user, service account,
group)?
- Should this PR include an update to the existing "How to create and
assign custom project roles" guide? We've since updated the UI;

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-08-10 08:21:58 +01:00
Mateusz Kwasniewski
c549280e31
fix: Performance improvements for demo and docs update (#4454) 2023-08-09 12:58:03 +02:00
Mateusz Kwasniewski
f889eba6e9
docs: update strategy variants sdks and add sidebar link (#4436) 2023-08-07 14:53:13 +02:00
Mateusz Kwasniewski
20b1559329
docs: strategy variants in 5.4 (#4372) 2023-08-02 12:27:24 +02:00
Thomas Heartman
b8ab43543f
remove trailing periods (#4378)
remove trailing periods in markdown.
2023-08-01 15:20:10 +02:00
Mateusz Kwasniewski
55148eb549
docs: strategy variants (#4289) 2023-07-25 15:35:29 +02:00
Thomas Heartman
60b9431b67
docs: document feature potentially stale on events (#4278)
Document new "feature-potentially-stale-on" events.

Relates to #4205
2023-07-19 15:20:01 +02:00
Thomas Heartman
6ac430ff2d
docs(#4205): update feature toggle types doc to add lifetime info (#4273)
This change updates the existing feature toggle types document to add
a new `expected lifetime` section. This section explains better what
lifetimes are, where they come from, and that admins can (soon) change
the expected lifetimes for feature toggles.
2023-07-19 11:27:02 +02:00
Thomas Heartman
ea5b26c7a3
Chore: move event types into a separate reference doc. (#4268)
Remove the list from the events API page and instead point to the new
doc.

The new page is listed as "event types" under "unleash concepts"
2023-07-19 11:25:27 +02:00
Simon Hornby
4fc0f61753
docs: update postgres ssl docs to accurately use ca over key (#4271) 2023-07-18 14:11:25 +02:00
Thomas Heartman
35fbd8f271
docs: update playground docs to mention advanced features (#4266)
This change updates the playground reference docs with some new images
and an explanation of how the results work now.

I have not removed any of the old images because I think they still
illustrate well how the playground works. And because they're not
direct screenshots anyway, that sounds like a fair trade-off to me.
2023-07-18 12:59:19 +02:00
David Leek
eb1df78383
docs: add description of how to install jira cloud plugin (#4197) 2023-07-13 09:36:38 +02:00
Gastón Fournier
96bc5ccd94
docs: suggest to use strategy constraints instead of custom strategies (#4215)
## About the changes
Custom activation strategies are still the recommended way to go in our
documentation, but now most of the use cases for custom activation
strategies can be covered by strategy constraints (released with Unleash
4.16)

With this change, we try to drive people to use strategy constraints.

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-07-11 11:35:58 +02:00
Christopher Kolstad
ff1af03f0e
docs: add impression events as supported in the java sdk (#4213)
## What
A very small change flagging impression events as supported in the Java
SDK
2023-07-11 10:54:49 +02:00
Mateusz Kwasniewski
3ebf3c05f8
docs: project overview (#4176) 2023-07-07 11:50:54 +02:00
Mateusz Kwasniewski
79b34121a4
feat: openapi schema for user admin (#4146) 2023-07-06 08:24:46 +02:00
Thomas Heartman
9c7eadded0
docs: switch order of api doc sidebar items; put legacy docs under legacy header (#4135)
Also adds a caution admonition to the legacy doc index page
2023-07-04 14:19:34 +02:00
Gastón Fournier
13def9a3a3
docs: Documentation around metrics API (#4134)
## About the changes
Mark some legacy endpoints as deprecated (they are long deprecated but
documentation was out of date) and fix some of the URLs
2023-07-04 11:16:05 +02:00
John Farrar
65995b238a
Update index.md, 2 grammar updates (#4086)
Included a library from the ColdBox Open Source team.

More detail here if needed.
https://forgebox.io/view/unleashsdk

I cheated on the grammar. Grammarly helps me out there.
2023-06-29 10:02:27 +00:00
Even Brenden
be1e63508a
docs: Add reference to Haskell SDK (#3752)
Hi! Adding a link to a some-batteries-included Haskell Unleash SDK. It
uses a "core" library underneath that adheres to your [Client
Specifications](https://github.com/Unleash/client-specification). Could
add a link to that too, but from what I can tell, it's overlapped by
your Yggdrasil project. We have been using the SDK for a handful of
months now and we're happy with how it works. Hope you'll have it :)

Co-authored-by: Even Brenden <evenbrenden@users.noreply.github.com>
2023-06-27 08:08:04 +01:00
andreas-unleash
7a5c77376a
chore: Document default strategy (#4010)
<!-- 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! ❤️ -->
Documenting Default Strategy 
## 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 #
[1-1023](https://linear.app/unleash/issue/1-1023/document-strategy-improvements)

<!-- (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? -->

---------

Signed-off-by: andreas-unleash <andreas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-06-22 15:42:07 +00:00
Christopher Kolstad
fa081e9014
task: Make keepalive configurable via an environment variable (#4015)
As requested in
[Linear](https://linear.app/unleash/issue/2-1147/unleash-cloud-make-keepalive-configurable)
this PR makes the serverKeepAliveTimeout configurable via the
SERVER_KEEPALIVE_TIMEOUT environment variable. This was already
configurable when starting Unleash programmatically, but it's nice to
have as an env variable as well
2023-06-20 12:10:05 +02:00
yuri-karelics
331f0f27fa
docs: angular unleash proxy client (#3897)
List of community unleash proxy clients extended with new Angular
library

## About the changes
Relates to
[discussion](https://github.com/orgs/Unleash/discussions/3621)
2023-06-16 17:54:37 +00:00
Jaanus Sellin
41370be591
feat: update predefined strategies tooltip (#3964) 2023-06-14 08:46:15 +03:00
andreas-unleash
8daab71219
Docs: update stickiness docs (#3928)
<!-- 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? -->

---------

Signed-off-by: andreas-unleash <andreas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-06-13 11:26:12 +03:00
Sebastian Bury
282de2477f
docs: azure sso guide (#3431)
## About the changes
Added Azure SSO SAML 2.0 instructions based off of testing/user
feedback.

<!-- Does it close an issue? Multiple? -->
Not on GH, internally yes

### Important files
website>docs>how-to>how-to-add-sso-azure-saml.md
website>docs>static>img (added images for docs)

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2023-05-25 08:37:39 +02:00
Mateusz Kwasniewski
78715e3374
docs: maintanance mode impact (#3858) 2023-05-25 08:28:05 +02:00
Simon Hornby
6067888534
docs: extend group documentation to include information on setting root roles (#3696)
This adds documentation to the RBAC section on how to use root roles on
groups and updates a few screenshots for the group pages.

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-05-17 08:59:35 +02:00
Christopher Kolstad
191e40c95e
docs: update segment limits (#3733)
### What
Since 3ed4aeba5c, we've updated the
segment limits and added separate limits for pro and enterprise. This PR
updates the docs with the new limits.

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-05-11 08:24:14 +00:00
Gastón Fournier
8023fef711
docs: update to node 18 (#3689)
## About the changes
Update documentation to the minimum version of node. This was already
updated in other parts of the documentation

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.io>
2023-05-05 09:17:34 +02:00
Thomas Heartman
b815fa1a9d
docs: add migration guide entry for v4 -> v5 (#3650)
This lists the breaking changes between the versions to make it easier
(and safer) for users to upgrade
2023-04-28 13:10:30 +02:00
Christopher Kolstad
1fdf68eeec
task: removes deprecated feature api (#3609)
### What
We've had this marked as deprecated through our v4, this PR removes it.

### Worth noting
This updates the deprecation notices with removal notices in the
documentation as well.

### Considerations
The tags API is still located under
/api/admin/features/{featureName}/tags. It should be moved to
/api/admin/projects/{project}/features/{featureName}/tags. I vote we do
that in a separate PR, we'd probably also need to deprecate the existing
tags endpoints for v5 and remove in v6. We could use 308s to signify
that they are moved.

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-04-26 10:45:00 +02:00
Mateusz Kwasniewski
7eda493e8e
docs: skip CR also works in the UI (#3518) 2023-04-26 08:49:34 +02:00
Jaanus Sellin
28f61e05ff
feat: fix csp headers for feedback form (#3617)
Fix feedback form failing due to missing csp headers
2023-04-25 13:40:55 +03:00