1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
Commit Graph

468 Commits

Author SHA1 Message Date
Thomas Heartman
d0c4eb2637 docs: Add cURL command to ApiRequest component. 2022-02-10 15:33:08 +01:00
Thomas Heartman
1eb4ae99ec docs: Clarify placeholder info. 2022-02-09 16:06:05 +01:00
Thomas Heartman
31b3792a11 docs: Add steps to enable impression events for existing toggles. 2022-02-09 16:03:32 +01:00
Thomas Heartman
752a1df343 docs: Add API request component: display in http and httpie easy!
The ApiRequest component is created to make it easier to show code
samples for API requests. It shows them in raw HTTP form and with
HTTPie for now.
2022-02-09 15:54:16 +01:00
Thomas Heartman
323b9e4247 docs: Add more outlines, steps, etc to how-to impression data 2022-02-09 14:20:24 +01:00
Thomas Heartman
a48d6af7e4 fix: fix google analytics link 2022-02-09 14:20:24 +01:00
Thomas Heartman
6ee9a4326c docs: Add impression data guide outline and sidebar entry 2022-02-09 14:20:24 +01:00
Thomas Heartman
fe69c1d9ef docs(chore): Use ifm variable for border width. 2022-02-09 13:44:58 +01:00
Thomas Heartman
0b69e1751e chore: remove trailing full stop. 2022-02-09 13:44:58 +01:00
Thomas Heartman
986d628faa docs(a11y): fix issues with transparent pngs; add borders, centering 2022-02-09 13:44:58 +01:00
Thomas Heartman
3e1500625a docs(chore): remove 'documentation' link in na bar. 2022-02-09 13:44:58 +01:00
Thomas Heartman
d0023f615b docs(a11y): use a purple color for primary theme color 2022-02-09 13:44:58 +01:00
Thomas Heartman
7ee4e12a05 docs(a11y): dark mode fix contrast in sidebar and with vid comp
This commit introduces a new primary color gradient palette to replace the
dark / mossy green that we use in the light theme. It's got a very
small range, so we should probably expand on it in the future, but for
now it'll do a _lot_ better than it did previously.
2022-02-09 13:44:58 +01:00
Thomas Heartman
52e85ab555 docs(a11y): move light-specific theme changes to 'light-theme' css 2022-02-09 13:44:58 +01:00
Thomas Heartman
f7301ef937 docs(a11y): fix contrast issues with dark theme link color.
New contrast is 7.99 (AAA).
2022-02-09 13:44:58 +01:00
Thomas Heartman
4754d203e4
Merge pull request #1344 from Unleash/docs/change-api-how-tos-sidebar-title
docs: change API how-tos label from "API" to "Using the APIs"
2022-02-09 12:15:26 +01:00
Thomas Heartman
5a220caf39 docs: Add payload properties for user-admin post payload
Adds an explanation of what the various properties in the payload
object to the `user-admin` endpoint does. Most seem fairly
self-explanatory, but I'm not entirely sure what `sendEmail` does.

Requires validation by a third party before merging.
2022-02-09 09:05:24 +01:00
Ivar Conradi Østhus
1487ae10c6
docs: update compatibility matrix 2022-02-08 20:57:06 +01:00
Ivar Conradi Østhus
609422071f
docs: add "sendEmail" field to user-admin.md (#1329) 2022-02-08 20:47:01 +01:00
Christopher Kolstad
b0edddb283
fix: typo (#1346) 2022-02-08 14:57:52 +01:00
Thomas Heartman
ea930cd315 docs: change API how-tos label from "API" to "API how-tos"
I keep getting confused and clicking the link to the how-to guides
when I wanna go to the API reference docs and I _wrote_ the damn thing
🙈 In other words, I betcha someone else is struggling with the same
thing.

So let's try and change it to something that's harder to click by mistake.
2022-02-08 13:19:55 +01:00
Fredrik Strand Oseberg
acb98db00f
docs: add docs for impression data (#1328)
* docs: add docs for impression data

* fix: update wording

* Update website/docs/advanced/impression_data.md

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>

* Update website/docs/advanced/impression_data.md

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>

* docs: use hyphen instead of underscore in file name and title/slug

We've been very inconsistent with our use of separators previously
(we should try and find a standard). Hyphens are most common online,
so I've switched to that instead.

* docs: use syntax highlighting for shell commands

* docs: start outlining impression data restructure.

* docs: Add impression data info to API: create toggles

* docs: Add impression data row to compatibility matrix

* docs: restructures the impression data reference doc.

* chore: remove question callout in source material

* docs: add redirect for `impression_data` -> 'impression-data'

* docs: Add sdk availability to availability note

* chore: Fix broken doc paths.

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-02-08 12:11:08 +01:00
Thomas Heartman
de2e2ae934
Merge pull request #1338 from Unleash/docs/hide-back-to-main-menu
docs: hide 'back-to-main-menu' entry in narrow menu
2022-02-08 08:00:35 +01:00
Thomas Heartman
962928501d docs: hide 'back-to-main-menu' entry in narrow menu
This hides the 'back to main menu' button from the narrowed site menu.
There is no main menu to speak of, so having it take you back to
'unleash enterprise' and the GitHub icon seems unnecessary.
2022-02-07 13:54:52 +01:00
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