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

1242 Commits

Author SHA1 Message Date
Thomas Heartman
9646cfe4e6
docs: hide the quickstart and doc nav bar links when you're on the docs pages (#6126)
This change hides the quickstart and doc nav bar links when you're on
the docs pages.

This gets around the issue of both of those links being
highlighted when you're on the docs pages.

This should work on 91.66% of browsers (according to [canIUse's data for
the `:has` selector](https://caniuse.com/?search=%3Ahas)). For older
browsers, the links will still be visible.
2024-02-06 11:51:40 +09: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
renovate[bot]
b6665e9d04
chore(deps): update dependency @babel/core to v7.23.9 (#6105)
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [@babel/core](https://babel.dev/docs/en/next/babel-core)
([source](https://togithub.com/babel/babel/tree/HEAD/packages/babel-core))
| [`7.23.7` ->
`7.23.9`](https://renovatebot.com/diffs/npm/@babel%2fcore/7.23.7/7.23.9)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/@babel%2fcore/7.23.9?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@babel%2fcore/7.23.9?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@babel%2fcore/7.23.7/7.23.9?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@babel%2fcore/7.23.7/7.23.9?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>babel/babel (@&#8203;babel/core)</summary>

###
[`v7.23.9`](https://togithub.com/babel/babel/blob/HEAD/CHANGELOG.md#v7239-2024-01-25)

[Compare
Source](https://togithub.com/babel/babel/compare/v7.23.7...v7.23.9)

##### 🐛 Bug Fix

- `babel-helper-transform-fixture-test-runner`,
`babel-plugin-transform-function-name`,
`babel-plugin-transform-modules-systemjs`, `babel-preset-env`
- [#&#8203;16225](https://togithub.com/babel/babel/pull/16225) fix:
`systemjs` re-traverses helpers
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
- `babel-helper-create-class-features-plugin`,
`babel-plugin-proposal-decorators`
- [#&#8203;16226](https://togithub.com/babel/babel/pull/16226) Improve
decorated private method check
([@&#8203;JLHwung](https://togithub.com/JLHwung))
- `babel-plugin-proposal-decorators`,
`babel-plugin-transform-async-generator-functions`,
`babel-plugin-transform-runtime`, `babel-preset-env`
- [#&#8203;16224](https://togithub.com/babel/babel/pull/16224) Properly
sort `core-js@3` imports
([@&#8203;nicolo-ribaudo](https://togithub.com/nicolo-ribaudo))
-   `babel-traverse`
- [#&#8203;15383](https://togithub.com/babel/babel/pull/15383) fix:
Don't throw in `getTypeAnnotation` when using TS+inference
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
-   Other
- [#&#8203;16210](https://togithub.com/babel/babel/pull/16210) \[eslint]
Fix `no-use-before-define` for class ref in fields
([@&#8203;nicolo-ribaudo](https://togithub.com/nicolo-ribaudo))

##### 🏠 Internal

-   `babel-core`, `babel-parser`, `babel-template`
- [#&#8203;16222](https://togithub.com/babel/babel/pull/16222) Migrate
`eslint-parser` to cts
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
-   `babel-types`
- [#&#8203;16213](https://togithub.com/babel/babel/pull/16213) Remove
`@babel/types` props that are not produced by the parser
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))

##### 🏃‍♀️ Performance

-   `babel-parser`
- [#&#8203;16072](https://togithub.com/babel/babel/pull/16072) perf:
Improve parser performance for typescript
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))

##### 🔬 Output optimization

- `babel-helper-create-class-features-plugin`,
`babel-plugin-proposal-decorators`,
`babel-plugin-proposal-destructuring-private`,
`babel-plugin-proposal-pipeline-operator`,
`babel-plugin-transform-class-properties`,
`babel-plugin-transform-class-static-block`,
`babel-plugin-transform-new-target`,
`babel-plugin-transform-parameters`,
`babel-plugin-transform-private-methods`, `babel-preset-env`
- [#&#8203;16218](https://togithub.com/babel/babel/pull/16218) Improve
temporary variables for decorators
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
- `babel-helpers`, `babel-plugin-proposal-explicit-resource-management`,
`babel-runtime-corejs2`, `babel-runtime-corejs3`, `babel-runtime`
- [#&#8203;15959](https://togithub.com/babel/babel/pull/15959) Improve
output of `using`
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 7pm every weekday,before 5am
every weekday" in timezone Europe/Madrid, Automerge - At any time (no
schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/Unleash/unleash).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xNTMuMiIsInVwZGF0ZWRJblZlciI6IjM3LjE1My4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-02-01 22:14:42 +00:00
Nnenna Ndukwe
f09d184eb2
docs: Python Examples page (#6094)
<!-- 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. -->

A new Python Examples doc:

- underneath Python tutorials
- explores more use cases for Python with feature flags in Unleash,
building on top of our existing Python tutorial.
- This was edited and reviewed by team members via [Google
Docs](https://docs.google.com/document/d/1gO5KSShCKObbdjP-TobIjaOLqTP5_V1YcTLXAp5DA2g/edit#heading=h.oblpm3ljyzs8)
before adding to our docs site.
- Python Tutorial links to this doc as a continuation

<img width="1502" alt="Screenshot 2024-01-31 at 11 44 28 AM"
src="https://github.com/Unleash/unleash/assets/22972707/86aec6a5-9483-41a8-bd65-ae0fcf7d7c7f">


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

`website/docs/feature-flag-tutorials/python/examples.md`

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

---------

Co-authored-by: Nuno Góis <github@nunogois.com>
2024-02-01 17:08:49 -05:00
Thomas Heartman
dbc577bfa4
docs(refactor): clean up academy css (#6097)
This PR cleans up the the CSS for the recent academy banners, sharing
styles where it seemed suitable.

Main points:
- share styling of the level badge between the links and the course
banner
- share styling of general banner shape, borders, spacing, between the
main unleash academy banner and the course-specific banner

Also does the following updates:
- change the button colors
- update the link in the main academy banner
2024-02-01 18:35:43 +09:00
Thomas Heartman
58836d3ab2
docs: show links to other sidebars when the navbar is collapsed (#6096)
This change adds links to Unleash Academy from the docs sidebar and
vice versa when the nav bar is collapsed (on narrow screens).
2024-02-01 15:10:30 +09:00
Nnenna Ndukwe
542acd30a9
docs: simplify Python tutorial (#6073)
<!-- 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. -->

- Reducing the amount of steps to implement the Python app feature flag
- fixed spaces & indentations in Python code snippets (mentioned in past
PR review)
- `git clone` my forked repo so we can customize that code in the future
as we improve it, without being blocked.


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

More improvements to be made to the HTTP calls in `routes.py` as I
continue working on resolving some issues I'm running into in the app.

---------

Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
2024-01-31 08:34:46 -05:00
Jaanus Sellin
884bc86745
chore: add documentation to search filters/operators (#6088)
![image](https://github.com/Unleash/unleash/assets/964450/d8920542-78b6-48e1-96a9-6d8d60082849)

![image](https://github.com/Unleash/unleash/assets/964450/406d7f21-01e2-4b75-9b1e-b48f319669dd)
2024-01-31 13:28:15 +02:00
Thomas Heartman
67f8a3cccd
docs: change "time burden" to "time investment" (#6079)
This PR changes the wording for the courses from "estimated time burden"
to "estimated time".
2024-01-31 10:48:28 +00:00
Jaanus Sellin
4635c4882f
chore: revert docusaurus-plugin-openapi-docs (#6091)
Reverting https://github.com/Unleash/unleash/pull/5819, because it is
breaking docs
2024-01-31 10:42:18 +00:00
Thomas Heartman
bc95ed654f
docs: add academy links and banners (#6083)
This PR adds academy links and banners. Supersedes #6077
2024-01-31 18:18:21 +09:00
Thomas Heartman
ccf165568a
docs: make navbar separators partially transparent (#6084)
Sets the opacity of the navbar separators to 0.3
2024-01-31 11:17:03 +02:00
renovate[bot]
0c95cd3f59
fix(deps): update dependency docusaurus-plugin-openapi-docs to v2.0.4 (#5819)
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[docusaurus-plugin-openapi-docs](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs)
([source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/tree/HEAD/packages/docusaurus-plugin-openapi-docs))
| [`2.0.0-beta.3` ->
`2.0.4`](https://renovatebot.com/diffs/npm/docusaurus-plugin-openapi-docs/2.0.0-beta.3/2.0.4)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/docusaurus-plugin-openapi-docs/2.0.4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/docusaurus-plugin-openapi-docs/2.0.4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/docusaurus-plugin-openapi-docs/2.0.0-beta.3/2.0.4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/docusaurus-plugin-openapi-docs/2.0.0-beta.3/2.0.4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>PaloAltoNetworks/docusaurus-openapi-docs
(docusaurus-plugin-openapi-docs)</summary>

###
[`v2.0.4`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#204-Jan-18-2024)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v2.0.3...v2.0.4)

High level enhancements

-   Add x-codeSamples support
-   Add callbacks support

Other enhancements and bug fixes

- Add support to x-codeSamples
([#&#8203;697](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/697))
- Remove deprecated node packages
([#&#8203;699](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/699))
- Add Callbacks support
([#&#8203;691](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/691))

###
[`v2.0.3`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#203-Jan-9-2024)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v2.0.2...v2.0.3)

High level enhancements

-   Add callbacks support
-   Add markdown support to example/examples summary

Other enhancements and bug fixes

- Add markdown support to example summary
([#&#8203;690](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/690))
- Add Callbacks support
([#&#8203;691](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/691))

###
[`v2.0.2`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#202-Dec-5-2023)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v2.0.1...v2.0.2)

High level enhancements

-   Adds security schemes to API Explorer panel

Other enhancements and bug fixes

- Add missing security schemes component
([#&#8203;673](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/673))

###
[`v2.0.1`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#201-Dec-1-2023)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v2.0.0...v2.0.1)

High level enhancements

-   Improve support for handling multi-part form data

Other enhancements and bug fixes

- Improve support for handling multipart form data
([#&#8203;666](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/666))
- use SCHEMA_TYPE to distinguish request/response to support
readOnly/writeOnly properties
([#&#8203;665](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/665))
- add negative look behind to exclude colon delimited path segments
([#&#8203;663](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/663))
-   Update deploy-preview.yml
-   update v2.0.0 refs to v3.0.0
-   Update pr-title-check.yaml
-   Update canary-beta-release.yml
-   Update README.md

###
[`v2.0.0`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#200-Nov-13-2023)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v2.0.0-beta.5...v2.0.0)

High level enhancements

-   First v2.0.0 stable release!

> Currently only compatible with Docusaurus v2.4.1 -> v2.4.3

Other enhancements and bug fixes

- upgrade to react 18 and demo docusaurus to 2.4.3
([#&#8203;656](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/656))
- allow upgrade to react 18
([#&#8203;651](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/651))
- stop docusaurus support at v2.4.0
([#&#8203;650](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/650))

###
[`v2.0.0-beta.5`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#200-beta5-Oct-23-2023)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v2.0.0-beta.4...v2.0.0-beta.5)

High level enhancements

-   Extend charset support for application/json
-   Improve webhook API page layout

Other enhancements and bug fixes

- Improve webhook layout
([#&#8203;646](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/646))
- update deprecation message
([#&#8203;644](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/644))
- allow charset support for application/json
([#&#8203;643](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/643))
- Reuse `createAnyOneOf` while creating a property
([#&#8203;628](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/628))
- Use `sass-loader` module as dependency
([#&#8203;639](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/639))
- Remove react nextui dependency in v2.0.0
([#&#8203;641](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/641))

###
[`v2.0.0-beta.4`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#200-beta4-Sep-29-2023)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v2.0.0-beta.3...v2.0.0-beta.4)

High level enhancements

- Expand capacity for building large sites by compressing frontmatter
api property.

Other enhancements and bug fixes

- Fix `makeRequest()` for `formdata` request type
([#&#8203;625](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/625))
- \[UI] Cleanup schema item and explorer panel caret alignment
([#&#8203;624](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/624))
-   revert v2.0.0 schema styles
- Add support for anyOf properties and apply DRY to createSchema
([#&#8203;582](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/582))
- Adds compression support to frontmatter api prop
([#&#8203;606](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/606))
- Unify tabs naming
([#&#8203;612](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/612))
- \[Enhancement] Introduce new theme component names: ApiExplorer,
CodeSnippets
([#&#8203;577](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/577))
- Use SchemaItem to render leaf discriminator properties/nodes
([#&#8203;573](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/573))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 7pm every weekday,before 5am
every weekday" in timezone Europe/Madrid, Automerge - At any time (no
schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/Unleash/unleash).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xMjcuMCIsInVwZGF0ZWRJblZlciI6IjM3LjEzNS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-01-31 09:10:36 +00:00
Thomas Heartman
b2c127c058
docs: fix navbar styling issues: GitHub icon, button background, hidden text (#6078)
This PR fixes the three issues in the nav bar:
1. The GitHub icon was rendered in black in light mode. It should be
white.
2. The toggle theme button's background was white in light mode. It
should be a darker green.
3. The navbar would intersect with the logo due to not compacting
correctly.

The first two issues were caused by using CSS nesting, which is
apparently not supported in Safari yet (and might only be supported if
you have enabled a flag in other browsers).

The last issue was fixed by changing the syntax of a media query. The
new syntax is unsupported in Safari.
2024-01-31 13:40:50 +09:00
Jaanus Sellin
febd01a575
chore: update database migration ADR (#6036)
## Key Updates in the ADR

- **Separation of Migrations in PRs**: Migrations are now required to be
carried out in separate pull requests. This change is intended to
improve the monitoring and management of database schema changes during
deployment.

- **Primary Key Requirement for New Tables**: A new paragraph mandates
the inclusion of primary keys in all new tables, emphasizing the
importance of data integrity, efficient data retrieval, and supporting
table relationships. Additionally, by adding primary keys, we resolve
the issue of migrations failing during upgrades in replicated database
setups, as we are not using PostgreSQL replica identities. Exceptions to
this rule require a compelling justification.


Also added better structuring and styling to ADR for better readability.
2024-01-30 11:07:32 +02:00
Thomas Heartman
6f4f8661c7
docs: update nav bar (#6045)
Update the Unleash docs navbar according to the new spec:

Changing "estimated time burden" to "estimated time" (or "estimated
reading time"), is just a matter of changing the text in the files.
There's nothing special making it say burden other than plain text. That
can be done in a follow-up PR.

The new nav bar includes the Unleash academy and certification dropdowns
as well as the docs and quickstart items. On smaller screen sizes
(between 997 and 1150 px), we hide the word "Unleash" from "Unleash
academy" and "Unleash certification".

The narrowest nav bar:

![image](https://github.com/Unleash/unleash/assets/17786332/13d05b0b-8668-4ff0-b06e-5c3073f0dda8)

When Unleash pops back in: 

![image](https://github.com/Unleash/unleash/assets/17786332/191ae3fe-5fca-4464-b79a-db6995e600c9)

---------

Co-authored-by: markunl <mark@getunleash.io>
2024-01-29 13:30:18 -05:00
Nnenna Ndukwe
1d5d7ee57d
fix: updating links across the React docs (#6054)
<!-- 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. -->

- Simplified wording
- More descriptive ALT text for images
- Included YouTube tutorial link
- Improve code indentation in some code blocks

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

YouTube link at the top of a tutorial or near the bottom?

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.io>
2024-01-29 12:33:41 -05:00
Nnenna Ndukwe
936fa44ec5
Shorter nav names for tutorials while maintaining SEO titles (#6028)
<!-- 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. -->

Let's update our tutorial titles in the left navigation menu so it's
shorter and simpler.
This will _not_ change the metadata and doc titles when you click on
them. Only the label in the nav.

BEFORE
![Screenshot 2024-01-24 at 9 52
17 AM](https://github.com/Unleash/unleash/assets/22972707/283b22c5-c317-4140-8478-67965d004ef1)

AFTER
![Screenshot 2024-01-24 at 9 47
37 AM](https://github.com/Unleash/unleash/assets/22972707/04c58f24-1e1f-4f83-b1ff-1eeba670a092)


<!-- 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-01-24 10:14:50 -05:00
Nnenna Ndukwe
1f7c7940b4
Feature Flags with Python Tutorial (#6016)
<!-- 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. -->

A new tutorial to get developers to implement feature flags into a
Python Flask app.
We have steps that guide them through the process using a simple
full-stack survey app.

Based off of a reviewed [Google Doc
here](https://docs.google.com/document/d/1YlG-TyQcMEyUrMjiWlYrd-J5DXog5ErbvSKAyuzKAnU/edit#heading=h.ryvmv14764i3)

The tutorial can go live in the docs nav in a new Python section, where
the Python examples will follow.


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


`website/docs/feature-flag-tutorials/python/implementing-feature-flags.md`


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

---------

Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
2024-01-24 08:00:33 -05: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
Ivar Conradi Østhus
3957abf0f6
docs: Minor typos (#6014)
Some minor typos in our docs.
2024-01-23 20:19:06 +01:00
Nicholas Haley
ab24264df9
docs: spelling and grammar (#6007)
<!-- 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. -->
This is a demo that uses [Floe](https://www.floe.dev/) to review the
`how-to` directory using the `spelling-and-grammar` rule.

You can read more about the tool here: https://www.floe.dev/docs
2024-01-23 19:52:10 +01: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
Christopher Kolstad
0515b424cd
docs: Added the new more fine-grained project permissions to the docs (#6000)
This adds documentation for the 8 new permissions added last week, in
preparation for including them in the 5.9.0 release.
Related
* https://github.com/Unleash/unleash/pull/5932
* https://github.com/Unleash/unleash/pull/5974
* https://github.com/ivarconr/unleash-enterprise/pull/1000

---------

Co-authored-by: Gastón Fournier <gaston@getunleash.io>
2024-01-23 14:13:03 +01:00
Simon Prickett
8458619d82
Small typo fix. (#5993)
## About the changes

Fixed a small typo "Learnings Paths" -> "Learning Paths".
2024-01-23 11:21:45 +04:00
Mark Fulton
b6a219dd36
docs/improve website README.md with local docs server installation step (#5956)
Minor addition to set correct local dir context in terminal when setting
up a local docs instance

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.io>
2024-01-22 09:44:31 -05:00
renovate[bot]
277e3e0afd
chore(deps): update react-router monorepo to v6.21.2 (#5961)
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [react-router](https://togithub.com/remix-run/react-router)
([source](https://togithub.com/remix-run/react-router/tree/HEAD/packages/react-router))
| [`6.21.1` ->
`6.21.2`](https://renovatebot.com/diffs/npm/react-router/6.21.1/6.21.2)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/react-router/6.21.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/react-router/6.21.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/react-router/6.21.1/6.21.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/react-router/6.21.1/6.21.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
| [react-router-dom](https://togithub.com/remix-run/react-router)
([source](https://togithub.com/remix-run/react-router/tree/HEAD/packages/react-router-dom))
| [`6.21.1` ->
`6.21.2`](https://renovatebot.com/diffs/npm/react-router-dom/6.21.1/6.21.2)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/react-router-dom/6.21.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/react-router-dom/6.21.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/react-router-dom/6.21.1/6.21.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/react-router-dom/6.21.1/6.21.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>remix-run/react-router (react-router)</summary>

###
[`v6.21.2`](https://togithub.com/remix-run/react-router/compare/react-router@6.21.1...react-router@6.21.2)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router@6.21.1...react-router@6.21.2)

</details>

<details>
<summary>remix-run/react-router (react-router-dom)</summary>

###
[`v6.21.2`](https://togithub.com/remix-run/react-router/compare/react-router-dom@6.21.1...react-router-dom@6.21.2)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router-dom@6.21.1...react-router-dom@6.21.2)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 7pm every weekday,before 5am
every weekday" in timezone Europe/Madrid, Automerge - At any time (no
schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these
updates again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/Unleash/unleash).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xMzUuMCIsInVwZGF0ZWRJblZlciI6IjM3LjEzNS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-01-18 21:18:26 +00:00
Nnenna Ndukwe
b64f8ad800
React examples doc with images and relative links (#5921)
<!-- 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. -->

This is a large PR with all of the React examples building on top of the
original tutorial.

Based off of this Google Doc:
https://docs.google.com/document/d/1m3ujgyrkJTCGLsEsBr1_eq4HQKqsf-lfvGFDJobns44/edit

I also included updates to the React tutorial links so they are relative
paths, not full URL paths.

I propose we make fast-follow updates to this piece of documentation for
changes we need to make in order to release and iterate on minor
updates.

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

website/docs/feature-flag-tutorials/react/examples.md

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.io>
2024-01-18 11:39:25 -05:00
Christopher Kolstad
043beca616
docs: add deprecation notice to Admin tokens (#5909)
We want to deprecate and eventually remove the option for admin tokens.
This PR updates the docs to inform readers about the deprecation as well
as recommending what they can use instead.
2024-01-18 09:58:40 +01:00
renovate[bot]
d1ea959486
chore(deps): update react-router monorepo to v6.21.1 (#5886)
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [react-router](https://togithub.com/remix-run/react-router)
([source](https://togithub.com/remix-run/react-router/tree/HEAD/packages/react-router))
| [`6.20.1` ->
`6.21.1`](https://renovatebot.com/diffs/npm/react-router/6.20.1/6.21.1)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/react-router/6.21.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/react-router/6.21.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/react-router/6.20.1/6.21.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/react-router/6.20.1/6.21.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
| [react-router-dom](https://togithub.com/remix-run/react-router)
([source](https://togithub.com/remix-run/react-router/tree/HEAD/packages/react-router-dom))
| [`6.20.1` ->
`6.21.1`](https://renovatebot.com/diffs/npm/react-router-dom/6.20.1/6.21.1)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/react-router-dom/6.21.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/react-router-dom/6.21.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/react-router-dom/6.20.1/6.21.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/react-router-dom/6.20.1/6.21.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>remix-run/react-router (react-router)</summary>

###
[`v6.21.1`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router/CHANGELOG.md#6211)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router@6.21.0...react-router@6.21.1)

##### Patch Changes

- Fix bug with `route.lazy` not working correctly on initial SPA load
when `v7_partialHydration` is specified
([#&#8203;11121](https://togithub.com/remix-run/react-router/pull/11121))
-   Updated dependencies:
    -   `@remix-run/router@1.14.1`

###
[`v6.21.0`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router/CHANGELOG.md#6210)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router@6.20.1...react-router@6.21.0)

##### Minor Changes

- Add a new `future.v7_relativeSplatPath` flag to implement a breaking
bug fix to relative routing when inside a splat route.
([#&#8203;11087](https://togithub.com/remix-run/react-router/pull/11087))

This fix was originally added in
[#&#8203;10983](https://togithub.com/remix-run/react-router/issues/10983)
and was later reverted in
[#&#8203;11078](https://togithub.com/remix-run/react-router/pull/11078)
because it was determined that a large number of existing applications
were relying on the buggy behavior (see
[#&#8203;11052](https://togithub.com/remix-run/react-router/issues/11052))

    **The Bug**
The buggy behavior is that without this flag, the default behavior when
resolving relative paths is to *ignore* any splat (`*`) portion of the
current route path.

    **The Background**
This decision was originally made thinking that it would make the
concept of nested different sections of your apps in `<Routes>` easier
if relative routing would *replace* the current splat:

    ```jsx
    <BrowserRouter>
      <Routes>
        <Route path="/" element={<Home />} />
        <Route path="dashboard/*" element={<Dashboard />} />
      </Routes>
    </BrowserRouter>
    ```

Any paths like `/dashboard`, `/dashboard/team`, `/dashboard/projects`
will match the `Dashboard` route. The dashboard component itself can
then render nested `<Routes>`:

    ```jsx
    function Dashboard() {
      return (
        <div>
          <h2>Dashboard</h2>
          <nav>
            <Link to="/">Dashboard Home</Link>
            <Link to="team">Team</Link>
            <Link to="projects">Projects</Link>
          </nav>

          <Routes>
            <Route path="/" element={<DashboardHome />} />
            <Route path="team" element={<DashboardTeam />} />
            <Route path="projects" element={<DashboardProjects />} />
          </Routes>
        </div>
      );
    }
    ```

Now, all links and route paths are relative to the router above them.
This makes code splitting and compartmentalizing your app really easy.
You could render the `Dashboard` as its own independent app, or embed it
into your large app without making any changes to it.

    **The Problem**

The problem is that this concept of ignoring part of a path breaks a lot
of other assumptions in React Router - namely that `"."` always means
the current location pathname for that route. When we ignore the splat
portion, we start getting invalid paths when using `"."`:

    ```jsx
// If we are on URL /dashboard/team, and we want to link to
/dashboard/team:
    function DashboardTeam() {
      //  This is broken and results in <a href="/dashboard">
      return <Link to=".">A broken link to the Current URL</Link>;

//  This is fixed but super unintuitive since we're already at
/dashboard/team!
      return <Link to="./team">A broken link to the Current URL</Link>;
    }
    ```

We've also introduced an issue that we can no longer move our
`DashboardTeam` component around our route hierarchy easily - since it
behaves differently if we're underneath a non-splat route, such as
`/dashboard/:widget`. Now, our `"."` links will, properly point to
ourself *inclusive of the dynamic param value* so behavior will break
from it's corresponding usage in a `/dashboard/*` route.

    Even worse, consider a nested splat route configuration:

    ```jsx
    <BrowserRouter>
      <Routes>
        <Route path="dashboard">
          <Route path="*" element={<Dashboard />} />
        </Route>
      </Routes>
    </BrowserRouter>
    ```

Now, a `<Link to=".">` and a `<Link to="..">` inside the `Dashboard`
component go to the same place! That is definitely not correct!

Another common issue arose in Data Routers (and Remix) where any
`<Form>` should post to it's own route `action` if you the user doesn't
specify a form action:

    ```jsx
    let router = createBrowserRouter({
      path: "/dashboard",
      children: [
        {
          path: "*",
          action: dashboardAction,
          Component() {
//  This form is broken! It throws a 405 error when it submits because
// it tries to submit to /dashboard (without the splat value) and the
parent
            // `/dashboard` route doesn't have an action
            return <Form method="post">...</Form>;
          },
        },
      ],
    });
    ```

This is just a compounded issue from the above because the default
location for a `Form` to submit to is itself (`"."`) - and if we ignore
the splat portion, that now resolves to the parent route.

    **The Solution**
If you are leveraging this behavior, it's recommended to enable the
future flag, move your splat to it's own route, and leverage `../` for
any links to "sibling" pages:

    ```jsx
    <BrowserRouter>
      <Routes>
        <Route path="dashboard">
          <Route index path="*" element={<Dashboard />} />
        </Route>
      </Routes>
    </BrowserRouter>

    function Dashboard() {
      return (
        <div>
          <h2>Dashboard</h2>
          <nav>
            <Link to="..">Dashboard Home</Link>
            <Link to="../team">Team</Link>
            <Link to="../projects">Projects</Link>
          </nav>

          <Routes>
            <Route path="/" element={<DashboardHome />} />
            <Route path="team" element={<DashboardTeam />} />
            <Route path="projects" element={<DashboardProjects />} />
          </Router>
        </div>
      );
    }
    ```

This way, `.` means "the full current pathname for my route" in all
cases (including static, dynamic, and splat routes) and `..` always
means "my parents pathname".

##### Patch Changes

- Properly handle falsy error values in ErrorBoundary's
([#&#8203;11071](https://togithub.com/remix-run/react-router/pull/11071))
-   Updated dependencies:
    -   `@remix-run/router@1.14.0`

</details>

<details>
<summary>remix-run/react-router (react-router-dom)</summary>

###
[`v6.21.1`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router-dom/CHANGELOG.md#6211)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router-dom@6.21.0...react-router-dom@6.21.1)

##### Patch Changes

-   Updated dependencies:
    -   `react-router@6.21.1`
    -   `@remix-run/router@1.14.1`

###
[`v6.21.0`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router-dom/CHANGELOG.md#6210)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router-dom@6.20.1...react-router-dom@6.21.0)

##### Minor Changes

- Add a new `future.v7_relativeSplatPath` flag to implement a breaking
bug fix to relative routing when inside a splat route.
([#&#8203;11087](https://togithub.com/remix-run/react-router/pull/11087))

This fix was originally added in
[#&#8203;10983](https://togithub.com/remix-run/react-router/issues/10983)
and was later reverted in
[#&#8203;11078](https://togithub.com/remix-run/react-router/pull/11078)
because it was determined that a large number of existing applications
were relying on the buggy behavior (see
[#&#8203;11052](https://togithub.com/remix-run/react-router/issues/11052))

    **The Bug**
The buggy behavior is that without this flag, the default behavior when
resolving relative paths is to *ignore* any splat (`*`) portion of the
current route path.

    **The Background**
This decision was originally made thinking that it would make the
concept of nested different sections of your apps in `<Routes>` easier
if relative routing would *replace* the current splat:

    ```jsx
    <BrowserRouter>
      <Routes>
        <Route path="/" element={<Home />} />
        <Route path="dashboard/*" element={<Dashboard />} />
      </Routes>
    </BrowserRouter>
    ```

Any paths like `/dashboard`, `/dashboard/team`, `/dashboard/projects`
will match the `Dashboard` route. The dashboard component itself can
then render nested `<Routes>`:

    ```jsx
    function Dashboard() {
      return (
        <div>
          <h2>Dashboard</h2>
          <nav>
            <Link to="/">Dashboard Home</Link>
            <Link to="team">Team</Link>
            <Link to="projects">Projects</Link>
          </nav>

          <Routes>
            <Route path="/" element={<DashboardHome />} />
            <Route path="team" element={<DashboardTeam />} />
            <Route path="projects" element={<DashboardProjects />} />
          </Routes>
        </div>
      );
    }
    ```

Now, all links and route paths are relative to the router above them.
This makes code splitting and compartmentalizing your app really easy.
You could render the `Dashboard` as its own independent app, or embed it
into your large app without making any changes to it.

    **The Problem**

The problem is that this concept of ignoring part of a path breaks a lot
of other assumptions in React Router - namely that `"."` always means
the current location pathname for that route. When we ignore the splat
portion, we start getting invalid paths when using `"."`:

    ```jsx
// If we are on URL /dashboard/team, and we want to link to
/dashboard/team:
    function DashboardTeam() {
      //  This is broken and results in <a href="/dashboard">
      return <Link to=".">A broken link to the Current URL</Link>;

//  This is fixed but super unintuitive since we're already at
/dashboard/team!
      return <Link to="./team">A broken link to the Current URL</Link>;
    }
    ```

We've also introduced an issue that we can no longer move our
`DashboardTeam` component around our route hierarchy easily - since it
behaves differently if we're underneath a non-splat route, such as
`/dashboard/:widget`. Now, our `"."` links will, properly point to
ourself *inclusive of the dynamic param value* so behavior will break
from it's corresponding usage in a `/dashboard/*` route.

    Even worse, consider a nested splat route configuration:

    ```jsx
    <BrowserRouter>
      <Routes>
        <Route path="dashboard">
          <Route path="*" element={<Dashboard />} />
        </Route>
      </Routes>
    </BrowserRouter>
    ```

Now, a `<Link to=".">` and a `<Link to="..">` inside the `Dashboard`
component go to the same place! That is definitely not correct!

Another common issue arose in Data Routers (and Remix) where any
`<Form>` should post to it's own route `action` if you the user doesn't
specify a form action:

    ```jsx
    let router = createBrowserRouter({
      path: "/dashboard",
      children: [
        {
          path: "*",
          action: dashboardAction,
          Component() {
//  This form is broken! It throws a 405 error when it submits because
// it tries to submit to /dashboard (without the splat value) and the
parent
            // `/dashboard` route doesn't have an action
            return <Form method="post">...</Form>;
          },
        },
      ],
    });
    ```

This is just a compounded issue from the above because the default
location for a `Form` to submit to is itself (`"."`) - and if we ignore
the splat portion, that now resolves to the parent route.

    **The Solution**
If you are leveraging this behavior, it's recommended to enable the
future flag, move your splat to it's own route, and leverage `../` for
any links to "sibling" pages:

    ```jsx
    <BrowserRouter>
      <Routes>
        <Route path="dashboard">
          <Route index path="*" element={<Dashboard />} />
        </Route>
      </Routes>
    </BrowserRouter>

    function Dashboard() {
      return (
        <div>
          <h2>Dashboard</h2>
          <nav>
            <Link to="..">Dashboard Home</Link>
            <Link to="../team">Team</Link>
            <Link to="../projects">Projects</Link>
          </nav>

          <Routes>
            <Route path="/" element={<DashboardHome />} />
            <Route path="team" element={<DashboardTeam />} />
            <Route path="projects" element={<DashboardProjects />} />
          </Router>
        </div>
      );
    }
    ```

This way, `.` means "the full current pathname for my route" in all
cases (including static, dynamic, and splat routes) and `..` always
means "my parents pathname".

##### Patch Changes

-   Updated dependencies:
    -   `@remix-run/router@1.14.0`
    -   `react-router@6.21.0`

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 7pm every weekday,before 5am
every weekday" in timezone Europe/Madrid, Automerge - At any time (no
schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these
updates again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/Unleash/unleash).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xMjcuMCIsInVwZGF0ZWRJblZlciI6IjM3LjEyNy4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-01-12 22:46:33 +00:00
Thomas Heartman
b1d7c27124
docs: add a note about suspended change request schedules (#5874)
This PR describes in closer detail what happens when the user who
scheduled a change request is deleted. It mentions the new suspended
state and what the user can do to get out of it.
2024-01-12 13:18:30 +05:30
renovate[bot]
0210bbba5d
chore(deps): update dependency replace-in-file to v7.1.0 (#5864)
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [replace-in-file](https://togithub.com/adamreisnz/replace-in-file) |
[`7.0.2` ->
`7.1.0`](https://renovatebot.com/diffs/npm/replace-in-file/7.0.2/7.1.0)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/replace-in-file/7.1.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/replace-in-file/7.1.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/replace-in-file/7.0.2/7.1.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/replace-in-file/7.0.2/7.1.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>adamreisnz/replace-in-file (replace-in-file)</summary>

###
[`v7.1.0`](40a3b59894...2bec5b78f8)

[Compare
Source](40a3b59894...2bec5b78f8)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 7pm every weekday,before 5am
every weekday" in timezone Europe/Madrid, Automerge - At any time (no
schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/Unleash/unleash).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xMjcuMCIsInVwZGF0ZWRJblZlciI6IjM3LjEyNy4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-01-11 21:09:11 +00:00
Thomas Heartman
17d5ac4db5
docs: remove white background from images + zoomed images (#5846)
This PR does the following:
1. Replaces all images in the anatomy of Unleash doc with new versions
that don't have text on transparent backgrounds. This makes the images
work on both light and dark backgrounds.
2. Removes the white background from images in the docs. This was only
there to make sure the anatomy images worked in dark mode too.
3. Uses the general docs background color (based on your preferred
theme) when zooming in on images.
2024-01-11 09:56:57 +02: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
Nnenna Ndukwe
2590b4eaea
React v3 updates from offsite (#5787)
## About the changes

Adding in all adjustments from the offsite feedback ahead of the
advanced react examples docs.

https://docs.google.com/document/d/1CftjvAo-us23Dub_Z9cDxEVm9GroQf9CtMdbIEUO39E/edit
2024-01-09 08:59:10 -06:00
dependabot[bot]
c81f3c3948
chore(deps): bump follow-redirects from 1.15.2 to 1.15.4 in /website (#5797)
Bumps
[follow-redirects](https://github.com/follow-redirects/follow-redirects)
from 1.15.2 to 1.15.4.
<details>
<summary>Commits</summary>
<ul>
<li><a
href="65858205e5"><code>6585820</code></a>
Release version 1.15.4 of the npm package.</li>
<li><a
href="7a6567e16d"><code>7a6567e</code></a>
Disallow bracketed hostnames.</li>
<li><a
href="05629af696"><code>05629af</code></a>
Prefer native URL instead of deprecated url.parse.</li>
<li><a
href="1cba8e85fa"><code>1cba8e8</code></a>
Prefer native URL instead of legacy url.resolve.</li>
<li><a
href="72bc2a4229"><code>72bc2a4</code></a>
Simplify _processResponse error handling.</li>
<li><a
href="3d42aecdca"><code>3d42aec</code></a>
Add bracket tests.</li>
<li><a
href="bcbb096b32"><code>bcbb096</code></a>
Do not directly set Error properties.</li>
<li><a
href="192dbe7ce6"><code>192dbe7</code></a>
Release version 1.15.3 of the npm package.</li>
<li><a
href="bd8c81e4f3"><code>bd8c81e</code></a>
Fix resource leak on destroy.</li>
<li><a
href="9c728c314b"><code>9c728c3</code></a>
Split linting and testing.</li>
<li>Additional commits viewable in <a
href="https://github.com/follow-redirects/follow-redirects/compare/v1.15.2...v1.15.4">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=follow-redirects&package-manager=npm_and_yarn&previous-version=1.15.2&new-version=1.15.4)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)
You can disable automated security fix PRs for this repo from the
[Security Alerts
page](https://github.com/Unleash/unleash/network/alerts).

</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-01-09 15:03:29 +01:00
Ivar Conradi Østhus
1333ea7d63
docs: add redirect for python SDK docs 2024-01-09 11:02:25 +01:00
Ivar Conradi Østhus
5c0cc48ec6
docs: change CNAME for github pages to gh.getunleash.io 2024-01-09 10:27:56 +01:00
Ivar Conradi Østhus
9f12404e4a
docs: fix typo in helm-charts rewrite 2024-01-09 10:09:58 +01:00
Ivar Conradi Østhus
82b16bc74a
docs: add raw rewrites for helm chart 2024-01-09 09:57:07 +01:00
Ivar Conradi Østhus
b8231e6dd6
docs: added robots.txt 2024-01-09 09:53:29 +01:00
Thomas Heartman
a71b513e9a
docs: add image zoom to docs (#5778)
This PR adds a zoom feature to the docs.

Interact with the images to blow them up to fill the screen. It leaves the header in place and offsets images. It has some problems with particularly large images, but they seem to be edge cases.
2024-01-09 10:23:56 +05:30
renovate[bot]
51d9386548
chore(deps): update dependency browserslist to v4.22.2 (#5793)
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [browserslist](https://togithub.com/browserslist/browserslist) |
[`4.22.1` ->
`4.22.2`](https://renovatebot.com/diffs/npm/browserslist/4.22.1/4.22.2)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/browserslist/4.22.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/browserslist/4.22.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/browserslist/4.22.1/4.22.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/browserslist/4.22.1/4.22.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>browserslist/browserslist (browserslist)</summary>

###
[`v4.22.2`](https://togithub.com/browserslist/browserslist/compare/4.22.1...80e045442f16c622643ee5ff6b8b765713b75044)

[Compare
Source](https://togithub.com/browserslist/browserslist/compare/4.22.1...80e045442f16c622643ee5ff6b8b765713b75044)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 7pm every weekday,before 5am
every weekday" in timezone Europe/Madrid, Automerge - At any time (no
schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these
updates again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/Unleash/unleash).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xMjEuMCIsInVwZGF0ZWRJblZlciI6IjM3LjEyMS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-01-08 22:22:52 +00:00
Ivar Conradi Østhus
be05974907
docs: fix vercel formatting error 2024-01-08 20:51:17 +01:00
Ivar Conradi Østhus
f040e25377
docs: add helm-charts rewrites 2024-01-08 20:49:04 +01:00
Drew Gorton
02e230f402
Docs: Remove Community Party Banner (#5789)
Remove banner from docs site: Build passes, banner is removed. Merging
2024-01-08 08:08:30 -06:00
Ivar Conradi Østhus
0258ff5269
docs: test helm redirect x3 2024-01-06 10:01:37 +01:00
renovate[bot]
e91c9f2366
chore(deps): update dependency @babel/core to v7.23.7 (#5781)
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [@babel/core](https://babel.dev/docs/en/next/babel-core)
([source](https://togithub.com/babel/babel/tree/HEAD/packages/babel-core))
| [`7.23.6` ->
`7.23.7`](https://renovatebot.com/diffs/npm/@babel%2fcore/7.23.6/7.23.7)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/@babel%2fcore/7.23.7?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@babel%2fcore/7.23.7?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@babel%2fcore/7.23.6/7.23.7?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@babel%2fcore/7.23.6/7.23.7?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>babel/babel (@&#8203;babel/core)</summary>

###
[`v7.23.7`](https://togithub.com/babel/babel/blob/HEAD/CHANGELOG.md#v7237-2023-12-29)

[Compare
Source](https://togithub.com/babel/babel/compare/v7.23.6...v7.23.7)

##### 🐛 Bug Fix

-   `babel-traverse`
- [#&#8203;16191](https://togithub.com/babel/babel/pull/16191) fix:
Crash when removing without `Program`
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
-   `babel-helpers`, `babel-plugin-proposal-decorators`
- [#&#8203;16180](https://togithub.com/babel/babel/pull/16180) fix:
Class decorator `ctx.kind` is wrong
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
-   `babel-plugin-proposal-decorators`
- [#&#8203;16170](https://togithub.com/babel/babel/pull/16170) Fix
decorator initProto usage in derived classes
([@&#8203;JLHwung](https://togithub.com/JLHwung))
-   `babel-core`
- [#&#8203;16167](https://togithub.com/babel/babel/pull/16167) Avoid
unpreventable `unhandledRejection` events
([@&#8203;nicolo-ribaudo](https://togithub.com/nicolo-ribaudo))

##### 🏠 Internal

-   `babel-helper-create-class-features-plugin`
- [#&#8203;16186](https://togithub.com/babel/babel/pull/16186) chore:
Update deps ([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
- `babel-helper-create-class-features-plugin`,
`babel-plugin-proposal-decorators`
- [#&#8203;16177](https://togithub.com/babel/babel/pull/16177) Merge
decorators into class features
([@&#8203;JLHwung](https://togithub.com/JLHwung))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 7pm every weekday,before 5am
every weekday" in timezone Europe/Madrid, Automerge - At any time (no
schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/Unleash/unleash).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xMjEuMCIsInVwZGF0ZWRJblZlciI6IjM3LjEyMS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-01-05 21:36:13 +00:00
Ivar Conradi Østhus
7894d6b554
docs: test helm redirects 2024-01-05 20:50:15 +01:00
Ivar Conradi Østhus
7fc9913c4e
docs: test helm redirects 2024-01-05 20:33:43 +01:00