Commit Graph

87 Commits

Author SHA1 Message Date
Thomas Heartman a6753d9af3 docs: switch all slack links to slack.unleash.run (#1613) 2022-05-20 08:17:36 +02:00
Thomas Heartman 68bad77a84 docs: Update Unleash architecture diagram (#1549)
* docs: Update Unleash architecture digram

* fix: typo an -> a

* docs(fix): fix img link in readme

* docs: update architecture graph
2022-05-06 11:17:35 +02:00
Thomas Heartman 05f4cbb708 docs(fix): change the remoteAddress description (#1539)
remoteAddress previously used the sessionId description.
2022-04-28 16:20:28 +02:00
Ivar Conradi Østhus 55e43b033d docs: correct secrets key 2022-04-11 22:32:58 +02:00
Ivar Conradi Østhus 947d9fc40c docs: correct proxy url to demo instance 2022-04-11 22:23:22 +02:00
Thomas Heartman 613ee550bc docs: merge currentTime with "advanced constraints" row 2022-03-09 11:55:21 +01:00
Thomas Heartman c0eac49313 fix: delete empty table row 2022-03-08 13:34:11 +01:00
Thomas Heartman 419dda09a0 docs: Update description of currentTime in the Unleash context. 2022-03-08 13:31:55 +01:00
Thomas Heartman 4ce4a9c2d6 docs: remove 'introduced in' column in Unleash Context table. 2022-03-08 11:22:24 +01:00
Thomas Heartman 94f13075ac docs: add unleash context and compat table updates 2022-03-08 11:14:55 +01:00
Thomas Heartman c63c9b6fab docs: minor rewording and clarification around strategy impl/eval 2022-03-07 11:11:51 +01:00
Thomas Heartman 6a4e2b7163 fix: change : to , 2022-03-04 13:04:40 +01:00
Thomas Heartman f35a932e8d fix: stitch the info paragraph together with the existing content 2022-03-04 13:02:06 +01:00
Thomas Heartman cda31e46d3 fix: remove unintended line break. 2022-03-04 12:56:55 +01:00
Thomas Heartman 9b691a4f89 fix: fix broken link custom activation strategies doc. 2022-03-04 12:43:58 +01:00
Thomas Heartman 28b16d922d docs: reword and add additional deets re: activation strategy impl 2022-03-04 12:41:13 +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
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 1bba30a3de docs: fix link to getting started page 2022-02-01 14:49:55 +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
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 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 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
Thomas Heartman 184a18ba41 Merge branch 'master' into chore/update-workflows 2022-01-18 11:16:24 +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 308f5ab4d3 docs: add new cpr permissions, update existing ones 2022-01-14 08:23:17 +01:00
Thomas Heartman 575ad1093e docs: add dummy how-to; link from reference docs 2022-01-07 11:49:33 +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 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 14081c014e chore(workflows): update with new branch names 2021-12-23 14:12:19 +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 1c5d48ec93 docs(context): add note to context docs re: creating and updating. 2021-12-20 13:07:33 +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