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
