1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-06-27 01:19:00 +02:00
Commit Graph

176 Commits

Author SHA1 Message Date
Tymoteusz Czech
34973967d0
docs: update technical debt info (#10132)
Co-authored-by: Melinda Fekete <melinda.fekete@getunleash.io>
2025-06-23 14:12:34 +02:00
Melinda Fekete
148e6e0da8
docs: update UI docs and screenshots for v6.10 (#9902) 2025-05-12 14:21:12 +02:00
Melinda Fekete
c393a869a7
docs: update docs preview image (#9852) 2025-04-29 09:16:54 +02:00
Melinda Fekete
acc478597a
docs: scaling Unleash use case tutorial (#9784) 2025-04-24 16:13:35 +02:00
Melinda Fekete
81c1fb9143
Update Quickstart for Enterprise getting started (#9823) 2025-04-24 15:52:04 +02:00
Melinda Fekete
aabb364415
docs: Update hosting strategies page (#9729) 2025-04-16 12:42:39 +02:00
Melinda Fekete
09c3f1ab40
docs: updates to 11 principles and scaling pages (#9688) 2025-04-09 14:35:43 +02:00
Melinda Fekete
5ed3041b11
docs: updates to Unleash Frontend API docs and Unleash architecture overview (#9513) 2025-04-07 12:38:00 +02:00
Mateusz Kwasniewski
605ab54ae2
docs: environment change requests (#9648) 2025-04-03 12:25:23 +02:00
Melinda Fekete
2d3d6aa38a
Docs for release management (#9555) 2025-03-28 10:42:39 +01:00
Nnenna Ndukwe
bedd5e1c5b
docs: Feature Flag Security and Compliance for Enterprises (#9528)
<!-- 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. -->

[Preview
Link](https://unleash-docs-git-use-case-security-v2-unleash-team.vercel.app/feature-flag-tutorials/use-cases/security-and-compliance)

Created a use case on Feature Flag Security & Compliance for
Enterprises.
![Screenshot 2025-03-12 at 1 46
20 PM](https://github.com/user-attachments/assets/df4a03c5-b9bc-4456-becd-35587990a13f)


WIP in this PR:
- [x] Transferring diagrams from [Google
Doc](https://docs.google.com/document/d/1uA5Xb2NOdJjqwleicS_u088YXLCm81Y6norJzEYlwuE/edit?tab=t.0)
to this document
- [x] Add in remaining images/screenshots used as seen in Google Docs

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

So far, we will consider Unleash Edge for data privacy topic for a quick
2nd iteration or altogether separate piece.

---------

Co-authored-by: Melinda Fekete <melinda.fekete@getunleash.io>
Co-authored-by: Gastón Fournier <gaston@getunleash.io>
2025-03-14 09:31:19 -04:00
Melinda Fekete
7b62e5978b
Update network view docs with Connected Edges (#9436) 2025-03-05 19:33:31 +01:00
Melinda Fekete
de03de152b
Fix image zoom bug, remove Figure component (#9242) 2025-02-06 16:52:04 +01:00
Melinda Fekete
ef8191c68d
Update API tokens and client keys pages (#9143) 2025-02-04 09:32:32 +01:00
Nuno Góis
b62c1d6c1e
docs: new theme footer (#9158)
https://linear.app/unleash/issue/2-3177/footer

New docs theme footer.

Kept [swizzling](https://docusaurus.io/docs/swizzling) to a minimum and
instead tried to keep most things in CSS to avoid adding more
complexity.

Remember to test responsiveness by resizing your window, as well as dark
mode.

[Preview
link](https://unleash-docs-git-docs-new-theme-footer-unleash-team.vercel.app/)
2025-01-28 16:22:24 +00:00
Melinda Fekete
0ebe791a75
docs: new landing page (#9087)
New landing page design for the docs with custom card components.

[Design
file](https://www.figma.com/design/7BXV5qZrmrI4H1Yk8FVW9T/Marketing?node-id=5330-8333&t=eKa3NYwKpzane9ey-0)
[Docs
Preview](https://unleash-docs-git-alvin-new-docs-homepage-unleash-team.vercel.app/)

---------

Co-authored-by: Alvin Bryan <hello@alvin.codes>
Co-authored-by: Nuno Góis <github@nunogois.com>
2025-01-23 13:05:41 +00:00
Alvin Bryan
91550ca981
docs: new theme (#8994)
New theming for the docs.

- [Design
file](https://www.figma.com/design/7BXV5qZrmrI4H1Yk8FVW9T/Marketing?node-id=5330-8333&t=eKa3NYwKpzane9ey-0)
- [Preview Link
](https://unleash-docs-git-alvin-new-docs-theme-unleash-team.vercel.app/)

---------

Co-authored-by: Nuno Góis <github@nunogois.com>
2025-01-22 12:07:43 +00:00
Melinda Fekete
f268e1fba7
Update docs and screenshots for lifecycle (#9120)
Updates feature lifecycle docs with new names and an updated screenshot.
2025-01-21 09:33:26 +01:00
Nnenna Ndukwe
65aeb904c3
docs: Enterprise Use Case Tutorial - User Management, Access Controls, and Auditing with Feature Flags (#8998)
<!-- 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're adding a new enterprise use case tutorial on user management,
access controls, and auditing with feature flags.

All updates in this PR are changes made post-review of the [Google
Doc](https://docs.google.com/document/d/1-snBfKxoCK-5ClchkIQVFK2YcIjWZjkbl5ENAB_S6zM/edit?tab=t.0).

![Screenshot 2024-12-18 at 12 22
10 PM](https://github.com/user-attachments/assets/bf57c005-0b40-421c-ad4f-4a1ec156cd81)

<!-- 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: Michael Ferranti <michael.ferranti+unleash@getunleash.io>
2025-01-14 11:38:53 -05:00
Melinda Fekete
c8300fed00
Simplify Unleash docs updates (#8925) 2024-12-17 14:36:16 +01:00
Alvin Bryan
3afcf690de
Go tutorial 🐿️ (#8904)
And examples 😄

---------

Co-authored-by: melindafekete <melinda.fekete@getunleash.io>
Co-authored-by: Nnenna Ndukwe <nnenna.s.ndukwe@gmail.com>
2024-12-13 20:39:44 +00:00
Melinda Fekete
311df82d37
Strategy docs updates (#8711)
- New navigation for Unleash Concepts
- Updated and restructured activation strategies and related concepts
2024-12-11 10:38:39 +01:00
Nnenna Ndukwe
aa7954cc18
docs: Trunk-based development use case tutorial (#8867)
<!-- 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

**[Trunk-based development
preview](https://unleash-docs-git-use-case-tbd-unleash-team.vercel.app/feature-flag-tutorials/use-cases/trunk-based-development)**

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

Gearing up to publish the Trunk-Based Development use case tutorial.
<img width="1222" alt="Screenshot 2024-11-27 at 6 56 48 AM"
src="https://github.com/user-attachments/assets/8bb4a281-8428-4874-95ba-2dc114885c9d">


<!-- 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: Melinda Fekete <melinda.fekete@getunleash.io>
2024-12-03 09:25:27 -05:00
Melinda Fekete
ce271a635a
11 principles page improvements (#8704) 2024-11-12 13:44:45 +01:00
Nnenna Ndukwe
b52dcb3082
docs: a/b testing doc V2 (#8501)
<!-- 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
Update A/B testing use cases tutorial. [Preview
link](https://unleash-docs-git-use-case-ab-testing-v2-unleash-team.vercel.app/feature-flag-tutorials/use-cases/a-b-testing)

<!-- 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: Michael Ferranti <michael.ferranti+unleash@getunleash.io>
Co-authored-by: Melinda Fekete <melinda.fekete@getunleash.io>
2024-11-07 16:04:38 -05:00
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
3076bb4c21
Update quickstart guide (#8523) 2024-10-25 11:12:05 +02:00
Melinda Fekete
8b0af59897
Update and restructure environments (#8496) 2024-10-22 17:55:11 +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
43a564753e
Add background to gradual rollout building blocks image (#8370) 2024-10-04 17:07:16 +02:00
Melinda Fekete
7d38048ee8
Update Entra ID SAML SSO docs (#8151) 2024-09-20 17:37:10 +02: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
Melinda Fekete
7051fabecd
Consolide 'What is a feature flag' docs (#8050) 2024-09-09 10:35:56 +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
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
Michael Ferranti
1dbc20fe91
Initial commit for What is a feature flag educational page (#7629) 2024-07-22 17:43:35 +02: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
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
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
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
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
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
Alvin Bryan
7730167ea4
.NET tutorial (#7036)
Thank you so much to @daveleek for the help 🙏
2024-05-14 12:40:19 +01:00