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

878 Commits

Author SHA1 Message Date
Melinda Fekete
5d61b3903b
Ab testing cleanup redirect (#8392) 2024-10-08 17:33:47 +02:00
Melinda Fekete
8736d2a916
Events docs revamp (#8360) 2024-10-08 12:11:05 +02:00
Nnenna Ndukwe
29bf902d8a
docs: update intro to point to quickstart and unleash plans (#8292)
<!-- 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: Alvin Bryan <107407814+alvinometric@users.noreply.github.com>
2024-10-03 16:04:21 +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
Nnenna Ndukwe
b726a229d3
docs: A/B Testing Use Case Tutorial (#8257)
<img width="923" alt="Screenshot 2024-09-27 at 8 33 00 AM"
src="https://github.com/user-attachments/assets/7078b3fc-7d3a-44b9-9ab6-30f82bd1489f">

<!-- 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. -->

We are adding another use case tutorial to our docs!
Updates may come to this PR based on further engineering review.

<!-- 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-09-27 19:55:11 +02:00
Mateusz Kwasniewski
15144e4e93
docs: feature lifecycle availability (#8288) 2024-09-27 12:28:50 +02:00
Alvin Bryan
d1c3e3fa2c
Matching <title> and h1 for "11 principles" post (#8206) 2024-09-26 16:47:25 +01:00
Christopher Kolstad
547e41e566
docs: recommend PG v13 or later (#8276)
Unify on PG v13, we had one place recommending v10, release notes for v6
saying we dropped support for v10 through v12 and mentioning 13, and a
place mentioning 14 or newer.

fixes: #8265

---------

Co-authored-by: Melinda Fekete <melinda.fekete@getunleash.io>
2024-09-26 14:38:00 +02:00
Mateusz Kwasniewski
33f44072dc
docs: demo is pro (#8270) 2024-09-26 11:24:41 +02:00
Melinda Fekete
7d38048ee8
Update Entra ID SAML SSO docs (#8151) 2024-09-20 17:37:10 +02:00
Nnenna Ndukwe
e3a8dafe6d
docs: remove extra diagram (#8203)
<!-- 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? -->
2024-09-20 14:55:34 +02:00
Alvin Bryan
35004fe7f1
Revert title change (#8192)
Revert the title change in #7643 back to "11 Principles" and removed the
description
2024-09-20 08:47:08 +01:00
Nnenna Ndukwe
1fb62391ec
docs: add in gradual rollout use case doc (#8172)
<img width="915" alt="Screenshot 2024-09-18 at 9 01 13 AM"
src="https://github.com/user-attachments/assets/7e082be8-f10b-44f8-8e62-461a2f3e27e3">
<!-- 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. -->

Adding in 1 of 7 use cases to our feature flag tutorials docs.

Upcoming additions to this PR:
- diagrams
- unleash feature flag enterprise security section

<!-- 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-09-19 23:46:33 +02:00
Tymoteusz Czech
aa7757a2d1
fix: typo and improved example in latest ADR (#8063)
https://github.com/Unleash/unleash/pull/8025#discussion_r1740561994
2024-09-19 14:44:16 +02:00
Melinda Fekete
7051fabecd
Consolide 'What is a feature flag' docs (#8050) 2024-09-09 10:35:56 +02:00
Nuno Góis
ec417bf15e
docs: remove mention of admin name and email env vars (#8096)
https://github.com/Unleash/unleash/pull/7795 mistakenly included a
mention that these environment variables can be used:

- `UNLEASH_DEFAULT_ADMIN_NAME`
- `UNLEASH_DEFAULT_ADMIN_EMAIL`

However that's not really the case, since we decided to remove their
respective implementation before merging that PR.
2024-09-05 09:27:54 +01:00
Alvin Bryan
896707f7d5
Django tutorial + Nav update (#7982)
Updating the nav so Django and Rails are both listed under their
respective language.

---------

Co-authored-by: Simon Hornby <simon@getunleash.io>
Co-authored-by: Melinda Fekete <melinda.fekete@getunleash.io>
2024-09-04 09:14:55 +01:00
Tymoteusz Czech
712d1c6fa4
ADR: Use of conditionals in JSX (</ConditionallyRender>) (#8025)
Co-authored-by: Melinda Fekete <melinda.fekete@getunleash.io>
2024-09-02 10:12:09 +02:00
Alvin Bryan
064744b18f
Updated diagrams (#7983) 2024-08-26 17:36:37 +01:00
Alvin Bryan
1947c7bc81
Alvin/update rails (#7975)
Also updated the SDK's readme to make sure this doesn't happen again
2024-08-26 14:14:45 +01: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
Alvin Bryan
2ec2639fa3
Added video link and fixed types (#7942)
Kudos to GitHub for showing the diff despite me renaming the file
2024-08-20 19:00:38 +01:00
Melinda Fekete
500a9c7df4
Update 11 principles docs (#7907) 2024-08-20 17:19:12 +02:00
dagl200
35196b53c1
Fix docs for managing constraints (#7900) 2024-08-19 09:44:07 +02:00
Thomas Heartman
64a9caab30
fix: display 3 types of models image (#7885)
The link to the image was incorrectly formatted, leading to the image
being displayed as a link. This fixes it so that the image is displayed
inline.
2024-08-15 11:12:04 +02:00
Nuno Góis
585eb30730
chore: initial admin email (#7795)
https://linear.app/unleash/issue/2-2518/figure-out-how-to-create-the-initial-admin-user-in-unleash

The logic around `initAdminUser` that was introduced in
https://github.com/Unleash/unleash/pull/4927 confused me a bit. I wrote
new tests with what I assume are our expectations for this feature and
refactored the code accordingly, but would like someone to confirm that
it makes sense to them as well.

The logic was split into 2 different methods: one to get the initial
invite link, and another to send a welcome email. Now these two methods
are more granular than the previous alternative and can be used
independently of creating a new user.

---------

Co-authored-by: Gastón Fournier <gaston@getunleash.io>
2024-08-14 10:05:11 +02:00
Mateusz Kwasniewski
7d3368bbfd
docs: change request preview playground (#7738) 2024-08-08 11:42:04 +02:00
Alvin Bryan
8786240ddf
Updated <title> for 11 principles article (#7779)
Made the `<title>` and the h1 different
2024-08-07 09:08:24 +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
Alvin Bryan
440c2b6661
Rails + Django examples (#7745)
As per @riboflavin's suggestion. Let's make example pages for Rails and
Django
2024-08-06 13:51:15 +02:00
Mateusz Kwasniewski
fee318ab09
docs: insights v2 docs update (#7692) 2024-08-05 11:57:00 +02:00
Alvin Bryan
3325b2d09e
Rails tutorial (#7737)
And fixed a couple of typos in the Ruby tutorial 😄

---------

Co-authored-by: Melinda Fekete <melinda.fekete@getunleash.io>
2024-08-02 16:31:02 +01:00
Alvin Bryan
5bec8ea508
Made the Rust tutorial simpler (#7680)
This makes the Rust tutorial simpler, by converting to JPEG and Webp,
which means
- Compiles on Ubuntu
- Removes the need for the `rgb` and `ravif` crate
- Makes the `process_images` function a lot simpler
2024-07-26 12:29:31 +01:00
Alvin Bryan
049b26fb77 Revert "Docs: Made the Rust tutorial simpler"
This reverts commit 21e8c9f66f.
2024-07-26 11:37:34 +01:00
Alvin Bryan
21e8c9f66f Docs: Made the Rust tutorial simpler 2024-07-26 11:34:41 +01: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
Christopher Kolstad
da3a8cdb1e
docs: Removed the recommended chapter of PostgreSQL config (#7661)
Turns out we're hosting 20-30 customer instances on db.t4g.small, so our
recommended specs just seemed like complete overkill.
2024-07-25 10:38:07 +02:00
Christopher Kolstad
339e92f4eb
docs: Add minimum and recommended specs for Unleash and for Database (#7653)
What the title says, adds a subchapter for specs for Unleash, and a
subchapter for specs for the database

---------

Co-authored-by: Nuno Góis <github@nunogois.com>
2024-07-24 10:29:32 +00:00
Alvin Bryan
9c2b906d79
New sidebar navigation, updated titles (#7643)
1. Updates the folder structure of the main sidebar navigation to [a new
version](https://unleash-internal.slack.com/archives/C06NG1LUUCU/p1721413054821399)
2. Updates the title of `15 Principles for using feature flag systems at
scale` article to a new title given by @riboflavin
3. Updates the title of `11 Principles for building and scaling feature
flag systems` article to a new title given by @riboflavin


## Before (all collapsed)


![image](https://github.com/user-attachments/assets/1cd613e6-4752-4a58-9c28-136eb59d1336)


## After (all collapsed)


![image](https://github.com/user-attachments/assets/09546d9e-3049-4862-8139-2264541d436e)
2024-07-23 15:00:11 +01:00
Michael Ferranti
1dbc20fe91
Initial commit for What is a feature flag educational page (#7629) 2024-07-22 17:43:35 +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
Alvin Bryan
9e701e7a39
Rust examples 🦀 (#7572)
And now the examples
2024-07-19 19:34:28 +01:00
Nnenna Ndukwe
92a9b403e8
Fixing rust rebase (#7605)
<!-- 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: Alvin Bryan <hello@alvin.codes>
2024-07-16 13:23:24 -04:00
Nnenna Ndukwe
7909f563d6
iOS examples (#7599)
<!-- 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? -->
2024-07-16 09:18:37 -04:00