1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-28 00:06:53 +01:00
Commit Graph

335 Commits

Author SHA1 Message Date
Thomas Heartman
c9dd60e1ea
Apply suggestions from code review
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
2022-03-04 08:43:28 +01:00
Thomas Heartman
e6d939508d fix: correct the description of disabled variants 2022-03-04 08:20:55 +01:00
Thomas Heartman
4c4f6a3aaa docs: update description of sendEmail option 2022-03-03 15:24:15 +01:00
Thomas Heartman
38ed3816a8 docs: Remove doubled section and clarify role removal 2022-03-03 14:17:43 +01:00
Thomas Heartman
9da796eb90 docs: add details for change role endpoint. 2022-03-03 09:25:22 +01:00
Thomas Heartman
e84b8f30e1 docs: add correct return values for role deletion endpoints. 2022-03-03 09:25:22 +01:00
Thomas Heartman
92349b5561 Apply suggestions from code review
Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
2022-03-03 09:25:22 +01:00
Thomas Heartman
81c6ef2d6e chore: align url parameters table. 2022-03-03 09:25:22 +01:00
Thomas Heartman
01f7293e2e docs: add description of the project users/roles endpoint 2022-03-03 09:25:20 +01:00
Thomas Heartman
f92d86061a docs(chore): improve syntax highlighting and formatting of code bits
Use `bash` instead of `sh` for nicer highlighting by prism.

I've also broken large json blobs over multiple lines.
2022-03-03 09:24:43 +01:00
sighphyre
010a699a19
Update website/docs/deploy/configuring-unleash.md
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-03-02 14:09:50 +02:00
sighphyre
6de5fdb565 feat: allow startup to load client tokens from env var 2022-03-02 13:44:46 +02:00
Thomas Heartman
3302e66ab1 docs: remove "future enhancements" section of environments doc
These things are either implemented or just around the corner now. I
suggest removing them to not be misleading anymore. Case in point: we
just had a customer asking us when the permissions system would be
ready because the docs say it's planned as a future improvement.
2022-02-25 09:10:22 +01:00
sighphyre
c2b946bf28
Merge pull request #1381 from Unleash/docs/update-compat-table-for-constraints
docs: Advanced constraints compatibility
2022-02-24 11:36:38 +02:00
sighphyre
a7fa3f703d docs: update docs for Go SDK because wait until initialized already exists 2022-02-23 15:30:13 +02:00
sighphyre
435f64ad22 docs: mark PHP as advanced constraint compatible in compatibility table 2022-02-23 12:29:30 +02:00
sighphyre
5487fca318 docs: add in compatibility table entry for advanced constraints 2022-02-21 13:59:45 +02:00
Ivar Conradi Østhus
9f6b414e09
docs: correct unleash proxy sdk docs 2022-02-21 10:45:05 +01:00
Dominik Chrastecky
81e0b6c402 docs: update php compatibility matrix table 2022-02-18 20:12:19 +01:00
Thomas Heartman
c19278e8e8
Merge pull request #1376 from Unleash/docs/add-how-to-video-for-impression-data
docs: Add how-to video for impression data
2022-02-18 10:01:52 +01:00
Thomas Heartman
7c70dffd5b fix: add missing word 2022-02-17 10:32:34 +01:00
Thomas Heartman
f5c7f3a320 docs: Add how-to video for impression data
This change adds a video to the impression data how-to guide
2022-02-17 10:30:26 +01:00
Renato Arruda
50cbc78cd8
(docs) Ruby SDK now has a bootstrap impl 2022-02-17 07:58:52 +01:00
Thomas Heartman
c63d552576
Merge pull request #1345 from Unleash/docs/impression-data-how-to
docs: Add "How to send impression data to your third-party sink" guide
2022-02-11 12:36:53 +01:00
Thomas Heartman
ea7d599bad chore: add missing comma 2022-02-11 11:56:16 +01:00
Thomas Heartman
ebcab898e7 docs: Reference impression data from A/B testing doc
Mention impression data in the A/B discussion topic.
2022-02-10 16:35:29 +01:00
Thomas Heartman
e114025967 docs: reference A/B testing doc from impression data how-to 2022-02-10 16:26:57 +01:00
Thomas Heartman
812aa5c64c docs: reference how-to impression data from ref impression data 2022-02-10 16:26:44 +01:00
Thomas Heartman
9998e4cd63 chore: rename impression data how-to 2022-02-10 15:55:25 +01:00
Thomas Heartman
845168385b docs: Finish initial draft of how-to guide 2022-02-10 15:53:51 +01:00
Thomas Heartman
b56f809fb8 docs: rename file extension from .md to .mdx 2022-02-10 15:34:19 +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
0b69e1751e chore: remove trailing full stop. 2022-02-09 13:44:58 +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
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
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
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
0073de000e docs: remove redundant video heading and commented-out content. 2022-01-27 13:19:55 +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
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
1a399fcabc docs: add video content component (to be moved) 2022-01-26 13:52:17 +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
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
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
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
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
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
4848104ec8 docs: move all docs into sidebar 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
19eea8b3a2 docs: rename doc introduction. 2022-01-25 12:21:00 +01:00
Thomas Heartman
24e614c977 docs: start restructuring the docs landing page. 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
184a18ba41
Merge branch 'master' into chore/update-workflows 2022-01-18 11:16:24 +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
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
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