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

137 Commits

Author SHA1 Message Date
Melinda Fekete
56dacb668a
Update titles, descriptions, and slugs based on ercule feedback (#8509) 2024-10-24 16:09:57 +02:00
Melinda Fekete
8b0af59897
Update and restructure environments (#8496) 2024-10-22 17:55:11 +02:00
Melinda Fekete
43edac7cd4
Fix markdown 3 error for placeholder text (#8483) 2024-10-18 18:48:17 +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
Nnenna Ndukwe
41f9cac758
docs: Remove old A/B testing doc (#8258)
<!-- 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. -->

Now that we are building out our Use Case tutorials to include A/B
testing, we can remove old content that is associated.

<!-- 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? -->
2024-10-03 14:29:22 +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
Melinda Fekete
7d38048ee8
Update Entra ID SAML SSO docs (#8151) 2024-09-20 17:37:10 +02:00
Melinda Fekete
35df4c7f43
Remove outdated info box (#7781)
Removes an outdated info box that got missed when refactoring
docs content to remove 'feature toggles'. 

Co-authored-by: melindafekete <>
2024-08-06 16:51:50 +02:00
Christopher Kolstad
44192934f8
docs: Documented the environment variables available for configuring SSO (#7630)
Co-authored-by: Gastón Fournier <gaston@getunleash.io>
2024-07-22 12:02:11 +02:00
David Leek
addbf79d95
docs: add a docs entry for file based OSS featureset import (#7520) 2024-07-02 15:26:44 +02:00
Simon Hornby
717c44b3cc
docs: scim entra docs (#7300) 2024-06-06 09:45:45 +02:00
David Leek
4a41e624a6
chore(docs): additional removal notices of state api/service (#7197) 2024-05-29 08:37:40 +02:00
David Leek
61a8908694
chore: remove state service (#7184)
## About the changes

Removes the deprecated state endpoint, state-service (despite the
service itself not having been marked as deprecated), and the file
import in server-impl. Leaves a TODO in place of where file import was
as traces for a replacement file import based on the new import/export
functionality
2024-05-28 14:47:31 +02:00
Simon Hornby
faefbc5f3a
docs: Okta SCIM setup (#7130) 2024-05-27 13:15:20 +02: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
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
Nicholas Haley
ab24264df9
docs: spelling and grammar (#6007)
<!-- 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. -->
This is a demo that uses [Floe](https://www.floe.dev/) to review the
`how-to` directory using the `spelling-and-grammar` rule.

You can read more about the tool here: https://www.floe.dev/docs
2024-01-23 19:52:10 +01:00
Tommaso A
a10e91238b
chore: fix typos in how-to-add-sso-open-id-connect.md (#5270) 2023-11-06 12:19:29 +00:00
Nicolae Socaciu
5c3fe631f0
Updating the docs - how to add strategy constraints (#5256)
- Adding a new image to indicate that you also need to save the strategy
after you add a constraint
- Adding a new image showing how the edit constraint section looks like 
- Update a bit the text to match the new images
2023-11-06 10:24:52 +01:00
Drew Gorton
b2b19e4970
Navigation refactor (#5227)
## About the changes
Refactor the main nav, with the following goals: 
* Communicate the value of each section vs the format (ex:
“Understanding Unleash” vs “Topic Guides”)
* Make space for the Feature Flag tutorials section that we’re starting
to build
* Scope updates to navigation and pages that need updates based on new
URLs & organization
* Update URLs to follow the new hierarchy without breaking links (adding
redirects & editing internal links between pages as needed)

### Important files
sidebar.js
docusaurus.config.js

## Discussion points
* Redirects can't be tested out of prod, which is a bummer :/
* Some URLs have been preserved untouched while we monitor for potential
negative SEO impact of client-side redirects
* It's a large PR (sorry). Nav changes and file movements impacted lots
of files.

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-10-31 09:38:03 -05:00
Gastón Fournier
94916bc46d
docs: improve troubleshooting (#5233)
## About the changes
Adding details based on customer struggles
2023-10-31 15:00:25 +01:00
Nuno Góis
d3bd591b1d
docs: banners (#5173)
https://linear.app/unleash/issue/2-1486/docs-document-the-new-internal-message-banner-feature

Adds documentation for the "Banners" feature.

- [Banners
reference](https://unleash-docs-git-docs-banners-unleash-team.vercel.app/reference/banners)
- ["How to create and display banners"
guide](https://unleash-docs-git-docs-banners-unleash-team.vercel.app/how-to/how-to-create-and-display-banners)
 
 

![image](https://github.com/Unleash/unleash/assets/14320932/66d03dd8-4ae0-48dd-a7a2-aa364123cbf9)
2023-10-27 09:16:56 -05:00
Nuno Góis
496f6bb90c
docs: update availability due to 5.6 release (#5167)
Maybe we should update availability in our docs, now that 5.6 is
released.
2023-10-27 10:04:17 +01:00
Drew Gorton
34038ca1de
Update how-to-create-and-assign-custom-project-roles.md (#5060)
Separate videos - put them with the same written content
2023-10-17 09:05:06 -05:00
Nuno Góis
b0eba109d3
docs: add feature availability troubleshooting guide (#4989)
Adds a small troubleshooting guide for Unleash features availability.
This is not specific to features that have a visual component in the
admin UI, but that's the most common scenario.
2023-10-10 11:17:06 -05:00
Thomas Heartman
fa4d6b211a
docs: make videos bigger (#4980)
This PR changes the `VideoContent` component to:
- remove the extra text; keeps only videos
- makes videos take up the full article width
- multiple videos stack vertically (this may or may not be the best way
to handle it, but we don't have any instances of using multiple videos
as of right now, so we shouldn't touch this until we do).

By chance, it also removes a lot of trailing whitespace in files. I
suggest checking out the diff with whitespace hidden.

Before (single video):

![image](https://github.com/Unleash/unleash/assets/17786332/e47e8827-93e9-4dbc-bdfb-cdb1665fae98)


Before (if there were multiple videos): 

![image](https://github.com/Unleash/unleash/assets/17786332/f41ab11f-649f-4369-96fe-70a5d66ced40)


After (single video):

![image](https://github.com/Unleash/unleash/assets/17786332/0df9d3fd-3935-4567-93d0-470682fe4bb3)


After (if there are multiple videos): 

![image](https://github.com/Unleash/unleash/assets/17786332/98b4a590-c03c-40a1-880f-93ad05090c5e)
2023-10-10 11:42:25 +02:00
Drew Gorton
ab51a495aa
Update more instances of "toggle" with "flag" (#4821)
Landing page + sidebar nav + main 'How to create flags' page

Co-authored-by: Gastón Fournier <gaston@getunleash.io>
2023-10-02 12:37:53 -05: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
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
Gastón Fournier
ea00ea9d56
docs: troubleshooting guides (#4592)
## About the changes
Adds troubleshooting guides for some common problems under the how-to
area (following the [diataxis framework](https://diataxis.fr/)).

This is part of Unleash 2023 offsite challenge

---------

Co-authored-by: Drew Gorton <drew.gorton@getunleash.io>
Co-authored-by: Diego Susa <diego@getunleash.io>
Co-authored-by: Michael Vittiglio <michael.vittiglio@getunleash.io>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-09-01 15:39:23 +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
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
Mateusz Kwasniewski
d3b3652984
docs: not on latest unleash with openapi enabeld (#4024) 2023-07-03 13:48:46 +02:00
Simon Hornby
8443eb2649
docs: add note about how to handle more than 150 groups in Azure SSO (#4044) 2023-06-22 09:18:19 +02:00
Mateusz Kwasniewski
2356b5774b
docs: encourage feedback for sync (#4003) 2023-06-19 14:32:57 +02: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
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
Simon Hornby
f172c8851f
docs: update docs to reflect that google SSO is removed (#3626)
Updates docs to point out that Google SSO is removed and how to
temporarily bring it back
2023-05-02 11:53:11 +02:00
Mateusz Kwasniewski
10fee99467
Update how-to-synchronize-unleash-instances.md 2023-04-28 13:28:19 +02:00
Mateusz Kwasniewski
96e3e43188
docs: unleash instance synchronization (#3652) 2023-04-28 13:23:50 +02:00
Gastón Fournier
a53457f6d0
docs: removal of event hook in v5 (#3586)
## About the changes
Make it explicit that eventHook is no longer an option in v5, the
migration should be to
https://docs.getunleash.io/reference/addons/webhook which is already
linked in the docs since v4
2023-04-21 14:33:09 +02:00
andreas-unleash
5c27153e50
docs: Project api token (#3405)
<!-- 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>
2023-03-29 11:39:37 +03:00
Nuno Góis
516cb1884b
docs: login history (#3261)
https://linear.app/unleash/issue/2-728/documentation-login-history

-
[reference/login-history](https://unleash-docs-git-docs-login-history-unleash-team.vercel.app/reference/login-history)
-
[how-to/how-to-download-login-history](https://unleash-docs-git-docs-login-history-unleash-team.vercel.app/how-to/how-to-download-login-history)


![image](https://user-images.githubusercontent.com/14320932/223392428-fb693624-77a5-4d63-bb00-20e035e23f9e.png)

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-03-08 19:08:50 +00:00
Thomas Heartman
ff58e2aeaf
docs: clarify note around permissions required (#3201)
This change does two things:

It clarifies that the permissions listed in the guide are permissions
needed to perform all the steps in the guide, and not the permissions
needed to create a feature.

Separates the project-level and environment-level permissions needed
into separate sublists.
2023-02-27 11:49:53 +00:00
Thomas Heartman
94bfb757d6
docs: slight update to environment docs (#3187)
## What & why

This update does three things:

1. Adjusts the environment cloning feature availability notice: because
this has been released.
2. Updates the availability notice for environments (to conform with the
standard docusaurus way of doing things): for consistency
3. Add a brief explanation of environment types: because this isn't
documented anywhere

## Sources

The note about how environment types work is sourced from this old
[slack thread (internal to the
team)](https://unleash-community.slack.com/archives/G01MU2Q49QC/p1659600175175769)
2023-02-24 12:48:45 +00:00