Commit Graph

67 Commits

Author SHA1 Message Date
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
Thomas Heartman 2431cf8e22 docs(context): add note about custom stickiness being in beta. 2021-12-20 08:29:27 +01:00
Thomas Heartman 2cc309fec9 docs(context): add custom stickiness header. 2021-12-17 14:03:42 +01:00
Thomas Heartman e1d1ee2718 docs(context): Update doc; add how-to make custom context fields. 2021-12-17 14:03:42 +01:00
Thomas Heartman 291e8689fb docs(sdks): gradual rollout: custom stickiness -> point to SDK table
It appears that we've forgotten to update this bit of info regarding
the SDKs' compatibility. To avoid having the same data in multiple
places, let's instead point the user to the compat table.
2021-12-17 13:46:54 +01:00
Thomas Heartman 5b97ef6996 chore: unhyphenate kebab-menu -> kebab menu 2021-12-15 10:23:52 +01:00
Thomas Heartman 5653331eea docs(4.3): update tech debt section. 2021-12-14 14:23:39 +01:00
Thomas Heartman 74aa185392 docs(4.3): update control-rollout document. 2021-12-14 14:03:28 +01:00
Thomas Heartman 18da69ede0 docs(4.3): update text (and add alt text) in projects document. 2021-12-14 13:47:47 +01:00
Thomas Heartman cfeef6b4ba docs(4.3): update environments section. 2021-12-14 12:33:29 +01:00
Thomas Heartman dd08e9da38 chore: Fix syntax highlighting for a json code snippet. 2021-12-06 12:35:45 +01:00
Thomas Heartman 2898b77dd6 docs: Add section on (potentially) stale toggles to tech debt
Previously, when you searched for 'stale toggle' in the docs, the
first result would be the API docs and it'd be hard to find any form
of explanation of what a stale toggle is at all.

To combat that, this commit adds a section to the tech debt chapter
explaining what they are.
2021-11-29 14:55:50 +01:00
Thomas Heartman 736faaca5b docs: typo; change "metics" -> "metrics" 2021-11-29 08:40:59 +01:00
Thomas Heartman 1af8b23149 docs: remove references to environments being a beta feature.
Also specify that if you're on version 4.3, you don't need to do anything.
2021-11-26 13:53:46 +01:00
Thomas Heartman 7bfe306545 Merge branch 'master' into docs/detail-health-rating-updates 2021-11-26 11:07:48 +01:00
Thomas Heartman 1ac46ec3c1 docs: Clarify that health rating is only updated once an hour.
This commit also gives health rating its own, separate headline. This
should improve searchability 🤞
2021-11-25 10:45:47 +01:00
Thomas Heartman c5129e00d7 Merge branch 'master' into docs/fix-internal-links 2021-11-25 09:10:57 +01:00
Thomas Heartman e8478126a5 Merge branch 'master' into docs/add-stickiness 2021-11-24 13:59:56 +01:00
Thomas Heartman 8b50696e99 docs: use internal links for linking to other doc pages. 2021-11-24 13:02:06 +01:00
Thomas Heartman 6634d1d580 docs: fix a typo in activation strategies: use -> user 2021-11-24 11:52:27 +01:00
Thomas Heartman 7fe74c1358 docs: update reference to gradual rollout (was 'flexible rollout') 2021-11-24 10:48:02 +01:00