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

20 Commits

Author SHA1 Message Date
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
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
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
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
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
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
Ivar Conradi Østhus
4a81f0932f
fix: Allow AuthType None to use valid API tokens (#6247)
Fixes ##5799 and #5785

When you do not provide a token we should resolve to the "default"
environment to maintain backward compatibility. If you actually provide
a token we should prefer that and even block the request if it is not
valid.

An interesting fact is that "default" environment is not available on a
fresh installation of Unleash. This means that you need to provide a
token to actually get access to toggle configurations.


---------

Co-authored-by: Thomas Heartman <thomas@getunleash.io>
2024-02-16 08:24:56 +00:00
Mateusz Kwasniewski
2c5cd13160
docs: troubleshooting unleash over https (#6250) 2024-02-15 15:49:21 +01:00
Mark Fulton
29d27b73ad
docs: Update license-keys.mdx (#6012)
Added statement to contact customer success for help
2024-02-13 14:01:45 +01:00
Mateusz Kwasniewski
aea4fc9dc9
docs: troubleshooting returning disabeled flags (#6200) 2024-02-12 11:36:51 +01:00
Nuno Góis
5d4c75091d
docs: unexpected results in abn test troubleshooting guide (#6153)
https://linear.app/unleash/issue/SR-374/troubleshooting-guide-my-feature-flag-is-returning-unexpected-results

Adds a quick troubleshooting guide that covers some common pitfalls when
running A/B tests.
2024-02-08 17:04:25 +00:00
Christopher Kolstad
c83c43718c
docs: Add troubleshooting note about missing Edge metrics (#6103)
So we have a place in the docs to refer users struggling with getting
metrics from Edge after upgrade to Unleash v5.9.0, this PR adds a small
troubleshooting note about two fixes.
1. Upgrade Edge
2. Use environmental flag to re-enable old endpoint
2024-02-05 11:34:24 +01:00
Maximilian Edison
e087f4226f
Docs: Getting Started Self-Hosting unleash (#6019)
## About the changes

put UNLEASH_DEFAULT_ADMIN_PASSWORD inside ``
2024-01-24 13:06:01 +04:00
Mark Fulton
e9d49d68fd
Docs/license keys (#5959)
New docs page for the beta license keys feature introduced in Unleash
5.8 for self-hosted enterprise users.

---------

Co-authored-by: Ivar Conradi Østhus <ivar@getunleash.io>
2024-01-23 12:17:10 -05:00
Thomas Heartman
cb5ed951eb
docs: describe frontend API tokens (#5784)
This change adds a mention of frontend API tokens to the docs. We've
had this functionality for a while, but it appears not to have been
documented.

Realized this as part of triaging #3005.
2024-01-09 19:09:02 +01:00
Pedro Papadopolis
24c2a70138
feat: Make compression middleware optional (#5306)
## Why
Currently AWS API Gateway doesn't have compression enabled by default,
this PR will make it easier to for example deploy Unleash over to AWS
Lambda without further configuration in API Gateway, frameworks like
Serverless requires a bit more work to set up compression and some times
one might not need compression at all.

## How
Create a new config flag called `disableCompression` which will not
include `compression` middleware in express' instance when set as true.
2023-12-16 08:06:26 +01:00
Christopher Kolstad
24d111c4c5
docs: Update recommended postgres to 14 (#5240)
We've been caught out here, we added a migration that used PG>=11
syntax, but our docs still state that we support v10, when it reached
EoL Nov 2022. This updates our docs to state v14 and newer, v14 came out
in 2021 and as such won't be EoL until 2026 according to [Postgres 5
year versioning scheme
support](https://www.postgresql.org/support/versioning/)
2023-11-25 09:27:11 +01:00
Nuno Góis
a001fc1b57
docs: troubleshooting email service (#5333)
https://linear.app/unleash/issue/SR-173/discussion-question-notification-from-email-doesnt-work

Adds a troubleshooting guide for [email
service](https://docs.getunleash.io/using-unleash/deploy/email-service),
which includes some knowledge shared in this discussion:
https://github.com/orgs/Unleash/discussions/5323#discussioncomment-7554431
2023-11-14 12:53:34 +00:00
Drew Gorton
b2b19e4970
Navigation refactor (#5227)
## About the changes
Refactor the main nav, with the following goals: 
* Communicate the value of each section vs the format (ex:
“Understanding Unleash” vs “Topic Guides”)
* Make space for the Feature Flag tutorials section that we’re starting
to build
* Scope updates to navigation and pages that need updates based on new
URLs & organization
* Update URLs to follow the new hierarchy without breaking links (adding
redirects & editing internal links between pages as needed)

### Important files
sidebar.js
docusaurus.config.js

## Discussion points
* Redirects can't be tested out of prod, which is a bummer :/
* Some URLs have been preserved untouched while we monitor for potential
negative SEO impact of client-side redirects
* It's a large PR (sorry). Nav changes and file movements impacted lots
of files.

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-10-31 09:38:03 -05:00