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

594 Commits

Author SHA1 Message Date
Thomas Heartman
4e03e4b3a8 chore: fix broken link to community sdks section 2022-02-07 13:02:07 +01:00
Ivar Conradi Østhus
2bc7b951b2
doc: Fix delete call for deleting feature toggles
Fixes: #1330
2022-02-04 12:56:58 +01:00
Thomas Heartman
673b297209 docs: use some-secret instead of some-public-key
The rest of the docs all use `some-secret`, so having only this **one**
place use `some-public-key` is really misleading.
2022-02-04 10:13:27 +01:00
olav
73bd6a0bc4 docs: fix markdown file name 2022-02-01 16:00:56 +01:00
olav
e7a1bd86a4
docs: link directly to the markdown file
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-02-01 15:53:16 +01:00
olav
1f6c91b517
docs: link directly to the markdown file
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-02-01 15:52:21 +01:00
olav
1bba30a3de docs: fix link to getting started page 2022-02-01 14:49:55 +01:00
olav
8c09bf4fe5 docs: fix link to addons page 2022-02-01 14:49:52 +01:00
Renovate Bot
fe0c35c7f4 fix(deps): update dependency @svgr/webpack to v6.2.1 2022-01-30 13:05:00 +00:00
Thomas Heartman
26f66c4f93 fix(docs): remove test subcat from sidebar 2022-01-28 08:21:41 +01:00
Thomas Heartman
b26869fec7
Merge pull request #1308 from Unleash/docs/add-video-component
Docs: Add a new video component
2022-01-27 13:37:11 +01:00
Thomas Heartman
65c25328cd docs: remove container query polyfill
Turns out there's an issue that makes it incompatible with
docusaurus (due to class names, see https://github.com/GoogleChromeLabs/container-query-polyfill/issues/23)

Instead, we'll stick to media queries for now.
2022-01-27 13:21:03 +01:00
Thomas Heartman
0073de000e docs: remove redundant video heading and commented-out content. 2022-01-27 13:19:55 +01:00
renovate[bot]
fe20a62f87
fix(deps): pin dependency @docusaurus/plugin-google-analytics to 2.0.0-beta.15 (#1307)
Co-authored-by: Renovate Bot <bot@renovateapp.com>
2022-01-27 13:19:54 +01:00
Ivar Conradi Østhus
d4e0c6a2b1
fix: googleAnalytics for docusaurus to new format (#1306) 2022-01-27 13:12:00 +01:00
Thomas Heartman
e4b21a3125 chore: make docs sidebar hover and active color same unleash grey. 2022-01-27 13:05:27 +01:00
Thomas Heartman
c14f52c3ca docs: finish v1 of the video content element. 2022-01-27 12:48:39 +01:00
Thomas Heartman
9ba9abbe29 docs: Update how-to for cprs with new video element. 2022-01-27 12:48:23 +01:00
Thomas Heartman
fdb435a6be
Merge pull request #1305 from aruizs/patch-1
Doc: Add Unleash SDK for C++ to Community SDKs list.
2022-01-27 10:03:09 +01:00
Thomas Heartman
73ee4c9250 docs(a11y): remove role 'alert' from availability notice.
According to [MDN's article on the `alert`
role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Alert_Role),
`alert` should only be used for "information that requires the user's
immediate attention", such as the user's login session being about to
expire or the connection to the server being lost so that local
changes will not be saved.

They also add that:

> Warning: Because of its intrusive nature, the alert role must be used sparingly and only in situations where the user's immediate attention is required.

While availability may be an important (or at least relevant) piece of
information, I do not think it classifies as urgent or requiring
immediate attention.
2022-01-27 09:59:38 +01:00
Antonio Ruiz
0f03bebcef Add Unleash SDK for C++ to Community SDKs list. 2022-01-27 09:53:08 +01:00
Thomas Heartman
ac7c9bb2df chore: rename unleash purple color variable to align with other vars 2022-01-26 13:53:21 +01:00
Thomas Heartman
0c6bbc215c docs: move video component to /src/components 2022-01-26 13:52:17 +01:00
Thomas Heartman
2c318546b6 docs: remove unnecessary wrapping divs. 2022-01-26 13:52:17 +01:00
Thomas Heartman
a853de45ce docs: size video wrapper elements correctly 2022-01-26 13:52:17 +01:00
Thomas Heartman
1a399fcabc docs: add video content component (to be moved) 2022-01-26 13:52:17 +01:00
Thomas Heartman
c373db40bb docs: make the video content callout Unleash gray. 2022-01-26 13:52:17 +01:00
Thomas Heartman
27ab905d4f docs: remove container query polyfill. 2022-01-26 13:52:17 +01:00
Thomas Heartman
2a6504e581 docs: use grid for videos in smaller formats. 2022-01-26 13:52:16 +01:00
Thomas Heartman
132cba741c docs: add media query to control for smaller sizes. 2022-01-26 13:51:44 +01:00
Thomas Heartman
2d56e07d3d docs: styling changes to the videos component 2022-01-26 13:51:44 +01:00
Thomas Heartman
2259cc4e68 docs: add initial video component idea (+ cq polyfill)
note: polyfill is currently broken for some reason 🤷
2022-01-26 13:51:44 +01:00
Thomas Heartman
4c48d5bf89 chore: fix typo in introductory docs (missing accent) 2022-01-26 13:49:56 +01:00
Thomas Heartman
bb37141899 docs: Tweak github links (labels, text) 2022-01-26 12:22:03 +01:00
Thomas Heartman
e697e146d6 chore(format): run prettier on the custom css stylesheet 2022-01-26 11:57:52 +01:00
Thomas Heartman
ee55f6a9fb docs: make top-level categories open by default, re-order references 2022-01-26 11:52:03 +01:00
Thomas Heartman
f62a65a23a docs: order the docs structure overview the same as the actual doc. 2022-01-25 12:25:08 +01:00
Thomas Heartman
a78f4bd4c4 fix: remove unused style 2022-01-25 12:22:25 +01:00
Thomas Heartman
1b48bc0a9e docs: sidebar markers // use vertical pipes instead. 2022-01-25 12:22:25 +01:00
Thomas Heartman
fe17c4f062 docs: add purple squares to the top level categories. 2022-01-25 12:22:24 +01:00
Thomas Heartman
f944a40d78 docs: Extend docs landing page; add more links, structure, etc. 2022-01-25 12:22:00 +01:00
Thomas Heartman
100e136951 docs: flesh out integrations category page. 2022-01-25 12:22:00 +01:00
Thomas Heartman
738643eb24 docs: Add landing pages for all first and second-level categories. 2022-01-25 12:22:00 +01:00
Thomas Heartman
ea0ff8f991 docs: Potential fix to SSO guide ordering (with deprecated guides) 2022-01-25 12:22:00 +01:00
Thomas Heartman
3dec1ee7b2 docs: remove emoji, add placeholder links to landing page. 2022-01-25 12:22:00 +01:00
Thomas Heartman
6d43b93be2 docs(chore): fix broken links to control_rollout 2022-01-25 12:22:00 +01:00
Thomas Heartman
775da4787b docs: remove links to deployment, integrations, and api. 2022-01-25 12:22:00 +01:00
Thomas Heartman
43604df380 docs: sort all sidebar items 2022-01-25 12:22:00 +01:00
Thomas Heartman
de41208164 docs: create categories and group how-to guides.
This probably needs more discussion etc, but it's a good start, I think.
2022-01-25 12:22:00 +01:00
Thomas Heartman
a13a463255 docs: change topic emoji from 🤓 -> 🧠 2022-01-25 12:22:00 +01:00
Thomas Heartman
5e556bc87d Rename all how-to guides to start with 'how to'. 2022-01-25 12:22:00 +01:00
Thomas Heartman
286edba290 docs: place emoji before their following headings 2022-01-25 12:22:00 +01:00
Thomas Heartman
bf7231bdab docs: group sdks by server/client 2022-01-25 12:22:00 +01:00
Thomas Heartman
e43f1dd60f docs: delete control-rollout, redirect to activation strategies 2022-01-25 12:22:00 +01:00
Thomas Heartman
50d0f39140 docs: add content from control rollout to activation strategies
The two documents covered almost the exact same things (and even had
the same text. verbatim!).
2022-01-25 12:22:00 +01:00
Thomas Heartman
d3d9d44049 docs: remove 'what's new in v4' 2022-01-25 12:22:00 +01:00
Thomas Heartman
4848104ec8 docs: move all docs into sidebar 2022-01-25 12:22:00 +01:00
Thomas Heartman
28934042c0 docs: re-categorize most current docs 2022-01-25 12:22:00 +01:00
Thomas Heartman
ca7657e424 docs: change title of addons index doc. 2022-01-25 12:22:00 +01:00
Thomas Heartman
8828523e4d docs: move sdks to reference docs 2022-01-25 12:22:00 +01:00
Thomas Heartman
4f0fa7cfd2 docs: move addons and (most) api docs to reference 2022-01-25 12:21:58 +01:00
Thomas Heartman
19eea8b3a2 docs: rename doc introduction. 2022-01-25 12:21:00 +01:00
Thomas Heartman
b3c28de0bb docs: add introduction as separate entry 2022-01-25 12:20:53 +01:00
Thomas Heartman
24e614c977 docs: start restructuring the docs landing page. 2022-01-25 12:20:06 +01:00
Thomas Heartman
c9026395b7 docs: add initial extra doc categories. 2022-01-25 12:20:06 +01:00
Dtaggart
59cd88d720
docs: Update getting-started.md (#1294)
Correct password spelling. Was missing w
2022-01-24 09:27:50 +01:00
Ivar Conradi Østhus
8a175aa217
docs: update Server-side SDK compatibility table 2022-01-23 22:50:39 +01:00
Ivar Conradi Østhus
a5367ef9f8
docs: improve proxy commands 2022-01-21 10:13:22 +01:00
Thomas Heartman
d27542bb5d
Merge pull request #1281 from Unleash/docs/add-cpr-vids
docs: Add how-to videos to cpr how-tos
2022-01-20 12:44:37 +01:00
Philippe Vaillancourt
ce555f5f70
docs: Add ngx-unleash-proxy-client to community sdks (#1275) 2022-01-20 12:26:00 +01:00
sighphyre
1207d83aab docs: Move proxy sdk compatibility to end of the compatability table 2022-01-19 16:49:18 +02:00
sighphyre
738d6eb91a
Update website/docs/sdks/index.md
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-01-19 16:09:24 +02:00
Thomas Heartman
3ce2ea0f61 docs: simplify text 2022-01-19 15:08:25 +01:00
Thomas Heartman
c113081866 docs: Add how-to videos to cpr how-tos
For simplicity I've added them as separate sections, but I'd love for
them to be listed higher up.
2022-01-19 15:05:28 +01:00
sighphyre
76a55946a9 docs: Add in missing N/A for rust context provider compatibility 2022-01-19 15:58:57 +02:00
sighphyre
53034e837f chore: Add compatability table for Rust SDK 2022-01-19 09:32:37 +02:00
Thomas Heartman
8868881f61
Merge pull request #1276 from Unleash/a11y/fix-contrast-on-hover-links-in-footer
fix(docs/a11y): fix lack of contrast in on hovered links in footer
2022-01-18 12:40:44 +01:00
Thomas Heartman
4899eff20e fix(docs/a11y): fix lack of contrast in on hovered links in footer
This commit changes the hover color of links in the footer to keep it
accessible.

The color will be the exact same as the un-hovered version. This is in
line with the other links in the documentation. The links _do_ get
underlined when hovered, so there is still a visual distinction
between the states.

I've added the variable in the `footer` section instead of in `:root`
because the variable I assign it to (`--ifm-footer-link-color`) gets
overridden closer to the footer, so if you set it in `:root`, you end
up with the wrong value.

addresses and closes https://github.com/Unleash/unleash.github.io/issues/8
2022-01-18 11:46:32 +01:00
Thomas Heartman
184a18ba41
Merge branch 'master' into chore/update-workflows 2022-01-18 11:16:24 +01:00
Thomas Heartman
a6f9c4f621 fix: use the Unleash purple for links / increase contrast
This increases the contrast from 3.42 to above 4.5, in compliance with
the AA standard.
2022-01-17 15:51:15 +01:00
Thomas Heartman
cf35efedee
Apply suggestions from code review
Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-01-17 14:55:06 +01:00
Thomas Heartman
611602c781 docs: add steps for running the proxy via Node
Also: restructure the steps relating to running it via docker to align
better and to avoid repeating information.
2022-01-14 13:53:09 +01:00
Thomas Heartman
e8a3d6e6f1
Merge pull request #1238 from Unleash/docs/custom-project-roles
docs: describe new custom project roles
2022-01-14 12:28:45 +01:00
Thomas Heartman
55a7cefc53 docs: add note about when the new configuration option was added. 2022-01-14 12:20:31 +01:00
Thomas Heartman
39e79c064f
Apply suggestions from code review
Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-01-14 11:28:47 +01:00
Thomas Heartman
299afd97ff docs(chore): update images; remove empty space. 2022-01-14 11:09:32 +01:00
Thomas Heartman
7897ee2e87 docs: add how-to screenies for cpr 2022-01-14 10:59:18 +01:00
Thomas Heartman
5f581f765e
Merge pull request #1263 from Unleash/docs/group-sdks
docs: group sdks into non-collapsible categories: server and client
2022-01-14 08:56:04 +01:00
Thomas Heartman
308f5ab4d3 docs: add new cpr permissions, update existing ones 2022-01-14 08:23:17 +01:00
Thomas Heartman
9fbfc28a72 docs: add Rust SDK to sidebar list of official sdks. 2022-01-13 10:38:20 +01:00
Thomas Heartman
9e55752dcf docs(chore): standardize on the naming of the .NET sdk. 2022-01-13 10:36:24 +01:00
Thomas Heartman
bfd168689c docs(chore): sort the sdk list the same as the sidebar list. 2022-01-13 10:34:05 +01:00
kakakakakku
18c87cedf6 Fixed syntax error for Ruby SDK example 2022-01-13 09:59:51 +01:00
Thomas Heartman
b8f3313ae2 docs: group sdks into non-collapsible categories: server and client 2022-01-13 09:21:13 +01:00
Thomas Heartman
211de55bb7 docs: add new disableLegacyFeaturesApi config option. 2022-01-12 14:20:45 +01:00
Thomas Heartman
d99602355e docs(chore): sort configuration options alphabetically. 2022-01-12 14:01:13 +01:00
Thomas Heartman
12e78663b0
Merge pull request #1260 from Unleash/rarruda-patch-1
Update ruby SDK capabilities
2022-01-12 10:56:19 +01:00
Thomas Heartman
5896b65087
Merge pull request #1259 from Unleash/docs/sort-sdks-sidebar
docs: sort SDKs sidebar
2022-01-12 10:55:54 +01:00
Renato Arruda
4de960188a
Update ruby SDK capabilities
Ruby sdk now supports remote_address strategy with CIDR syntax

Feature can be found in main branch, not in a release yet.
2022-01-11 22:44:14 +01:00
Thomas Heartman
6944688671
Merge pull request #1249 from Unleash/docusaurusVersionBump
Upgrade docusaurus to 2.0.0.beta.14 from beta.9
2022-01-11 10:53:36 +01:00
Thomas Heartman
4917287098 fix(docs): fix broken links to addons 2022-01-11 10:43:34 +01:00
Thomas Heartman
29ed242df6 docs(fix): add missing commas 2022-01-11 10:38:22 +01:00
Thomas Heartman
adec5aa25c docs: add redirect from old integrations url 2022-01-11 10:36:23 +01:00
Thomas Heartman
c3c7e1b4bb docs: update link to integrations 2022-01-11 10:35:25 +01:00
Thomas Heartman
b2a8bc1655 docs: reorder sdks listing in sidebar
The previous list order didn't seem to have any reason behind it. This
is a suggestion for new order.

Index (the introduction) is first, followed by the proxy. Then comes
all the official sdks in alphabetic order (punctuation placed before
alpha). At the end of the list is the 'community sdks' link.

I'm open to suggestions and discussion here, but was working on this
list, so thought it could use some love.
2022-01-11 10:07:24 +01:00
Thomas Heartman
e1ba5f2e11 docs: reuse pre-existing redirect to /sdks 2022-01-11 09:53:06 +01:00
Thomas Heartman
eb89d4505d docs: add link to /sdks/community-sdks
This serves two purposes:
1. For people who know the structure, it won't look like anything's
missing
2. For people who don't know the structure, it'll make community sdks
more discoverable.
2022-01-11 09:22:30 +01:00
Thomas Heartman
f404c37f97 docs(chore): Update headings, slight sdk doc restructure. 2022-01-11 09:17:07 +01:00
Thomas Heartman
2488124ac6 docs(chore): add redirect from '/sdks/community' to '/sdks' 2022-01-11 09:17:07 +01:00
Thomas Heartman
d2369b5a69 docs(chore): sort SDK lists alphabetically 2022-01-10 15:00:10 +01:00
Thomas Heartman
d785b25a80 docs(chore): move Rust sdk from community to official listing
Also sorts the list of SDKs by name.
2022-01-10 14:56:43 +01:00
Thomas Heartman
c3d78bc028 docs: delete /sdks/community page
This page was more or less a duplicate of the final section of the
SDK overview. I've moved the section on implementing your own SDK into
the SDK overview instead.
2022-01-10 14:53:41 +01:00
Thomas Heartman
53001a47f8 docs: update steps to edit roles. 2022-01-10 14:38:03 +01:00
Renovate Bot
145a587d62 fix(deps): update dependency @svgr/webpack to v6.2.0 2022-01-10 11:39:38 +00:00
Christopher Kolstad
76d590d009
Upgrade docusaurus to 2.0.0.beta.14 from beta.9 2022-01-10 11:39:55 +01:00
Renato Arruda
c85c710327
Update the default metrics interval for Ruby SDK (#1247)
Note that the new metrics interval (60s) is only in master and a release with the new value is not yet created.
2022-01-08 11:51:19 +01:00
Thomas Heartman
eb08fb4c89 docs: improve wording of how-to for cprs. 2022-01-07 13:45:12 +01:00
Thomas Heartman
3fd31ced01 docs: first draft basic how-to for creating/assigning cprs 2022-01-07 12:08:55 +01:00
Thomas Heartman
575ad1093e docs: add dummy how-to; link from reference docs 2022-01-07 11:49:33 +01:00
Thomas Heartman
5573af675e docs: restructure startup import section to group actions by intent
This groups ways of importing together and ways of dropping together
instead of grouping the instructions by whether they use env variables
or command line options.

Should (?) make it easier to find what you want, but most importantly:
means we only need to explain the database drops once.
2022-01-07 08:03:49 +01:00
Thomas Heartman
5566d33e23 docs: add info on variants to project permissions. 2022-01-06 15:03:45 +01:00
Thomas Heartman
72fc329d15 docs: explain what the project and env permissions mean for CPR 2022-01-06 14:44:18 +01:00
Thomas Heartman
ccc46ab832 docs: revamp the rbac article; add roles table, describe CPR. 2022-01-06 14:26:04 +01:00
Thomas Heartman
45fe483924 docs: add placeholder how-to-guide for custom project roles 2022-01-06 12:34:20 +01:00
Thomas Heartman
cc6d073bb5 docs: update version tag for when CPR* is expected to be released
* custom project roles
2022-01-06 12:33:33 +01:00
Thomas Heartman
fd3333bfeb docs: add initial stub for custom project roles to rbac article. 2022-01-06 11:22:11 +01:00
Thomas Heartman
72bbcaf517 docs: change wording slightly. 2022-01-06 10:57:39 +01:00
Thomas Heartman
70b9a2d37e docs: add information on using env vars for startup imports. 2022-01-06 10:54:31 +01:00
Thomas Heartman
d027c0ed7b docs: add difference between initApiTokens and env var option. 2022-01-05 11:30:04 +01:00
Thomas Heartman
e73f3c6aa7 docs(fix): add description of open-source authentication type. 2022-01-05 11:21:55 +01:00
Ivar Conradi Østhus
66d4aa61de
fix: correct format for API tokens 2022-01-05 10:40:22 +01:00
Ivar Conradi Østhus
ce1cc8f3a8
doc: minor language improvements 2022-01-05 10:23:16 +01:00
Juraj Malenica
e757c00840
feat: Add init api tokens option (#1181)
Adds support for initializing a fresh Unleash instance with predefined API tokens. 

Co-authored-by: sighphyre <liquidwicked64@gmail.com>
Co-authored-by: Juraj Malenica <juraj.malenica@mindsmiths.com>
Co-authored-by: Ivar Conradi Østhus <ivarconr@gmail.com>
2022-01-05 10:00:59 +01:00
renovate[bot]
e1139a4847
fix(deps): pin dependency @docusaurus/remark-plugin-npm2yarn to 2.0.0-beta.14 (#1224)
Co-authored-by: Renovate Bot <bot@renovateapp.com>
2022-01-04 16:06:48 +01:00
Thomas Heartman
be3452e36f
Merge pull request #1221 from Unleash/docs/add-npm2yarn
docs: add `npm2yarn` annotation to all npm commands
2022-01-04 14:00:43 +01:00
Thomas Heartman
1241827b6a docs(chore): remove spacing, change 'node' -> Node.js 2022-01-04 10:19:32 +01:00
Thomas Heartman
7444b2cb74 docs(chore): add npm2yarn annotation to all npm commands 2022-01-04 10:18:13 +01:00
Thomas Heartman
0344dc79e4 docs(typo): pluralize SDK -> SDKs 2022-01-03 14:42:59 +01:00
Thomas Heartman
5a30706150 docs(fix): fix comparison operator from > to < 2022-01-03 13:08:25 +01:00
Thomas Heartman
dd975ec344 docs: highlight customStrategies option. 2022-01-03 10:26:29 +01:00
Thomas Heartman
bdbd659a71 docs(chore): indent code block properly. 2022-01-03 10:19:04 +01:00
Thomas Heartman
8ae2de8a3e docs: add steps for running the proxy in node with custom strats. 2022-01-03 10:12:13 +01:00
Anton Vasin
8bc9264e4a Fix typo in Webhook docs 2021-12-24 14:18:43 +01:00
Youssef Khedher
903917c06a
Merge pull request #1205 from Unleash/docs/proxy-and-custom-strategies
docs: Add more docs on custom strategies and the proxy
2021-12-24 11:40:31 +01:00
Ivar Conradi Østhus
f730d0d450
chore: correct compatibility matrix for server SDKs 2021-12-23 21:31:49 +01:00
Thomas Heartman
14081c014e chore(workflows): update with new branch names 2021-12-23 14:12:19 +01:00
Thomas Heartman
e63c855497 chore: format table 2021-12-23 11:42:57 +01:00
Thomas Heartman
37387bc3d1 docs(strats): update param type overview 2021-12-23 11:42:34 +01:00
Thomas Heartman
68df8e50f8 docs(strats): mention required params 2021-12-23 11:26:18 +01:00
Thomas Heartman
b83a45fc59 fix(docs): realign indentation of code and comments
Seems something went wrong the last time 🤷
2021-12-22 14:21:04 +01:00
Thomas Heartman
120345953a fix(docs): align code and highlight indentation. 2021-12-22 14:20:07 +01:00
Thomas Heartman
2b08b6f67b docs(strats): describe using custom strats when proxy is not docker. 2021-12-22 13:24:22 +01:00
Thomas Heartman
4d63ed01a8 fix: fix broken link to how-to guide. 2021-12-22 13:24:14 +01:00
Thomas Heartman
0892b1aca0 docs(custom strats): add note to proxy docs about custom strats. 2021-12-22 13:23:34 +01:00
Thomas Heartman
30c6e7c0af docs(custom strats): add steps for custom strats with proxy. 2021-12-22 12:37:40 +01:00
Thomas Heartman
d60dcfa9d4 docs(strats): start filling in how-to for custom strats 2021-12-22 11:36:08 +01:00
Thomas Heartman
adc429c90c docs(strats): semi-scaffold how-to section 2021-12-22 09:59:35 +01:00
Thomas Heartman
6d7fabb4c3 docs(activation strats): add note about unimplemented strats. 2021-12-22 09:59:35 +01:00
Thomas Heartman
9791783be5 docs(strats): separate reference and how-to 2021-12-22 09:59:32 +01:00
Thomas Heartman
caa5ae15c1 docs(custom strats): adjust heading levels, add ideas. 2021-12-22 09:58:50 +01:00
Thomas Heartman
daeb73af48 chore: remove unnecessary escape sequences. 2021-12-22 09:58:50 +01:00
Thomas Heartman
73b05ec415
Merge pull request #1200 from Unleash/docs/unleash-context
docs: Flesh out Unleash Context, Strategy constraints, add how-to guides for both
2021-12-22 09:50:03 +01:00
Thomas Heartman
4585efc036 docs(context): update availability notes for custom context fields. 2021-12-20 15:20:57 +01:00
Thomas Heartman
ffb8e09246 docs(constraints): update how-to doc title for strat constraints. 2021-12-20 14:55:38 +01:00
Thomas Heartman
4f4c092147 docs(context): add link to how-to guide for strat constraints. 2021-12-20 14:51:32 +01:00
Thomas Heartman
8d350f447c docs(context): update strat constraints with SDK info.
I'm not entirely sure this is the place to put this section, but it
works for now. It should probably be a separate how-to in the end.
2021-12-20 14:39:09 +01:00
Thomas Heartman
d2981d7b51 docs(context): add note about creating standard context fields. 2021-12-20 14:28:20 +01:00
Thomas Heartman
498ac4ff6d docs(context): spilt strat constraints into ref and how-to. 2021-12-20 14:28:00 +01:00
Thomas Heartman
1c5d48ec93 docs(context): add note to context docs re: creating and updating. 2021-12-20 13:07:33 +01:00
Thomas Heartman
429426d793 docs(context): full draft for how to create custom context fields. 2021-12-20 13:06:32 +01:00
Thomas Heartman
6b7f4f3544 docs(context): rough draft of how to create custom context fields. 2021-12-20 12:54:59 +01:00
Thomas Heartman
9a06899ce6 docs(fix): reference the SDK compat table in stickiness docs 2021-12-20 12:54:35 +01:00
Thomas Heartman
41035358b7 docs(context): add img of legal values' effect on the UI. 2021-12-20 12:53:41 +01:00
Thomas Heartman
404a5bd390 docs(context): add custom stickiness section to context docs. 2021-12-20 11:25:47 +01:00
Thomas Heartman
ae885b3eff docs(fix): fix quickstart image not being displayed.
The issue was that the image link was encased in an extra set of
brackets. However, the extra bracket set was added because docusaurus
wouldn't compile otherwise. Instead it complained about an
unterminated string literal in the alt text.

As it turns out, this had nothing to do with the contents of the alt
text, but rather with the fact that the alt text was split over
multiple lines.
2021-12-20 08:36:57 +01:00
Thomas Heartman
2431cf8e22 docs(context): add note about custom stickiness being in beta. 2021-12-20 08:29:27 +01:00
Thomas Heartman
2cc309fec9 docs(context): add custom stickiness header. 2021-12-17 14:03:42 +01:00
Thomas Heartman
e1d1ee2718 docs(context): Update doc; add how-to make custom context fields. 2021-12-17 14:03:42 +01:00
Thomas Heartman
291e8689fb docs(sdks): gradual rollout: custom stickiness -> point to SDK table
It appears that we've forgotten to update this bit of info regarding
the SDKs' compatibility. To avoid having the same data in multiple
places, let's instead point the user to the compat table.
2021-12-17 13:46:54 +01:00
Renato Arruda
018675ad34 Update status of Ruby SDK after release 4.0.0 2021-12-16 22:07:35 +01:00
Thomas Heartman
e061ccccb4
Merge pull request #1186 from Unleash/docs/4.3-minor-updates
docs: update existing articles and screenshots to match version 4.3
2021-12-15 10:58:54 +01:00
Thomas Heartman
9a370cb25c
Merge pull request #1185 from Unleash/docs/4.3-update-strat-constraints
docs: update strategy constraints for 4.3
2021-12-15 10:56:21 +01:00
Thomas Heartman
aa80cba222 chore: lowercase <br/> tag
Don't know why it got uppercased 🤷
2021-12-15 10:27:11 +01:00
Thomas Heartman
5b97ef6996 chore: unhyphenate kebab-menu -> kebab menu 2021-12-15 10:23:52 +01:00
Thomas Heartman
7a0e9aaf63
Apply suggestions from code review: missing comma
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
2021-12-15 10:22:41 +01:00
Thomas Heartman
5653331eea docs(4.3): update tech debt section. 2021-12-14 14:23:39 +01:00
Thomas Heartman
d59d2f141e docs(4.3): update the custom strategy documentation. 2021-12-14 14:13:24 +01:00
Thomas Heartman
74aa185392 docs(4.3): update control-rollout document. 2021-12-14 14:03:28 +01:00
Thomas Heartman
18da69ede0 docs(4.3): update text (and add alt text) in projects document. 2021-12-14 13:47:47 +01:00
Thomas Heartman
23d06264a1 docs(4.3): update project images. 2021-12-14 13:30:06 +01:00
Thomas Heartman
cfeef6b4ba docs(4.3): update environments section. 2021-12-14 12:33:29 +01:00
Thomas Heartman
c9ef7c1f44 docs(4.3): update API access document. 2021-12-14 12:19:19 +01:00
Thomas Heartman
bfeb19f5f1 docs(4.3): update audit log chapter. 2021-12-14 12:10:04 +01:00
Thomas Heartman
c0b5f27a3c docs(4.3): Update archive page. 2021-12-14 11:52:57 +01:00
Thomas Heartman
de420dde14 docs(4.3): update variants screenshot 2021-12-14 11:30:59 +01:00
Thomas Heartman
915be4c2ed docs(4.3): update strategy constraints documentation. 2021-12-14 11:19:16 +01:00
Thomas Heartman
b86ffb9bc9
Merge pull request #1172 from Unleash/docs/a-b-testing-discussion
docs: Add topic guide for A/B testing
2021-12-13 13:18:40 +01:00
Thomas Heartman
23dafcb230 docs(4.3): delete env strat constraint image, rewrite paragraph. 2021-12-13 12:44:11 +01:00
Thomas Heartman
ead86ed621 docs(a/b-testing): rename 'concepts' -> 'topics' 2021-12-13 12:33:47 +01:00
Renovate Bot
ba6ed24e18 fix(deps): update dependency @svgr/webpack to v6.1.2 2021-12-12 18:16:19 +00:00
Thomas Heartman
2b0941a6fb docs(compat): link to sdks in table headers, use human strat names. 2021-12-10 15:17:34 +01:00
Thomas Heartman
d65703f860 docs(compat): center icons in table 2021-12-10 14:03:11 +01:00
Thomas Heartman
49e6323a1a
Apply suggestions from code review
Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2021-12-10 13:53:49 +01:00
Thomas Heartman
0722e8a24b docs(compat): add .net gradual rollout custom stickiness 2021-12-09 13:56:28 +01:00
Thomas Heartman
93685a4e86 docs(compat): add slack link to text 2021-12-09 13:54:06 +01:00
Thomas Heartman
0b51a69ae3 chore: format compat table. 2021-12-09 13:47:33 +01:00
Thomas Heartman
9cc9996c06 docs(compat): Add links to concepts in table. 2021-12-09 13:41:56 +01:00
Thomas Heartman
828468dfe5 docs(compat): Flesh out descriptions 2021-12-09 13:33:30 +01:00
Thomas Heartman
abc07ae73f docs(compat): add a first iteration of the compatibility table. 2021-12-09 13:14:20 +01:00
Thomas Heartman
e4d0c4fb50 docs(variants): rename 'discussion' -> 'concepts' 2021-12-09 12:07:25 +01:00
Thomas Heartman
735b8996a1 docs(variants): rename A/B testing file 2021-12-09 12:02:37 +01:00
Thomas Heartman
19ae282e09 docs(variants): first draft of a/b testing discussion 2021-12-09 12:01:12 +01:00
Thomas Heartman
9e7f48931a docs(variants): add discussion topic on a/b testing 2021-12-09 11:34:02 +01:00
Thomas Heartman
2fa5b3c0a8
Merge pull request #1167 from Unleash/docs/variant-reference-docs
docs: Improved reference docs for variants
2021-12-08 11:03:06 +01:00
Thomas Heartman
15c5997707 docs(variants): clarify weight distribution 2021-12-08 10:35:52 +01:00
Thomas Heartman
aef303c3b9
Apply suggestions from code review
Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2021-12-08 10:30:21 +01:00
Thomas Heartman
a761bf2cc7 docs(variants): conflicting overrides; rm usage 2021-12-08 10:08:35 +01:00
Thomas Heartman
b5b8c5eb2d docs(variants): stickiness, disabled variant. 2021-12-07 14:26:42 +01:00
Thomas Heartman
16c32552d5 docs: add some first info on overrides. 2021-12-07 14:02:15 +01:00
Thomas Heartman
80afb25999 docs: document variant payloads. 2021-12-07 13:53:19 +01:00
Thomas Heartman
69005af33e docs: finish variant weight reference documentation 2021-12-07 13:43:57 +01:00
Thomas Heartman
4b6f166e95 docs: start documenting variant properties and weights 2021-12-07 13:32:11 +01:00
Ivar Conradi Østhus
642a2371ef fix: updated API docs to reflect v4.3 2021-12-06 15:31:50 +01:00
Thomas Heartman
b595277204 chore: (docs) keep list styling (internally) consistent 2021-12-06 14:08:25 +01:00
Thomas Heartman
815fc353ec
Apply suggestions from code review
Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2021-12-06 14:06:14 +01:00
Thomas Heartman
acedb240ca docs: iOS proxy: add info about client keys and environments. 2021-12-06 13:24:59 +01:00
Thomas Heartman
b46afd8887 docs: react proxy sdk: explain clientKey and other config vars. 2021-12-06 13:16:54 +01:00
Thomas Heartman
d936a0d4ed docs: Android SDK: reformat and add more details on client secrets 2021-12-06 12:59:32 +01:00
Thomas Heartman
a03e7927bb docs: JS proxy client: explain client keys 2021-12-06 12:58:17 +01:00
Thomas Heartman
24bf9b7012 docs: explain what the proxy configuration variables are. 2021-12-06 12:35:49 +01:00
Thomas Heartman
dd08e9da38 chore: Fix syntax highlighting for a json code snippet. 2021-12-06 12:35:45 +01:00
Renovate Bot
1c7229bee6 fix(deps): update dependency @svgr/webpack to v6.1.1 2021-12-05 00:01:26 +00:00
renovate[bot]
e1a68a6c60
fix(deps): update dependency @svgr/webpack to v6 (#1136)
Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-12-03 12:47:53 +01:00
Thomas Heartman
df74d29f1e docs: adjust variant outline; add rough ideas. 2021-12-01 10:35:05 +01:00
Thomas Heartman
f83ffb6746
Merge pull request #1144 from Unleash/docs/document-proxy-payload-format
docs: describe the shape of the data returned by the Unleash proxy
2021-12-01 09:24:24 +01:00
Thomas Heartman
e41d6b0f4d docs: describe the shape of the data returned by the Unleash proxy
This commit attempts to explain what the proxy returns in more detail,
explaining how payloads work and what the `enabled` properties mean
and how they relate to the rest of the content.
2021-11-30 12:52:46 +01:00
Thomas Heartman
2898b77dd6 docs: Add section on (potentially) stale toggles to tech debt
Previously, when you searched for 'stale toggle' in the docs, the
first result would be the API docs and it'd be hard to find any form
of explanation of what a stale toggle is at all.

To combat that, this commit adds a section to the tech debt chapter
explaining what they are.
2021-11-29 14:55:50 +01:00
Thomas Heartman
736faaca5b
docs: typo; change "metics" -> "metrics" 2021-11-29 08:40:59 +01:00
Thomas Heartman
1af8b23149 docs: remove references to environments being a beta feature.
Also specify that if you're on version 4.3, you don't need to do anything.
2021-11-26 13:53:46 +01:00
Thomas Heartman
1837a6ec35 docs: add environments post to side bar. 2021-11-26 13:53:32 +01:00
Thomas Heartman
7bfe306545
Merge branch 'master' into docs/detail-health-rating-updates 2021-11-26 11:07:48 +01:00
Thomas Heartman
1ac46ec3c1 docs: Clarify that health rating is only updated once an hour.
This commit also gives health rating its own, separate headline. This
should improve searchability 🤞
2021-11-25 10:45:47 +01:00
Thomas Heartman
c5129e00d7
Merge branch 'master' into docs/fix-internal-links 2021-11-25 09:10:57 +01:00
Thomas Heartman
e8478126a5
Merge branch 'master' into docs/add-stickiness 2021-11-24 13:59:56 +01:00
Thomas Heartman
42b1f44d84 docs: add note about Unleash using MurmurHash for stickiness. 2021-11-24 13:41:25 +01:00
Thomas Heartman
d58ed5f84b
Apply suggestions from code review
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
2021-11-24 13:39:02 +01:00
Christopher Kolstad
6c6001619c
Feat/variant api (#1119)
Add a new .../:feature/variants API

This adds
- `GET /api/admin/projects/:projectId/features/:featureName/variants` which returns 
```json
{ version: '1', variants: IVariant[] }
```
- `PATCH /api/admin/projects/:projectId/features/:featureName/variants` which accepts a json patch set and updates the feature's variants field and then returns 
```json
{ version: '1', variants: IVariant[] }
```
- `PUT /api/admin/projects/:projectId/features/:featureName/variants`
 which accepts a IVariant[] and overwrites the current variants list for the feature defined in :featureName and returns
```json
{ version: '1', variants: IVariant[] }

- This also makes sure the total weight of all variants is == 1000
- Validates that there is at least 1 'variable' variant if there are variants
- Validates that 'fix' variants total weight can't exceed 1000
- Adds tests for all these invariants.


Co-authored-by: Simon Hornby <simon@getunleash.ai>
2021-11-24 13:08:04 +01:00
Thomas Heartman
8b50696e99 docs: use internal links for linking to other doc pages. 2021-11-24 13:02:06 +01:00
Thomas Heartman
c077860d54 docs: Remove link to non-existing page about sdk capabilities. 2021-11-24 12:04:33 +01:00
Thomas Heartman
9c0848b053 docs: fix links to old versions of pages; link to new versions. 2021-11-24 12:03:31 +01:00