David Leek
bbfb88122b
docs: jira cloud documentation ( #3494 )
...
<!-- 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! ❤️ -->
New PR using correct prefixes
## 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. -->
Adds documentation to the docs website for the new Jira Cloud plugin.
Couple of pieces on install page are missing due to the nature of having
to have the docs before we can start the review process after which
we'll get the final details on how/where to install/from etc.
Also a couple of pending fixes that might impact screenshots/warrant new
ones made
<!-- (For internal contributors): Does it relate to an issue on public
roadmap? -->
Relates to [roadmap](https://github.com/orgs/Unleash/projects/10 ) item:
#2952
### 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/reference/integrations/jira-cloud-plugin-installation.md
- website/docs/reference/integrations/jira-cloud-plugin-usage.md
## Discussion points
<!-- Anything about the PR you'd like to discuss before it gets merged?
Got any questions or doubts? -->
Very open to improvements on wording and tips on standards used in
screenshots
---------
Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-04-17 15:16:01 +02:00
Thomas Heartman
0a9df052a6
docs: fix broken links ( #3533 )
...
Fixes broken links that were mistakenly committed to main.
2023-04-17 14:10:31 +02:00
Thomas Heartman
222f34f43d
docs: add large segments explainer ( #3441 )
...
This PR adds an explainer document about using large/complex
constraints, inspired by the Unleash and Redis repo.
The intent is to create a comprehensive and understandable explanation
as to why we don't recommend you do this, and also to offer alternative
solutions for the same problem.
---------
Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
2023-04-14 12:59:07 +00:00
andreas-unleash
be4de289a1
fix: project api token docs ( #3485 )
...
<!-- 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! ❤️ -->
[Previous PR (has the
comments)](https://github.com/Unleash/unleash/pull/3405 )
## 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? -->
---------
Signed-off-by: andreas-unleash <andreas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-04-13 11:08:54 +03:00
Mateusz Kwasniewski
536230a364
docs: adr for db changes ( #3439 )
2023-04-11 14:16:40 +02:00
renovate[bot]
3319d34f59
chore(deps): update dependency @babel/core to v7.21.4 ( #3479 )
...
[](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 )) | [`7.21.3` ->
`7.21.4`](https://renovatebot.com/diffs/npm/@babel%2fcore/7.21.3/7.21.4 )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
---
### Release Notes
<details>
<summary>babel/babel</summary>
###
[`v7.21.4`](https://togithub.com/babel/babel/blob/HEAD/CHANGELOG.md#v7214-2023-03-31 )
[Compare
Source](https://togithub.com/babel/babel/compare/v7.21.3...v7.21.4 )
##### 🐛 Bug Fix
- `babel-core`, `babel-helper-module-imports`, `babel-preset-typescript`
- [#​15478](https://togithub.com/babel/babel/pull/15478 ) Fix
support for `import/export` in `.cts` files
([@​liuxingbaoyu](https://togithub.com/liuxingbaoyu ))
- `babel-generator`
- [#​15496](https://togithub.com/babel/babel/pull/15496 ) Fix
compact printing of non-null assertion operators
([@​rtsao](https://togithub.com/rtsao ))
##### 💅 Polish
- `babel-helper-create-class-features-plugin`,
`babel-plugin-proposal-class-properties`,
`babel-plugin-transform-typescript`, `babel-traverse`
- [#​15427](https://togithub.com/babel/babel/pull/15427 ) Fix
moving comments of removed nodes
([@​nicolo-ribaudo](https://togithub.com/nicolo-ribaudo ))
##### 🏠 Internal
- Other
- [#​15519](https://togithub.com/babel/babel/pull/15519 ) Update
Prettier integration test
([@​fisker](https://togithub.com/fisker ))
- `babel-parser`
- [#​15510](https://togithub.com/babel/babel/pull/15510 ) refactor:
introduce `lookaheadInLineCharCode`
([@​JLHwung](https://togithub.com/JLHwung ))
- `babel-code-frame`, `babel-highlight`
- [#​15499](https://togithub.com/babel/babel/pull/15499 ) Polish
babel-code-frame highlight test
([@​JLHwung](https://togithub.com/JLHwung ))
</details>
---
### Configuration
📅 **Schedule**: Branch creation - At any time (no schedule defined),
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://app.renovatebot.com/dashboard#github/Unleash/unleash ).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4zNC4xIiwidXBkYXRlZEluVmVyIjoiMzUuMzQuMSJ9-->
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-04-07 19:08:20 +00:00
Ivan Lee
e45a953cd1
Chore: Update Python SDK compatibility. ( #3474 )
...
<!-- 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 to Python compatibility table.
* Impression events supported in v5.6.0.
([Docs](https://docs.getunleash.io/unleash-client-python/eventcallbacks.html ))
* Bootstrapping from files and custom boostrapping has been supported
since v5.2.0.
([Docs](https://docs.getunleash.io/unleash-client-python/filecache.html )
&
[Docs](https://docs.getunleash.io/unleash-client-python/customcache.html ))
<!-- 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? -->
2023-04-07 10:34:38 +02:00
Thomas Heartman
d18b04de72
docs: fix typo
...
This change fixes two typos in the import export service:
- Unleahs -> Unleash
- API's -> APIs
2023-04-04 07:50:25 +02:00
Thomas Heartman
1ab3a338c9
docs: point link to unleash/unleash instead of unleash-docker ( #3434 )
...
## why
This link used to post to the now-outdated unleash-docker repo. They
should instead go directly to the unleash repo now.
2023-03-31 12:42:34 +02:00
Thomas Heartman
013003d63e
docs: add google tag manager ( #3428 )
...
This change adds google tag manager to docusaurus using the
[plugin-google-tag-manager](https://www.docusaurus.io/docs/api/plugins/@docusaurus/plugin-google-tag-manager )
plugin.
## Why
The current analytics integration we've got in the docs is being sunset
this year, so this is the replacement. It should only collect the same
kind of data that we already collect. It does not require user consent,
and it is used only for aggregation. The point is to help us understand
our users' needs and usage patterns so that we can make a better
product.
2023-03-31 07:27:25 +02:00
renovate[bot]
9db40f50cf
chore(deps): update dependency immer to v9.0.19 ( #3426 )
...
[](https://renovatebot.com )
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [immer](https://togithub.com/immerjs/immer ) | [`9.0.16` ->
`9.0.19`](https://renovatebot.com/diffs/npm/immer/9.0.16/9.0.19 ) |
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
---
### Release Notes
<details>
<summary>immerjs/immer</summary>
### [`v9.0.19`](https://togithub.com/immerjs/immer/releases/tag/v9.0.19 )
[Compare
Source](https://togithub.com/immerjs/immer/compare/v9.0.18...v9.0.19 )
##### Bug Fixes
- don't freeze drafts returned from produce if they were passed in as
draft ([#​917](https://togithub.com/immerjs/immer/issues/917 ))
([46867f8](46867f8aa9https://togithub.com/immerjs/immer/issues/935 )
([a810960](a81096024c82acc409b2https://togithub.com/immerjs/immer/issues/990 )) for
recursive types
([#​1014](https://togithub.com/immerjs/immer/issues/1014 ))
([3eeb331](3eeb3319059d4ea93f8e082eecd610https://togithub.com/immerjs/immer/releases/tag/v9.0.18 )
[Compare
Source](https://togithub.com/immerjs/immer/compare/v9.0.17...v9.0.18 )
##### Bug Fixes
- Preserve insertion order of Sets, fixes
[#​819](https://togithub.com/immerjs/immer/issues/819 )
([#​976](https://togithub.com/immerjs/immer/issues/976 ))
([b3eeb69](b3eeb69f29https://togithub.com/immerjs/immer/issues/990 ))
([b9eae1d](b9eae1d180https://togithub.com/immerjs/immer/releases/tag/v9.0.17 )
[Compare
Source](https://togithub.com/immerjs/immer/compare/v9.0.16...v9.0.17 )
##### Bug Fixes
- special case NaN in setter
([#​912](https://togithub.com/immerjs/immer/issues/912 ))
([5721bb7](5721bb7cfa📅 **Schedule**: Branch creation - At any time (no schedule defined),
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://app.renovatebot.com/dashboard#github/Unleash/unleash ).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4yMy4zIiwidXBkYXRlZEluVmVyIjoiMzUuMjMuMyJ9-->
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-03-30 08:54:47 +00:00
renovate[bot]
1315a600ab
chore(deps): update dependency got to v11.8.6 ( #3414 )
...
[](https://renovatebot.com )
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [got](https://togithub.com/sindresorhus/got ) | [`11.8.5` ->
`11.8.6`](https://renovatebot.com/diffs/npm/got/11.8.5/11.8.6 ) |
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
---
### Release Notes
<details>
<summary>sindresorhus/got</summary>
###
[`v11.8.6`](https://togithub.com/sindresorhus/got/releases/tag/v11.8.6 )
[Compare
Source](https://togithub.com/sindresorhus/got/compare/v11.8.5...v11.8.6 )
- Destroy request object after successful response
</details>
---
### Configuration
📅 **Schedule**: Branch creation - At any time (no schedule defined),
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://app.renovatebot.com/dashboard#github/Unleash/unleash ).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4yMi4xIiwidXBkYXRlZEluVmVyIjoiMzUuMjIuMSJ9-->
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-03-30 00:04:24 +00:00
Mateusz Kwasniewski
dc34fe1944
docs: Update api-tokens-and-client-keys.mdx ( #3418 )
2023-03-29 13:53:57 +02:00
andreas-unleash
5c27153e50
docs: Project api token ( #3405 )
...
<!-- 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? -->
---------
Signed-off-by: andreas-unleash <andreas@getunleash.ai>
2023-03-29 11:39:37 +03:00
renovate[bot]
35348c3e90
chore(deps): update dependency browserslist to v4.21.5 ( #3400 )
...
[](https://renovatebot.com )
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [browserslist](https://togithub.com/browserslist/browserslist ) |
[`4.21.4` ->
`4.21.5`](https://renovatebot.com/diffs/npm/browserslist/4.21.4/4.21.5 )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
---
### Release Notes
<details>
<summary>browserslist/browserslist</summary>
###
[`v4.21.5`](https://togithub.com/browserslist/browserslist/blob/HEAD/CHANGELOG.md#​4215 )
[Compare
Source](https://togithub.com/browserslist/browserslist/compare/4.21.4...4.21.5 )
- Fixed running Browserslist in browser environment.
</details>
---
### Configuration
📅 **Schedule**: Branch creation - At any time (no schedule defined),
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://app.renovatebot.com/dashboard#github/Unleash/unleash ).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4yMy4zIiwidXBkYXRlZEluVmVyIjoiMzUuMjMuMyJ9-->
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-03-28 11:06:11 +00:00
Jaanus Sellin
e9271d8eec
fix: notifcations word break ( #3403 )
2023-03-28 13:27:47 +03:00
Mateusz Kwasniewski
585df244e5
docs: import export for project/env ( #3369 )
2023-03-28 11:12:35 +02:00
Thomas Heartman
2f0a23d948
chore: update docusaurus and deps to v2.3.1 ( #3343 )
...
This also updates the openapi-docs plugin we use to the most recent
beta. Support for 2.3.1 (or 2.3) is not available in any of the stable
packages.
2023-03-28 11:07:36 +02:00
renovate[bot]
511b86de36
chore(deps): update dependency @tsconfig/docusaurus to v1.0.7 ( #3394 )
...
[](https://renovatebot.com )
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [@tsconfig/docusaurus](https://togithub.com/tsconfig/bases ) | [`1.0.6`
->
`1.0.7`](https://renovatebot.com/diffs/npm/@tsconfig%2fdocusaurus/1.0.6/1.0.7 )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
---
### Configuration
📅 **Schedule**: Branch creation - At any time (no schedule defined),
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://app.renovatebot.com/dashboard#github/Unleash/unleash ).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4yMy4zIiwidXBkYXRlZEluVmVyIjoiMzUuMjMuMyJ9-->
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-03-28 03:04:52 +00:00
renovate[bot]
e571129170
chore(deps): update dependency @babel/core to v7.21.3 ( #3388 )
...
[](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 )) | [`7.21.0` ->
`7.21.3`](https://renovatebot.com/diffs/npm/@babel%2fcore/7.21.0/7.21.3 )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
---
### Release Notes
<details>
<summary>babel/babel</summary>
###
[`v7.21.3`](https://togithub.com/babel/babel/blob/HEAD/CHANGELOG.md#v7213-2023-03-14 )
[Compare
Source](https://togithub.com/babel/babel/compare/v7.21.0...v7.21.3 )
##### 👓 Spec Compliance
- `babel-parser`
- [#​15479](https://togithub.com/babel/babel/pull/15479 ) disallow
mixins/implements in flow interface
([@​JLHwung](https://togithub.com/JLHwung ))
##### 🐛 Bug Fix
- `babel-parser`
- [#​15423](https://togithub.com/babel/babel/pull/15423 ) \[ts]
Allow keywords in tuple labels
([@​Harpica](https://togithub.com/Harpica ))
- `babel-plugin-transform-typescript`
- [#​15489](https://togithub.com/babel/babel/pull/15489 ) Register
`var` decls generated by `import ... =` TS transform
([@​amoeller](https://togithub.com/amoeller ))
- [#​15494](https://togithub.com/babel/babel/pull/15494 ) fix:
Consider `export { type foo }` as type-only usage
([@​magic-akari](https://togithub.com/magic-akari ))
##### 💅 Polish
- `babel-traverse`, `babel-types`
- [#​15484](https://togithub.com/babel/babel/pull/15484 ) Skip node
deprecation warnings when used by an old `@babel` package
([@​nicolo-ribaudo](https://togithub.com/nicolo-ribaudo ))
- `babel-generator`
- [#​15480](https://togithub.com/babel/babel/pull/15480 ) chore:
Improve `jsonCompatibleStrings` deprecation
([@​liuxingbaoyu](https://togithub.com/liuxingbaoyu ))
##### 🏠 Internal
- [#​15465](https://togithub.com/babel/babel/pull/15465 ) Add
ESLint-readable package name
([@​nzakas](https://togithub.com/nzakas ))
##### 🔬 Output optimization
- `babel-plugin-transform-typescript`, `babel-preset-typescript`
- [#​15467](https://togithub.com/babel/babel/pull/15467 ) Optimize
TS enums output
([@​liuxingbaoyu](https://togithub.com/liuxingbaoyu ))
</details>
---
### Configuration
📅 **Schedule**: Branch creation - At any time (no schedule defined),
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://app.renovatebot.com/dashboard#github/Unleash/unleash ).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4yMi4xIiwidXBkYXRlZEluVmVyIjoiMzUuMjIuMSJ9-->
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-03-27 21:42:04 +00:00
Mateusz Kwasniewski
d4b4866552
docs: notifications ( #3361 )
2023-03-24 10:37:25 +01:00
Thomas Heartman
db2b40543c
docs: remove unleash client from the docs ( #3378 )
...
We don't use the client for anything at the moment, so we can remove it.
While there are things we can use it for in the future, we should
instead add it back in when we get there.
This also removes the docs feedback form (which we haven't used since
the client stopped working)
2023-03-23 13:26:42 +01:00
Thomas Heartman
e9c2a332b6
Add collab mode docs to side bar + fix casing inconsistency in tooltip ( #3375 )
...
This change does two things:
- Adds project collaboration mode docs to the sidebar
- Fixes a casing inconsistency in the collaboration mode tooltip:
previously, one of the explanations started with a lowercase character
and the other with an uppercase character. Now they both start with
lowercase characters.
2023-03-23 10:27:54 +00:00
Mateusz Kwasniewski
e03307e286
docs: Project collaboration mode docs ( #3360 )
2023-03-22 13:13:56 +01:00
Thomas Heartman
28228cd526
docs: remove "under construction" message for edge ( #3351 )
...
In preparation for Edge's stabilization, this PR removes the "under
construction" admonition that was placed on the edge docs.
2023-03-21 08:36:38 +01:00
Thomas Heartman
335374aa6d
docs(a11y): update syntax highlighting theme to fix contrast issues ( #3341 )
...
This PR changes the syntax highlighting theme we use in the docs. The
reason for the change is that the previous theme we used didn't have
sufficient color contrast between its comment strings and its
background.
## Options
I decided to use the Oceanic Next color theme that is included with
docusaurus. Looking through, the only other dark theme that also passed
AA contrast checks was VS Dark. The reason I picked Oceanic over VS Dark
is simply that I like it better.
For demonstration, here's what the Oceanic theme looks like:
And here's the VS Dark theme:
## Bonus change
The PR also includes a fix to render a pricing admonition correctly.
It's not related to the PR, but I noticed it rendered incorrectly while
I was working on it.
2023-03-17 12:19:13 +02:00
Thomas Heartman
d23266decb
docs: clarify that we don't support multi-host db urls ( #3312 )
...
This PR updates the docs to clarify that we don't support multi-host
strings in the databaseUrl configuration variable.
The docs used to just mention that we accept libpq strings, but as
reported in #3221 , we **don't** support multi-host strings.
I did some digging and found that this is because [node-postgres -- the
library we use to connect to postgres -- itself does not support
multi-host
strings](https://github.com/brianc/node-postgres/issues/2308 ).
To fix this, we would need to replace the library we use or otherwise
wrap it. While this would be a better long-term solution, we don't have
the capacity to it right now. But we can update the docs to better
reflect reality.
2023-03-17 10:13:08 +01:00
dependabot[bot]
c9d8710279
chore(deps): bump @sideway/formula from 3.0.0 to 3.0.1 in /website ( #3302 )
2023-03-13 10:43:29 +00:00
Nuno Góis
516cb1884b
docs: login history ( #3261 )
...
https://linear.app/unleash/issue/2-728/documentation-login-history
-
[reference/login-history](https://unleash-docs-git-docs-login-history-unleash-team.vercel.app/reference/login-history )
-
[how-to/how-to-download-login-history](https://unleash-docs-git-docs-login-history-unleash-team.vercel.app/how-to/how-to-download-login-history )
---------
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-03-08 19:08:50 +00:00
Nuno Góis
6a8ed55c63
feat: better segment info ( #3243 )
...
## About the changes
- Updates the segment information on top to be clearer - No longer an
experimental feature, but we do have some limits in place;
- Also updates the documentation to better reflect this;
Co-authored-by: @thomasheartman
---------
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Gastón Fournier <gaston@getunleash.ai>
2023-03-02 14:13:27 +00:00
renovate[bot]
8dda85527a
chore(deps): update dependency @babel/core to v7.21.0 ( #3230 )
...
[](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 )) | [`7.20.12` ->
`7.21.0`](https://renovatebot.com/diffs/npm/@babel%2fcore/7.20.12/7.21.0 )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
---
### Release Notes
<details>
<summary>babel/babel</summary>
###
[`v7.21.0`](https://togithub.com/babel/babel/blob/HEAD/CHANGELOG.md#v7210-2023-02-20 )
[Compare
Source](https://togithub.com/babel/babel/compare/v7.20.12...v7.21.0 )
##### 🚀 New Feature
- `babel-core`, `babel-helper-create-class-features-plugin`,
`babel-plugin-proposal-class-properties`,
`babel-plugin-proposal-private-methods`,
`babel-plugin-proposal-private-property-in-object`
- [#​15435](https://togithub.com/babel/babel/pull/15435 ) feat:
Implement `privateFieldsAsSymbols` assumption for classes
([@​fwienber](https://togithub.com/fwienber ))
- `babel-helper-create-regexp-features-plugin`,
`babel-plugin-proposal-regexp-modifiers`, `babel-standalone`
- [#​15226](https://togithub.com/babel/babel/pull/15226 ) feat:
Support regexp modifiers proposal
([@​liuxingbaoyu](https://togithub.com/liuxingbaoyu ))
- `babel-cli`, `babel-core`, `babel-generator`,
`babel-plugin-transform-destructuring`,
`babel-plugin-transform-modules-commonjs`,
`babel-plugin-transform-react-jsx`, `babel-traverse`
- [#​15022](https://togithub.com/babel/babel/pull/15022 ) feat:
Generate sourcemaps of friendly call frames
([@​liuxingbaoyu](https://togithub.com/liuxingbaoyu ))
- `babel-parser`, `babel-types`
- [#​15384](https://togithub.com/babel/babel/pull/15384 ) \[ts]
Support `const` modifier in type parameters
([@​nicolo-ribaudo](https://togithub.com/nicolo-ribaudo ))
- `babel-generator`, `babel-helpers`, `babel-parser`,
`babel-plugin-proposal-decorators`, `babel-plugin-syntax-decorators`,
`babel-runtime-corejs2`, `babel-runtime-corejs3`, `babel-runtime`
- [#​15405](https://togithub.com/babel/babel/pull/15405 ) Implement
decorators as presented at `2023-01` TC39 meeting
([@​nicolo-ribaudo](https://togithub.com/nicolo-ribaudo ))
- `babel-parser`
- [#​15114](https://togithub.com/babel/babel/pull/15114 ) Parser
option to allow `new.target` outside functions
([@​overlookmotel](https://togithub.com/overlookmotel ))
- [#​15320](https://togithub.com/babel/babel/pull/15320 ) Add
`annexb: false` parser option to disable Annex B
([@​nicolo-ribaudo](https://togithub.com/nicolo-ribaudo ))
- `babel-core`
- [#​15283](https://togithub.com/babel/babel/pull/15283 ) feat:
Support `.cts` as configuration file
([@​liuxingbaoyu](https://togithub.com/liuxingbaoyu ))
- `babel-generator`, `babel-parser`, `babel-plugin-transform-typescript`
- [#​15381](https://togithub.com/babel/babel/pull/15381 ) \[ts]
Support `export type * from`
([@​nicolo-ribaudo](https://togithub.com/nicolo-ribaudo ))
##### 🐛 Bug Fix
- `babel-plugin-transform-typescript`
- [#​15379](https://togithub.com/babel/babel/pull/15379 ) \[ts5.0]
Better inlining of constants in enums
([@​liuxingbaoyu](https://togithub.com/liuxingbaoyu ))
- `babel-core`
- [#​15366](https://togithub.com/babel/babel/pull/15366 ) handling
circular/shared structures in deep-clone
([@​azizghuloum](https://togithub.com/azizghuloum ))
- `babel-helper-create-class-features-plugin`,
`babel-plugin-proposal-class-properties`,
`babel-plugin-proposal-class-static-block`,
`babel-plugin-proposal-private-methods`,
`babel-plugin-transform-classes`, `babel-plugin-transform-new-target`
- [#​15406](https://togithub.com/babel/babel/pull/15406 ) Preserve
class elements comments in class transform
([@​JLHwung](https://togithub.com/JLHwung ))
- `babel-parser`, `babel-plugin-transform-flow-comments`,
`babel-plugin-transform-flow-strip-types`, `babel-types`
- [#​15414](https://togithub.com/babel/babel/pull/15414 ) \[ts] Fix
restrictions for optional parameters
([@​nicolo-ribaudo](https://togithub.com/nicolo-ribaudo ))
##### 💅 Polish
- `babel-parser`
- [#​15400](https://togithub.com/babel/babel/pull/15400 ) polish:
improve "`await` as identifier" error in modules
([@​JLHwung](https://togithub.com/JLHwung ))
##### 🏠 Internal
- `babel-core`
- [#​15137](https://togithub.com/babel/babel/pull/15137 ) Improve
CJS compat with ESM-based `@babel/core`
([@​nicolo-ribaudo](https://togithub.com/nicolo-ribaudo ))
##### 🔬 Output optimization
- `babel-plugin-transform-typescript`
- [#​15418](https://togithub.com/babel/babel/pull/15418 ) \[ts]
Handle exponentiation operator in constant folding
([@​ehoogeveen-medweb](https://togithub.com/ehoogeveen-medweb ))
</details>
---
### Configuration
📅 **Schedule**: Branch creation - At any time (no schedule defined),
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://app.renovatebot.com/dashboard#github/Unleash/unleash ).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xNTMuMiIsInVwZGF0ZWRJblZlciI6IjM0LjE1My4yIn0=-->
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-03-02 02:37:06 +00:00
renovate[bot]
26819406df
fix(deps): update dependency unleash-proxy-client to v2.4.3 ( #3226 )
...
[](https://renovatebot.com )
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[unleash-proxy-client](https://togithub.com/unleash/unleash-proxy-client-js )
| [`2.4.2` ->
`2.4.3`](https://renovatebot.com/diffs/npm/unleash-proxy-client/2.4.2/2.4.3 )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
---
### Release Notes
<details>
<summary>unleash/unleash-proxy-client-js</summary>
###
[`v2.4.3`](https://togithub.com/Unleash/unleash-proxy-client-js/releases/tag/v2.4.3 )
[Compare
Source](https://togithub.com/unleash/unleash-proxy-client-js/compare/v2.4.2...v2.4.3 )
-
[`c4f5056`](c4f5056c22https://togithub.com/unleash/unleash-proxy-client-js/issues/136 ))
-
[`47bd1df`](47bd1df0d0https://togithub.com/unleash/unleash-proxy-client-js/issues/143 ))
</details>
---
### Configuration
📅 **Schedule**: Branch creation - At any time (no schedule defined),
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://app.renovatebot.com/dashboard#github/Unleash/unleash ).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xNTMuMiIsInVwZGF0ZWRJblZlciI6IjM0LjE1My4yIn0=-->
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-03-01 22:47:47 +00:00
Gastón Fournier
90e4054c90
docs: update documentation around permissions for variants ( #3195 )
...
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-02-28 14:06:24 +01:00
Jaanus Sellin
af82202ada
feat: remove maintenance feature flag ( #3199 )
2023-02-27 15:36:56 +02:00
Thomas Heartman
ff58e2aeaf
docs: clarify note around permissions required ( #3201 )
...
This change does two things:
It clarifies that the permissions listed in the guide are permissions
needed to perform all the steps in the guide, and not the permissions
needed to create a feature.
Separates the project-level and environment-level permissions needed
into separate sublists.
2023-02-27 11:49:53 +00:00
Thomas Heartman
e7ef06ff9d
docs: Update change requests permissions docs ( #3194 )
...
This change updates the "change requests permissions" section of the
change request doc to explicitly call out a few things we've seen
confusion around recently.
These are:
- project owners can't approve/apply change requests. You must create
custom roles
- viewers can create change requests. This is intentional
- skip change requests only works via the API
It also:
- elaborates a little on the circumventing change requests section to
clarify how it works.
- adds the change requests project roles to the project roles list. This
section should be kept up to date with all the relevant roles that exist
for projects.
2023-02-27 08:47:01 +01:00
Gastón Fournier
291bcb4a0f
docs: new variants per environment ( #2590 )
...
## About the changes
Documentation about feature toggle variants per environment
## Discussion points
The version when this will be available is still to be defined.
---------
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-02-24 15:25:03 +01:00
Thomas Heartman
94bfb757d6
docs: slight update to environment docs ( #3187 )
...
## What & why
This update does three things:
1. Adjusts the environment cloning feature availability notice: because
this has been released.
2. Updates the availability notice for environments (to conform with the
standard docusaurus way of doing things): for consistency
3. Add a brief explanation of environment types: because this isn't
documented anywhere
## Sources
The note about how environment types work is sourced from this old
[slack thread (internal to the
team)](https://unleash-community.slack.com/archives/G01MU2Q49QC/p1659600175175769 )
2023-02-24 12:48:45 +00:00
Thomas Heartman
898160b295
network-view-docs: rename source file ( #3183 )
...
This PR expands upon the docs in the original PR (and thus supersedes #3139 )
It contains the docs for the recent network view feature.
Closes #2603
---------
Co-authored-by: Gastón Fournier <gaston@getunleash.io>
Co-authored-by: Gastón Fournier <gaston@getunleash.ai>
2023-02-24 08:36:12 +00:00
Thomas Heartman
08dbf23ee7
docs: mention env var options for auth config ( #3169 )
...
## What
Adds environment variable equivalents for remaining authentication
options.
Also reformats the list silghtly.
## Why
Because the `AUTH_TYPE` and `AUTH_ENABLE_API_TOKEN` variables hadn't
been previously mentioned and we get questions about this from time to
time.
The reformat is primarily for using `monospace font` where appropriate.
2023-02-22 12:32:27 +01:00
Thomas Heartman
53c82d798f
docs: remove the proxy from the sdks overview table ( #3060 )
...
## What
This change removes the "unleash proxy" column from the SDK compat
table.
## Why
Because the proxy isn't technically an SDK. Having the column there can
be misleading to users.
In the latest case, a user pointed out that the table says the proxy
supports `isEnabled` with fallback values, but that there is no way to
use this via the API (or via client-side sdks) at the moment.
I think we should add a section to the proxy doc about its capabilities
instead.
In fact, I think we should do the same thing with the proxy that we did
with the SDKs: merge the docs.getunleash content with the github readme
and instead source it from there.
2023-02-22 09:42:47 +00:00
Gastón Fournier
4e3ce8e0af
chore: GA responseTimeWithAppNames ( #3178 )
...
## About the changes
This makes response time with app names enabled for everyone but also
kept a way of turning it off (kill switch) in case it cause some issues
because of misconfigured app names
2023-02-22 09:10:06 +00:00
Jaanus Sellin
1dba7291ba
feat: maintenance mode docs ( #3159 )
...
feat: maintenance mode docs
2023-02-20 16:27:28 +02:00
renovate[bot]
e9b669a49a
chore(deps): update react-router monorepo to v6.8.1 ( #3137 )
...
[](https://renovatebot.com )
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [react-router](https://togithub.com/remix-run/react-router ) | [`6.6.2`
-> `6.8.1`](https://renovatebot.com/diffs/npm/react-router/6.6.2/6.8.1 )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
| [react-router-dom](https://togithub.com/remix-run/react-router ) |
[`6.6.2` ->
`6.8.1`](https://renovatebot.com/diffs/npm/react-router-dom/6.6.2/6.8.1 )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
---
### Release Notes
<details>
<summary>remix-run/react-router (react-router)</summary>
###
[`v6.8.1`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router/CHANGELOG.md#​681 )
[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router@6.8.0...react-router@6.8.1 )
##### Patch Changes
- Remove inaccurate console warning for POP navigations and update
active blocker logic
([#​10030](https://togithub.com/remix-run/react-router/pull/10030 ))
- Updated dependencies:
- `@remix-run/router@1.3.2`
###
[`v6.8.0`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router/CHANGELOG.md#​680 )
[Compare
Source](74979cb5f8https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router/CHANGELOG.md#​670 )
[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router@6.6.2...74979cb5f84092d83adcf5cda5bf281b3450683c )
##### Minor Changes
- Add `unstable_useBlocker` hook for blocking navigations within the
app's location origin
([#​9709](https://togithub.com/remix-run/react-router/pull/9709 ))
##### Patch Changes
- Fix `generatePath` when optional params are present
([#​9764](https://togithub.com/remix-run/react-router/pull/9764 ))
- Update `<Await>` to accept `ReactNode` as children function return
result
([#​9896](https://togithub.com/remix-run/react-router/pull/9896 ))
- Updated dependencies:
- `@remix-run/router@1.3.0`
</details>
<details>
<summary>remix-run/react-router (react-router-dom)</summary>
###
[`v6.8.1`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router-dom/CHANGELOG.md#​681 )
[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router-dom@6.8.0...react-router-dom@6.8.1 )
##### Patch Changes
- Improved absolute url detection in `Link` component (now also supports
`mailto:` urls)
([#​9994](https://togithub.com/remix-run/react-router/pull/9994 ))
- Fix partial object (search or hash only) pathnames losing current path
value
([#​10029](https://togithub.com/remix-run/react-router/pull/10029 ))
- Updated dependencies:
- `react-router@6.8.1`
- `@remix-run/router@1.3.2`
###
[`v6.8.0`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router-dom/CHANGELOG.md#​680 )
[Compare
Source](74979cb5f8https://togithub.com/remix-run/react-router/pull/9900 ))
```tsx
<Link to="https://neworigin.com/some/path "> {/* Document request */}
<Link to="//neworigin.com/some/path"> {/* Document request */}
<Link to="https://www.currentorigin.com/path "> {/* Client-side
navigation */}
```
##### Patch Changes
- Fix bug with search params removal via `useSearchParams`
([#​9969](https://togithub.com/remix-run/react-router/pull/9969 ))
- Respect `preventScrollReset` on `<fetcher.Form>`
([#​9963](https://togithub.com/remix-run/react-router/pull/9963 ))
- Fix navigation for hash routers on manual URL changes
([#​9980](https://togithub.com/remix-run/react-router/pull/9980 ))
- Use `pagehide` instead of `beforeunload` for `<ScrollRestoration>`.
This has better cross-browser support, specifically on Mobile Safari.
([#​9945](https://togithub.com/remix-run/react-router/pull/9945 ))
- Updated dependencies:
- `@remix-run/router@1.3.1`
- `react-router@6.8.0`
###
[`v6.7.0`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router-dom/CHANGELOG.md#​670 )
[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router-dom@6.6.2...74979cb5f84092d83adcf5cda5bf281b3450683c )
##### Minor Changes
- Add `unstable_useBlocker` hook for blocking navigations within the
app's location origin
([#​9709](https://togithub.com/remix-run/react-router/pull/9709 ))
- Add `unstable_usePrompt` hook for blocking navigations within the
app's location origin
([#​9932](https://togithub.com/remix-run/react-router/pull/9932 ))
- Add `preventScrollReset` prop to `<Form>`
([#​9886](https://togithub.com/remix-run/react-router/pull/9886 ))
##### Patch Changes
- Added pass-through event listener options argument to
`useBeforeUnload`
([#​9709](https://togithub.com/remix-run/react-router/pull/9709 ))
- Streamline jsdom bug workaround in tests
([#​9824](https://togithub.com/remix-run/react-router/pull/9824 ))
- Updated dependencies:
- `@remix-run/router@1.3.0`
- `react-router@6.7.0`
</details>
---
### Configuration
📅 **Schedule**: Branch creation - At any time (no schedule defined),
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://app.renovatebot.com/dashboard#github/Unleash/unleash ).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xNDIuMSIsInVwZGF0ZWRJblZlciI6IjM0LjE0My4xIn0=-->
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-02-18 16:04:36 +00:00
Thomas Heartman
0b1d4fbd07
docs: add notes to constraints and segment docs about large values ( #3142 )
...
## What
This PR adds a note to the constraint and the segment docs about using a
large number of constraint values.
## Why
This is a fairly common question in slack, and there is no clear
documentation around this at the moment. As such, it's likely that
people do this a fair bit without telling us. We don't think this is the
right approach, so adding this bit of documentation should hopefully
make it a little clearer.
2023-02-17 11:06:25 +00:00
Thomas Heartman
415e1b0596
Source proxy and Edge docs from GitHub ( #3122 )
...
## What
The main purpose of this PR is to
1. Delete the proxy docs in this repo and replace them with the proxy's
GitHub readme.
2. Add the docs for Unleash Edge.
### Detailed change description
This PR contains a lot of small changes in a large number of files. To
make it easier to get an overview, here's a detailed description of what
happens where:
#### In the `website/docs`directory
Except for the deletion of the proxy doc, all changes in this directory
are rewriting internal links, so that they point to the newly generated
document instead.
#### `package.json` and `yarn.lock`
When including the documentation for Edge, we also want to render the
mermaid diagrams it uses. Docusaurus supports this via a plugin. All
changes in these files are related to installing that plugin.
#### `docusaurus.config.js`
There's two types of changes in this file:
1. Mermaid-related changes: we ask docusaurus to render mermaid in
markdown files and add the plugin
2. Document generation. There's some rewrites to the sdk doc generation
plus an entirely new section that generates docs for Edge and the proxy
#### `sidebars.js`
Two things:
1. Add the edge docs
2. Move both the Edge and the proxy docs up a level, so that they're
directly under "reference docs" instead of nested inside "unleash
concepts".
#### In the `website/remote-content` directory
These are the remote content files. Previously, all of this lived only
in a `readme-fns.js` file, but with the introduction of Edge and proxy
docs, this has been moved into its own directory and refactored into
three files (`shared`, `sdks`, `edge-proxy`).
#### `custom.css`
Style updates to center mermaid diagrams and provide more space around
them.
#### In `static/img`
The image files that were included in the proxy doc and that have been
deleted.
## Why
For two reasons:
1. Reduce duplication for the proxy. Have one source of truth.
2. Add docs for edge.
## Discussion points and review wishes
This is a big PR, and I don't expect anyone to do a line-by-line review
of it, nor do I think that is particularly useful. Instead, I'd like to
ask reviewers to:
1. Visit the [documentation
preview](https://unleash-docs-git-docs-source-proxy-gh-unleash-team.vercel.app/reference/unleash-proxy )
and have a look at both the proxy docs and the Edge docs. Potentially
have a look at the SDK docs too to verify that everything still works.
2. Consider whether they think moving the proxy and edge docs up a level
(in the sidebar) makes sense.
3. Let me know what slug they'd prefer for the Edge docs. I've gone with
`unleash-edge` for now (so that it's
`docs.getunleash.io/reference/unleash-edge`), but we could potentially
also just use `edge`. WDYT?
4. Read through the detailed changes section.
5. Let me know if they have any other concerns or questions.
## Screenies
The new proxy doc:
The new edge doc:
2023-02-16 13:36:28 +01:00
renovate[bot]
5420e3c965
fix(deps): update dependency unleash-proxy-client to v2.4.2 ( #3099 )
...
[](https://renovatebot.com )
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[unleash-proxy-client](https://togithub.com/unleash/unleash-proxy-client-js )
| [`2.4.0` ->
`2.4.2`](https://renovatebot.com/diffs/npm/unleash-proxy-client/2.4.0/2.4.2 )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
---
### Release Notes
<details>
<summary>unleash/unleash-proxy-client-js</summary>
###
[`v2.4.2`](https://togithub.com/Unleash/unleash-proxy-client-js/releases/tag/v2.4.2 )
[Compare
Source](https://togithub.com/unleash/unleash-proxy-client-js/compare/v2.4.1...v2.4.2 )
-
[`35f79bd`](35f79bdec7https://togithub.com/unleash/unleash-proxy-client-js/issues/137 ))
-
[`56529ac`](56529ac23dhttps://togithub.com/unleash/unleash-proxy-client-js/issues/138 ))
-
[`8a3bc72`](8a3bc72058https://togithub.com/unleash/unleash-proxy-client-js/issues/140 ))
###
[`v2.4.1`](https://togithub.com/Unleash/unleash-proxy-client-js/releases/tag/v2.4.1 )
[Compare
Source](https://togithub.com/unleash/unleash-proxy-client-js/compare/v2.4.0...v2.4.1 )
-
[`0ca4603`](0ca4603fa9https://togithub.com/unleash/unleash-proxy-client-js/issues/130 ))
-
[`d5f0c74`](d5f0c74352https://togithub.com/unleash/unleash-proxy-client-js/issues/131 ))
-
[`2fd7282`](2fd7282ef9https://togithub.com/unleash/unleash-proxy-client-js/issues/134 ))
-
[`c3554dd`](c3554dd3f8https://togithub.com/unleash/unleash-proxy-client-js/issues/135 ))
</details>
---
### Configuration
📅 **Schedule**: Branch creation - At any time (no schedule defined),
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://app.renovatebot.com/dashboard#github/Unleash/unleash ).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMzMuMCIsInVwZGF0ZWRJblZlciI6IjM0LjEzMy4wIn0=-->
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-02-14 16:52:29 +00:00
renovate[bot]
5c5269d618
fix(deps): update dependency docusaurus-theme-openapi-docs to v1.5.2 ( #3098 )
...
[](https://renovatebot.com )
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[docusaurus-theme-openapi-docs](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs )
| [`1.5.1` ->
`1.5.2`](https://renovatebot.com/diffs/npm/docusaurus-theme-openapi-docs/1.5.1/1.5.2 )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
---
### Release Notes
<details>
<summary>PaloAltoNetworks/docusaurus-openapi-docs</summary>
###
[`v1.5.2`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#​152-Feb-2-2023 )
[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v1.5.1...v1.5.2 )
High level enhancements
- Improved support for rendering items/arrays
- Fixed issue that prevented some schemas from fully-rendering
([#​397](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/397 ))
- Added support for `nullable`
Other enhancements and bug fixes
- Cleanup API doc demos
([#​400](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/400 ))
- \[Bug] Support multiple same-level node types and improve items/array
support
([#​397](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/397 ))
- Bump ua-parser-js from 0.7.32 to 0.7.33
([#​395](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/395 ))
- Add support for nullable
([#​393](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/393 ))
- Bump cookiejar from 2.1.3 to 2.1.4
([#​390](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/390 ))
- Update intro/README
([#​384](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/384 ))
- Update a link in the credits
([#​382](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/382 ))
</details>
---
### Configuration
📅 **Schedule**: Branch creation - At any time (no schedule defined),
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://app.renovatebot.com/dashboard#github/Unleash/unleash ).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMzMuMCIsInVwZGF0ZWRJblZlciI6IjM0LjEzMy4wIn0=-->
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-02-14 05:35:55 +00:00
renovate[bot]
8cd779a57b
fix(deps): update dependency docusaurus-plugin-openapi-docs to v1.5.2 ( #3095 )
...
[](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 )
| [`1.5.1` ->
`1.5.2`](https://renovatebot.com/diffs/npm/docusaurus-plugin-openapi-docs/1.5.1/1.5.2 )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
---
### Release Notes
<details>
<summary>PaloAltoNetworks/docusaurus-openapi-docs</summary>
###
[`v1.5.2`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#​152-Feb-2-2023 )
[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v1.5.1...v1.5.2 )
High level enhancements
- Improved support for rendering items/arrays
- Fixed issue that prevented some schemas from fully-rendering
([#​397](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/397 ))
- Added support for `nullable`
Other enhancements and bug fixes
- Cleanup API doc demos
([#​400](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/400 ))
- \[Bug] Support multiple same-level node types and improve items/array
support
([#​397](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/397 ))
- Bump ua-parser-js from 0.7.32 to 0.7.33
([#​395](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/395 ))
- Add support for nullable
([#​393](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/393 ))
- Bump cookiejar from 2.1.3 to 2.1.4
([#​390](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/390 ))
- Update intro/README
([#​384](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/384 ))
- Update a link in the credits
([#​382](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/382 ))
</details>
---
### Configuration
📅 **Schedule**: Branch creation - At any time (no schedule defined),
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://app.renovatebot.com/dashboard#github/Unleash/unleash ).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMzMuMCIsInVwZGF0ZWRJblZlciI6IjM0LjEzMy4wIn0=-->
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-02-14 02:01:25 +00:00
renovate[bot]
0acfbfe52f
chore(deps): update storybook monorepo to v6.5.16 ( #3093 )
...
[](https://renovatebot.com )
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[@storybook/addon-actions](https://togithub.com/storybookjs/storybook/tree/main/addons/actions )
([source](https://togithub.com/storybookjs/storybook )) | [`6.5.15` ->
`6.5.16`](https://renovatebot.com/diffs/npm/@storybook%2faddon-actions/6.5.15/6.5.16 )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
|
[@storybook/addon-essentials](https://togithub.com/storybookjs/storybook/tree/main/addons/essentials )
([source](https://togithub.com/storybookjs/storybook )) | [`6.5.15` ->
`6.5.16`](https://renovatebot.com/diffs/npm/@storybook%2faddon-essentials/6.5.15/6.5.16 )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
|
[@storybook/addon-interactions](https://togithub.com/storybookjs/storybook/tree/main/addons/interactions )
([source](https://togithub.com/storybookjs/storybook )) | [`6.5.15` ->
`6.5.16`](https://renovatebot.com/diffs/npm/@storybook%2faddon-interactions/6.5.15/6.5.16 )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
|
[@storybook/addon-links](https://togithub.com/storybookjs/storybook/tree/main/addons/links )
([source](https://togithub.com/storybookjs/storybook )) | [`6.5.15` ->
`6.5.16`](https://renovatebot.com/diffs/npm/@storybook%2faddon-links/6.5.15/6.5.16 )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
|
[@storybook/react](https://togithub.com/storybookjs/storybook/tree/main/app/react )
([source](https://togithub.com/storybookjs/storybook )) | [`6.5.15` ->
`6.5.16`](https://renovatebot.com/diffs/npm/@storybook%2freact/6.5.15/6.5.16 )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
[](https://docs.renovatebot.com/merge-confidence/ )
|
---
### Release Notes
<details>
<summary>storybookjs/storybook</summary>
###
[`v6.5.16`](https://togithub.com/storybookjs/storybook/releases/tag/v6.5.16 )
[Compare
Source](https://togithub.com/storybookjs/storybook/compare/v6.5.15...v6.5.16 )
##### Bug Fixes
- Angular: Fix handling of docsMode option in angular builder
[#​20608](https://togithub.com/storybooks/storybook/pull/20608 )
- Angular: Fix webpackStatsJson types in angular-builder
[#​20296](https://togithub.com/storybooks/storybook/pull/20296 )
##### Dependency Upgrades
- Security: Upgrade json5 dependency
[#​20526](https://togithub.com/storybooks/storybook/pull/20526 )
</details>
---
### Configuration
📅 **Schedule**: Branch creation - At any time (no schedule defined),
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://app.renovatebot.com/dashboard#github/Unleash/unleash ).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMzMuMCIsInVwZGF0ZWRJblZlciI6IjM0LjEzMy4wIn0=-->
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-02-13 12:23:59 +00:00
