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

843 Commits

Author SHA1 Message Date
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
Alvin Bryan
e33e538263
Rust tutorial (#7564)
I'm no Rustacean, so feel free to change things 😄

---------

Co-authored-by: Simon Hornby <simon@getunleash.io>
Co-authored-by: Thomas Heartman <thomas@getunleash.io>
2024-07-16 09:03:43 -04: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
David Leek
addbf79d95
docs: add a docs entry for file based OSS featureset import (#7520) 2024-07-02 15:26:44 +02:00
Nnenna Ndukwe
fe3c8eab3c
docs: iOS tutorial (#7486)
<img width="995" alt="ios-tutorial-app-view"
src="https://github.com/Unleash/unleash/assets/22972707/9f11750a-6130-494a-aa75-34fc5676e61f">
<!-- 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. -->

new iOS tutorial. very simple for logging a feature flag status.

<!-- 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-06-28 08:13:56 -04:00
Christopher Kolstad
f4e3388606
task: Yarn v4 (#7457)
Moves to Yarn v4

---------

Co-authored-by: Alvin Bryan <107407814+alvinometric@users.noreply.github.com>
2024-06-27 12:52:43 +02:00
Gastón Fournier
a26bbf1a7e
fix: add license key notice to upgrade instructions (#7440)
Add missing notice about license keys when upgrading to v6
2024-06-25 11:47:54 +02:00
Alvin Bryan
393b65e04b
Removed old v3 and v4 docs (#7402)
🔥
2024-06-18 14:14:20 +01:00
Thomas Heartman
e44c3b1ee7
docs: replace png with svg for feature flag org methods (#7407)
This is a follow-up to the recent new doc, replacing a png with a svg.
2024-06-18 11:36:36 +01:00
Michael Ferranti
3f5cf3baac
Best practices for using feature flag systems article (#7389)
## About the changes
Adding best practices for using feature flag systems article written
with @thomasheartman, @chriswk and @ivarconr.

---------

Co-authored-by: Michael Ferranti <ferranti.michael@gmail.com>
Co-authored-by: Alvin Bryan <107407814+alvinometric@users.noreply.github.com>
Co-authored-by: Thomas Heartman <thomasheartman+github@gmail.com>
2024-06-17 12:55:44 +01:00
Nnenna Ndukwe
803a55d103
update canary deployments sections in examples (#7363)
<!-- 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. -->

Cleaned up the canary deployment sections

<!-- 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-06-14 07:22:19 -04:00
Alvin Bryan
3c56bfa992
Fixed typo in 11 Principles articles (#7381)
Thanks @nunogois for catching it.
2024-06-13 12:15:00 +01:00
Gastón Fournier
a0fce0ec12
Revert "fix: yarn v4 requires prepack instead of prepare script when building…" (#7373)
Reverts Unleash/unleash#7371
2024-06-12 13:25:51 +02:00
Christopher Kolstad
a971c770e9
task: Yarn v4 (#7345)
Trying again, this time with correct .gitignore already setup, and a
workflow configured to try what was failing prior to our revert.
2024-06-12 11:18:21 +02:00
Alvin Bryan
a602768c57
docs: Updated and formatted license docs. (#7349)
The license keys are no longer in beta as of v6.
2024-06-11 09:55:07 +01:00
Alvin Bryan
60166096aa
Docs: Merged migration articles into a single document (#7324)
Just like #7266, this consolidates the "Best Practices for Migrating
from a Homegrown Feature Management Solution" article into a single
document, that you can navigate using the TOC on the right side, rather
than the sidebar on the left hand side.

We also update the redirects to that the old links still work.

This also correctly sets @ardeche07 as an Unleash team member 😅
2024-06-10 17:16:52 +01:00
Simon Hornby
2cf15fe8cb
docs: move provisioning reference to scim reference (#7338) 2024-06-10 15:48:46 +02:00
Jaanus Sellin
f0f339ead3
fix: revert yarn4 (#7334)
Reverting yarn4, because we are stuck on broker build for couple of days
now.
2024-06-10 14:35:18 +03:00
Alvin Bryan
f8abfee1dc
Docs: Merged 11 principles articles into a single document (#7266)
This consolidates the "11 Principles for building and scaling feature
flag systems" article into a single document, that you can navigate
using the TOC on the right side, rather than the sidebar on the left
hand side.

This also updates the redirects to that the old links still work.
2024-06-07 13:30:38 +01:00
Christopher Kolstad
15726cc8ac
chore: upgrade to yarn v4 (#7230)
![Outdated as of
2020](https://github.com/Unleash/unleash/assets/177402/689a1bcc-441d-4b87-88a6-125e68a17f26)

This has been on our TODO list for a long time.

We're moving to latest released at the time of commit (v4.2.2)
2024-06-07 14:00:19 +02:00
Gastón Fournier
eef1d2980c
docs: v6 upgrading notes (#7275)
## About the changes
This include some notes about the migration guide based on
https://github.com/Unleash/unleash/issues/4380

Initially, we don't expect any breaking change provided users are not
using deprecated functionality and your Postgress is in one of the supported versions

---------

Co-authored-by: Ivar Conradi Østhus <ivar@getunleash.io>
Co-authored-by: sjaanus <sellinjaanus@gmail.com>
Co-authored-by: Thomas Heartman <thomas@getunleash.io>
Co-authored-by: Nuno Góis <github@nunogois.com>
2024-06-06 09:47:55 +02:00
Simon Hornby
717c44b3cc
docs: scim entra docs (#7300) 2024-06-06 09:45:45 +02:00
Thomas Heartman
9801bf69b3
docs: add more clarification on when to use sx vs styled (#7209)
This change adds a section on when to use `sx` vs `styled`. I'm adding
it because it was unclear to me when we should use one over the other.
Hopefully this clears it up and makes it easier for others going
forward.

---------

Co-authored-by: Nuno Góis <github@nunogois.com>
2024-05-29 14:45:05 +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
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
10ca389f1e
chore: update illustrations for unleash anatomy (#7163)
Updating toggle to flag in unleash anatomy
2024-05-27 13:52:42 +03:00
Jaanus Sellin
bd90d1304e
chore: rename toggle to flag #final (#7146) 2024-05-24 15:07:01 +03:00
Alvin Bryan
5ae03911f1
.NET examples (#7061)
Another one for you @daveleek 🙏

---------

Co-authored-by: Nnenna Ndukwe <nnenna.s.ndukwe@gmail.com>
2024-05-24 07:42:10 -04:00
Nnenna Ndukwe
2bbd541f51
chore: update anchor toggle titles (#7145)
<!-- 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. -->

- update anchor link descriptions
- fix ordered lists across files
- formatting updates

<!-- 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-05-24 07:41:04 -04:00
Jaanus Sellin
4ae65d6d5e
chore: rename toggle to flags in docs #3 (#7143) 2024-05-24 14:21:18 +03:00
Nnenna Ndukwe
81c6caf211
docs: update quickstart and tutorials with flag reference (#7142)
<!-- 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 making a round of updates to change all references of "feature
toggle" to "feature flag".
This is also under the assumption that "Create feature toggle" in the
product UI will become "creature feature flag".

There are also formatting improvements to the docs included in this PR.

> Note: This does not include anchors and links for now.

## Discussion points
<!-- Anything about the PR you'd like to discuss before it gets merged?
Got any questions or doubts? -->
2024-05-24 06:51:50 -04: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