1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-25 00:07:47 +01:00
Commit Graph

916 Commits

Author SHA1 Message Date
Nnenna Ndukwe
242092d6ca
docs: add previously resolved suggestions to commit (#9142)
<!-- 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. -->

Previously was resolved in an old PR, but never added to the commit
batch. Resolving this now with these changes.

<!-- 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>
2025-01-23 10:37:24 -05: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
Melinda Fekete
ebe716bd17
Project collaboration mode docs: fix header levels (#9135) 2025-01-22 17:21:49 +01: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
Mateusz Kwasniewski
e9db8ab8f0
feat: max parallel sessions config (#9109) 2025-01-20 11:51:50 +01:00
Dimitri Tyan
7757012b25
Fix link to SDK in impression-data.md (#9116)
## About the changes
Fix broken link in markdown file in impression-data documentation
2025-01-17 17:24:30 +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
Alvin Bryan
306f726991
JavaScript tutorial (#8989)
This is using the JavaScript browser SDK, not Node.js 😄

PS: Corgis 🐶

PPS: [Preview
Link](https://unleash-docs-git-alvin-js-tutorial-unleash-team.vercel.app/feature-flag-tutorials/javascript)
2025-01-02 16:35:44 +01:00
Gastón Fournier
cac47fc8f2
docs: swapi.dev no longer exists (#8997)
Closes #8939
2024-12-18 17:55:09 +01: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
b211c9c33f
ISO27K compliance doc (#8973) 2024-12-13 13:04:42 +01:00
Michael Ferranti
c3f50263c8
Update fedramp and soc2 docs to point to Unleash Enterprise (#8957) 2024-12-11 14:35:55 +01: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
Melinda Fekete
d29f0c80d5
Add SOC2 docs (#8916) 2024-12-05 12:58:41 +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
Nuno Góis
b0334cd902
docs: update React Native / Expo community SDK entry (#8902)
Updates our React Native / Expo community SDK entry from the deprecated
**[@nunogois/proxy-client-react-native](https://github.com/nunogois/proxy-client-react-native)**
to the new
**[@nunogois/unleash-react-native](https://github.com/nunogois/unleash-react-native)**.
2024-12-02 18:34:36 +00:00
David Leek
08eea8efd0
docs: enviroment->environment (#8893) 2024-11-29 13:25:39 +01:00
Melinda Fekete
c83199db89
Remove admonitions from Proxy docs (#8860) 2024-11-28 14:08:09 +01:00
weekwith.me
d75c63b6e8
feat: Add PROJECT_ARCHIVED event to send message to Slack (#8848)
<!-- 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. -->

### Summary

- Add `PROJECT_ARCHIVED` event on `EVENT_MAP` to use
- Add a test case for `PROJECT_ARCHIVED` event formatting 
- Add `PROJECT_ARCHIVED` event when users choose which events they send
to Slack
- Fix Slack integration document by adding `PROJECT_ARCHIVED`

### Example

The example message looks like the image below. I covered my email with
a black rectangle to protect my privacy 😄
The link refers `/projects-archive` to see archived projects.

<img width="529" alt="Slack message example"
src="https://github.com/user-attachments/assets/938c639f-f04a-49af-9b4a-4632cdea9ca7">

## Discussion points
<!-- Anything about the PR you'd like to discuss before it gets merged?
Got any questions or doubts? -->

I considered the reason why Unleash didn't implement to send
`PROJECT_ARCHIVED` message to Slack integration.

One thing I assumed that it is impossible to create a new project with
open source codes, which means it is only enabled in the enterprise
plan. However,
[document](https://docs.getunleash.io/reference/integrations/slack-app#events)
explains that users can send `PROJECT_CREATED` and `PROJECT_DELETED`
events to Slack, which are also available only in the enterprise plan,
hence it means we need to embrace all worthwhile events.

I think it is reasonable to add `PROJECT_ARCHIVED` event to Slack
integration because users, especially operators, need to track them
through Slack by separating steps, `_CREATED`, `_ARCHIVED`, and
`_DELETED`.
2024-11-25 14:33:50 +00:00
Melinda Fekete
0e7b675ede
FedRAMP docs (#8815) 2024-11-22 10:44:19 +01:00
Melinda Fekete
ce271a635a
11 principles page improvements (#8704) 2024-11-12 13:44:45 +01:00
Melinda Fekete
5f3c83fbbd
Move value to be a property of payload, not variant (#8697) 2024-11-11 15:24:10 +01:00
Melinda Fekete
7597bb91ac
Add lastmod to sitemap (#8681) 2024-11-08 10:52:47 +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
Melinda Fekete
618cd09eac
Terraform provider docs (#8598) 2024-11-07 17:56:16 +01:00
Melinda Fekete
a9195e25c5
Remove referential link from the Flutter community tutorial (#8682) 2024-11-07 16:51:06 +01:00
Melinda Fekete
f016a3e34d
Introduce availability page in the docs (#8644) 2024-11-06 12:43:03 +01:00
weekwith.me
ef8417a08d
feat: Make disableMigration option handled by environment variable (#8634)
In some cases, people want to disable database migration. For example,
some people or companies want to grant whole permissions to handle the
schema by DBAs, not by application level hence I use
`parseEnvVarBoolean` to handle `disableMigration` option by environment
variable. I set the default value as `false` for the backward
compatibility.
2024-11-05 13:13:49 +01:00
Melinda Fekete
08d0e45de5
Update quickstart to not mention Pro instance (#8576) 2024-11-04 11:31:55 +01: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
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
Alvin Bryan
1c29f70edc
AI Tutorial (#8297)
How to use feature flags to control AI models

**[Preview
link](https://unleash-docs-git-alvin-ai-tutorial-unleash-team.vercel.app/feature-flag-tutorials/use-cases/ai)**

---------

Co-authored-by: Melinda Fekete <melinda.fekete@getunleash.io>
Co-authored-by: Nuno Góis <github@nunogois.com>
2024-10-18 13:57:24 +01: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
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