1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-28 19:06:12 +01:00
Commit Graph

806 Commits

Author SHA1 Message Date
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
Nnenna Ndukwe
eb199825e8
docs: Add spring boot video to tutorial (#7098)
<!-- 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. -->

Added Spring Boot YouTube Tutorial video to documentation!

<img width="884" alt="Screenshot 2024-05-21 at 10 00 46 AM"
src="https://github.com/Unleash/unleash/assets/22972707/77d4e9c9-df03-42c0-b92f-2d077eb54379">


<!-- 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-22 09:15:07 -04:00
Mateusz Kwasniewski
88e3b1b79e
feat: deprecate feature toggle variants at environment level (#7058) 2024-05-16 10:57:32 +02:00
Fredrik Strand Oseberg
85d3ccbd79
chore: update documentation for feature toggle variants (#7064)
Add documentation of feature flag variant types

Closes #7056
2024-05-16 10:41:50 +02:00
Nnenna Ndukwe
acb663df7a
Docs: Add Java YouTube Tutorial Video (#7059)
<!-- 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? -->
Adding our YouTube link: https://www.youtube.com/watch?v=Hq1g9QyPw14

<img width="731" alt="Screenshot 2024-05-15 at 7 46 12 AM"
src="https://github.com/Unleash/unleash/assets/22972707/32c0e9e5-931d-40ad-9f23-a110d2ae3fb8">
2024-05-15 10:03:38 -04:00
Nnenna Ndukwe
e9c4b471c7
doc: Optimizing AWS Lambda Documentation (#6991)
<!-- 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? -->

Updates according to our revision doc for our horizontal content pieces.
2024-05-15 07:44:05 -04:00
Mateusz Kwasniewski
701c845f09
feat: uncomplete tracking (#7053) 2024-05-14 15:04:31 +02:00
Alvin Bryan
7730167ea4
.NET tutorial (#7036)
Thank you so much to @daveleek for the help 🙏
2024-05-14 12:40:19 +01:00
Alvin Bryan
5b8c63f748
Docs fixes (#7050)
- Fixed a typo
- Updated the docs to remove a mention of v4
- Removed old v3 page
2024-05-14 10:05:27 +01:00
Mateusz Kwasniewski
21961207ca
docs: feature lifecycle (#7034) 2024-05-13 11:51:21 +02:00
Nnenna Ndukwe
0c284ca143
docs: Add Python YouTube Video tutorial (#7033)
<!-- 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? -->

Adding the Python video tutorial to our docs for following along
<img width="887" alt="Screenshot 2024-05-10 at 7 06 21 AM"
src="https://github.com/Unleash/unleash/assets/22972707/69cdc8a3-b52f-49f7-857d-f907ada2744c">

https://youtu.be/-Rf0y2Gq8OA?si=udl3eIE9DdxQYGAY
2024-05-10 08:36:12 -04:00
Jaanus Sellin
5c61667282
feat: add completed event as webhook event (#6968)
Now feature completed event can be used with webhook.
2024-05-02 14:48:33 +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
Alvin Bryan
d1cad6ece3
Example Docs fixes (#6919)
Hello, 

As discussed with @sighphyre, there were a number of problems with the
examples docs. This addresses the most pressing ones, namely:

- Corrected the link to the Jira plugin
- Added deprecation warning to Jira Server pages
- Removed the incomplete markdown table at the end of articles, and the
references to it

---------

Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
2024-04-26 17:22:16 +01:00
Thomas Heartman
e7fe31ec6a
docs: document the new demoAllowAdminLogin option (#6902)
This PR adds docs for the new `demoAllowAdminLogin` option, including
how to use it and what it does.

Documents the changes introduced in https://github.com/Unleash/unleash/pull/6808
2024-04-23 09:08:07 +02:00
Christopher Kolstad
ff6297d338
feat: Make Database SSL Configurable through files (#6892)
This makes it configurable either through a single JSON file with all
three certificates as separate keys or via separate files per
ca/cert/key key.

fixes #6718
2024-04-19 14:38:33 +02:00
Nnenna Ndukwe
eec5469f43
docs: Spring Boot Examples (#6884)
Spring Boot examples docs v1
2024-04-17 14:01:18 -04:00
Alvin Bryan
43cee41078
docs: added Ruby examples (#6865)
I tried to make the language more user-friendly too
2024-04-17 08:21:12 -04:00
David Leek
20a9fdd33e
chore(docs): improve documentation with note about initial version and not needing flag (#6848)
## About the changes

Adds a note about new installations starting with version where most
events and features should have a created_by userid set and thus not
need this configuration option/corresponding scheduled data migration
task
2024-04-12 18:34:10 +01:00
Alvin Bryan
8c6feb7925
Docs: Fixed missing values in webhooks (#6833)
Fixed missing values in the webhook docs, the list of values is from
[the type
definitions](d3eac6caf8/src/lib/addons/webhook-definition.ts (L100-L129))

Credit goes to @gastonfournier for finding these 🙏
2024-04-12 18:32:01 +01:00
Thomas Heartman
c773145cf6
docs: indicate that scheduled config changes are GA (#6843)
Scheduled config changes aren't in dev anymore; they went GA in 5.10.
This PR updates the docs to reflect that.
2024-04-12 09:20:18 +02:00
David Leek
02b3805ca6
Feat/configure scheduled created by migration (#6821)
## About the changes

- Removes the feature flag for the created_by migrations.
- Adds a configuration option in IServerOption for
`ENABLE_SCHEDULED_CREATED_BY_MIGRATION` that defaults to `false`
- the new configuration option when set on startup enables scheduling of
the two created_by migration services (features+events)
- Removes the dependency on flag provider in EventStore as it's no
longer needed
- Adds a brief description of the new configuration option in
`configuring-unleash.md`
- Sets the events created_by migration interval to 15 minutes, up from
2.

---------

Co-authored-by: Gastón Fournier <gaston@getunleash.io>
2024-04-10 14:12:58 +02:00
Alvin Bryan
6d4060d8d2
docs: Ruby tutorial (#6753)
A "getting started" for the Ruby SDK.

I used the Stars Wars API, in typical tutorial style.

---------

Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
2024-04-04 10:33:39 +01:00
Mateusz Kwasniewski
fe6aaf7739
docs: variant dependencies (#6758) 2024-04-03 10:31:58 +02:00
Michael Ferranti
317a204070
fixed typo (#6694)
found a small typo and fixed it.
2024-04-02 10:44:23 +01:00
Alvin Bryan
8a9d013545
Fixed syntax highlighting in the docs (#6678)
Adds support for Svelte syntax highlighting and lets us add support for
additional languages in the future
2024-03-25 09:10:41 +00:00
Gastón Fournier
5db197839c
docs: signals and actions documentation (#6641)
## About the changes
This is the initial documentation for actions and signals.

Preview the changes:
https://unleash-docs-git-signals-docs-unleash-team.vercel.app/

- Actions:
https://unleash-docs-git-signals-docs-unleash-team.vercel.app/reference/actions
- Signals:
https://unleash-docs-git-signals-docs-unleash-team.vercel.app/reference/signals

---------

Co-authored-by: Alvin Bryan <107407814+alvinometric@users.noreply.github.com>
Co-authored-by: Nuno Góis <github@nunogois.com>
2024-03-21 19:40:09 +00:00
Nnenna Ndukwe
b7232d0397
docs: Spring Boot Tutorial v1 (#6620)
<!-- 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 have a v1 for a Java Spring Boot Tutorial:
- uses popular Java Spring Boot open source project Spring Pet Clinic
- uses Unleash Spring Boot SDK
- this is simple & introductory as we don't have data plugged into the
new page we build in the application.

<img width="899" alt="spring-boot-tutorial-app-in-browser"
src="https://github.com/Unleash/unleash/assets/22972707/c620f49c-d487-44ac-af7d-ce32bc3c85d8">


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

I added the tutorial to the Java section in the docs navigation menu. I
could have it stand alone, but I would consider it to be underneath the
Java language we have already listed in our menu.

<img width="301" alt="Screenshot 2024-03-19 at 8 49 11 PM"
src="https://github.com/Unleash/unleash/assets/22972707/404ff27b-0363-446a-9036-1b99e4ee5f80">
2024-03-20 10:25:29 -04:00
Alvin Bryan
efb2df78c2
Fixed missing video in the Sveltekit tutorial (#6631)
The mp4 was missing in the Sveltekit tutorial, this fixes it
2024-03-20 13:52:05 +00:00
Alvin Bryan
646a8f0192
Made sure the slugs are consistent in the tutorials (#6604)
Some of the slugs for the tutorials were handled in the config file with
the other redirects, some were handled locally in the markdown file.
This moves all the tutorial slugs to the markdown file, and fixes the
slug of the SvelteKit tutorial so it's the same as the others.

---------

Co-authored-by: Nnenna Ndukwe <nnenna.s.ndukwe@gmail.com>
2024-03-19 19:20:26 -04:00
Alvin Bryan
3539f3db02
Sveltekit tutorial (#6538)
Simple Sveltekit tutorial

---------

Co-authored-by: Nnenna Ndukwe <nnenna.s.ndukwe@gmail.com>
2024-03-18 15:54:55 +00:00
Jaanus Sellin
f0240eb90e
feat: docs for sdk reporting (#6580)
![image](https://github.com/Unleash/unleash/assets/964450/43fc0d50-6016-4140-9f22-7d56169c375b)

![image](https://github.com/Unleash/unleash/assets/964450/fc9a574e-995c-4278-ba2e-c6d5e0b1088e)
2024-03-15 11:02:59 +02:00
Mateusz Kwasniewski
dc1d5ce4f2
chore: update outdated sdks list (#6556) 2024-03-14 15:30:23 +01:00
Thomas Heartman
56c3dc438f
docs: add notes about how Unleash deals with string context values and conversion (#6551)
This change addresses the question in #6542 about using non-string
operators on string values by clarifying that Unleash SDK converts the
string values before performing the comparison.
2024-03-14 13:27:36 +02:00
Mateusz Kwasniewski
1aca59747e
docs: frontend API design (#6521) 2024-03-13 12:39:58 +01:00
Sebastian Bury
34729e8205
add custom root roles to docs on private projects (#5829)
<!-- 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: Thomas Heartman <thomas@getunleash.io>
2024-03-12 16:42:41 +01:00
Mateusz Kwasniewski
74df643ce0
docs: ADR for 3 types of models (#6436) 2024-03-12 13:35:35 +01:00
Thomas Heartman
62a7633ed5
docs: add note about upgrading to version 5.7 and above (#6464)
Upgrading to 5.7 and above from earlier versions is a little
problematic. Let's document it.

---------

Co-authored-by: Gastón Fournier <gaston@getunleash.io>
2024-03-11 08:13:57 +00:00