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

288 Commits

Author SHA1 Message Date
Thomas Heartman
304e95f9d7 docs: add working offline section to the SDKs doc 2022-03-04 13:37:59 +01:00
Thomas Heartman
28df5dcb31 docs: add offline headings / rough skeleton 2022-03-04 12:56:16 +01:00
Thomas Heartman
c15cbfc6d3
Merge pull request #1319 from Unleash/docs/describe-project-users-endpoints
docs: describe `/api/admin/projects/:projectId/users/:userId/roles/:roleId` endpoint
2022-03-04 12:10:11 +01:00
Thomas Heartman
cf2a8de161
Merge pull request #1342 from Unleash/docs/user-admin-send-email-props
docs: Add payload properties for user-admin post payload
2022-03-04 12:10:02 +01:00
Thomas Heartman
4705fe22cc docs: remove error payload that no longer applies. 2022-03-04 10:41:52 +01:00
Thomas Heartman
6d433c50ab docs: add info about requiring name OR email 2022-03-04 10:36:40 +01:00
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
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
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