1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Commit Graph

108 Commits

Author SHA1 Message Date
NicolaeUnleash
51c7ea053e
docs: update images using latest UI screenshots (#1992)
* Update api_access_history.png

* updating images in - How to capture impression data

* Update Quickstart image

* Update images: How to add strategy constraints

* Update images: How to create a feature toggle

* Update images: How to define custom context fields

* Update images: How to use custom activation strategies

* Update images: How to schedule feature releases

* Update images: How to add new users to your Unleash instance

* Update images: How to create and assign custom project roles

* Update images: How to add SSO with OpenId Connect

* Update images: How to add SSO with SAML 2.0 Okta

* Update images: Slack

* Update images: Activation Strategies

* Update images: Archived toggles

* Update images: The audit log

* Update images: Impression data

* Update images: Custom Activation Strategies

* Update images: Environments

* Update images: Feature Toggle Types

* Update images: Feature Toggle Variants

* Update images: Projects

* Update images: Segments

* Update images: Stickiness

* Update images: Strategy Constraints

* Update images: Technical Debt

* Update images: Unleash Context

* Update images: Unleash introductory overview

* Update images: Unleash introductory overview

* docs: replace strategy constraints step 2 img

* Update website/docs/how-to/how-to-add-strategy-constraints.md

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

* change text request

* Updating docs text to match the screenshots

* Docs: change audit log to event log and add redirects

* Docs: update "archive" page with deletion info

* Docs: update constraints how to

* Docs: minor tech debt doc fixes

* docs-update-images-set1: update overview page

* Apply suggestions from code review

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

* Update website/docs/user_guide/quickstart.md

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

* Update website/docs/user_guide/user-management.md

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

* Update website/docs/user_guide/user-management.md

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

* Activation strategy update

* Apply suggestions from code review

* Update delete-archive img

* Fix prettier formatting for admonitions

* Update website/docs/user_guide/environments.md

* Update website/docs/user_guide/projects.md

Co-authored-by: Tymoteusz Czech <tymek+gpg@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-09-14 07:59:18 +00:00
Thomas Heartman
6516ac21ee
docs(#1873): Document the Unleash playground (#1901)
* Docs: start adding stuff for the playground docs

* docs(#1873): start filling in playground doc

* docs(#1873): draft 1

* docs(#1873): add playground images

* docs(#1873): typo (pr comment)

* docs(#1873): Add a sentence or two about stickiness

* docs(#1873): merge required and implicit fields

* docs(#1873): reduce cognitive complexity

* docs(#1873): add link to stickiness calculation section

* docs(#1873): add detailed results image

* docs(#1873): reword playground requirement env and proj
2022-08-12 12:17:25 +02:00
Thomas Heartman
9448461aaa
docs: prep to add OpenAPI spec to Unleash docs (#1907)
* Docs: start experimenting with OpenAPI and docusaurus

* Docs: add docusaurus-theme-openapi-docs pkg

* Wip: current status

* Docs: Add 'docusaurus-plugin-api-docs'

* Move openapi into own sidebar; generate from localhost

* Chore: Update docusaurus plugin for OpenAPI

* Add website/yarn.lock to git

* Fix: fix CSS warning by using flex-end instead of end

* docs: make openapi generated code work again

* docs: make tags work properly with openapi sidebar

* Docs/chore: update OpenAPI tag scheme.

Add a whole bunch of new tags to make it easier to understand
available tags in OpenAPI.

* docs: point to new openapi docs from old api docs

* docs: typo

* Docs:  link restructure

* docs: add operation indicators to openapi docs

* docs: change badge color for operations

* docs: update openapi-docs package

It now sorts tags the same as the schema

* docs: pluralize APIs in slug

* docs: update links to generated api docs

* docs: update openapi snapshot tests with new tags

* docs: conditionally load spec from localhost or from file

* docs: Remove changes relating to immediate switchover

* refactor: rename types; extract into separate file

* docs: fix api doc links
2022-08-12 11:37:57 +02:00
Thomas Heartman
22014f3c62
docs: add how-to guide for enabling OpenAPI (#1836)
* Docs: add how-to enable the openapi spec

* Docs: fix and format how to run unleash proxy

* Fix: add backticks instead of single quotes

* Docs: remove unnecessary imports, format

* Docs: fix minor errors and update location section
2022-07-22 09:02:01 +02:00
sighphyre
5806b6748f
Feat/grouping (#1845)
* Implement user grouping feature for permissions

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Jaanus Sellin <sellinjaanus@gmail.com>
Co-authored-by: Nuno Góis <github@nunogois.com>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-07-21 16:23:56 +02:00
Thomas Heartman
89d25c8634
docs: add proxy deployment diagrams (#1743)
* docs: remove empty table row

* docs: add placeholder proxy hosting article

* docs: add images, describe first one

* docs: describe the customer-hosted proxy solution

* docs: describe the self-hosted single-region setup.

* docs: describe enterprise multi-region setup.

* docs: minor changes

* docs: update lists; restructure

* docs: more minor changes

* docs: add alt text to diagrams

* docs: update proxy hosting doc

* docs: some prettier formatting

* docs: add link to proxy hosting doc

* docs: format proxy config table

* docs: prettier formatting
2022-06-23 08:28:01 +02:00
Thomas Heartman
5a3f418e13
docs: add feature toggle reference, new how-to (#1694)
* Docs: write down the currently available steps

* docs: quick updates to the projects page.

* docs: further scaffold the how-to guide

* docs: add feature-toggle.mdx (toggle reference doc)

* docs: Add note that feature toggle names must be unique

* docs: add API doc links

* docs: delete old content

* docs: delete old images

* docs: update variants text

* docs: update introduction

* docs: add new images, update api annotations

* docs: add links to context fields, improve link text for other links.

* docs: remove redundant wording.

* docs: fix default project for toggles

* docs: typo: singular -> plural

* docs: mention admin ui curl command

* docs: remove leftover words

* docs: improve linking to default project.

* Apply suggestions from code review

Co-authored-by: sighphyre <liquidwicked64@gmail.com>

* Apply suggestions from code review

Co-authored-by: sighphyre <liquidwicked64@gmail.com>

* docs: clarify constraint timing

* docs: apply suggestion from code review

* docs: add link to variants document

* docs: Add sections on environments and projects, link from ft docs

* docs: minor rewording into unleash context.

* docs: remove misleading section about "all strats evaluated"

* docs: evaluate -> resolve

Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-06-17 12:36:19 +02:00
Thomas Heartman
188352cb7a
docs: remove duplicate sidebar item; sort sdks (#1558)
* fix: remove duplicate sidebar entry

* fix: sort sdk list
2022-05-03 10:21:14 +02:00
Fredrik Strand Oseberg
e6495d9d26
docs: add docs for vue and svelte clients (#1541)
* docs: add docs for vue and svelte clients

* fix: update version for svelte
2022-04-28 15:33:38 +02:00
Thomas Heartman
88450a8946 docs: rename api token + client key doc 2022-04-13 13:46:12 +02:00
Thomas Heartman
07de36f6c4 docs: add api-tokens to sidebar 2022-04-12 16:02:16 +02:00
Thomas Heartman
c7fe197fbd docs: add new how-to category: Unleash Proxy 2022-04-12 16:00:05 +02:00
Thomas Heartman
3440b4f42a docs: add segments api placeholder 2022-04-01 15:47:00 +02:00
Thomas Heartman
e37714d61a docs: First draft of segments reference doc 2022-04-01 15:47:00 +02:00
Thomas Heartman
27a74ecf0d docs: create initial outline for how to schedule feature releases 2022-03-11 13:58:41 +01:00
Thomas Heartman
9998e4cd63 chore: rename impression data how-to 2022-02-10 15:55:25 +01:00
Thomas Heartman
6ee9a4326c docs: Add impression data guide outline and sidebar entry 2022-02-09 14:20:24 +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
26f66c4f93 fix(docs): remove test subcat from sidebar 2022-01-28 08:21:41 +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
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
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
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
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
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
b3c28de0bb docs: add introduction as separate entry 2022-01-25 12:20:53 +01:00
Thomas Heartman
c9026395b7 docs: add initial extra doc categories. 2022-01-25 12:20:06 +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
9fbfc28a72 docs: add Rust SDK to sidebar list of official sdks. 2022-01-13 10:38:20 +01:00
Thomas Heartman
b8f3313ae2 docs: group sdks into non-collapsible categories: server and client 2022-01-13 09:21:13 +01:00
Thomas Heartman
b2a8bc1655 docs: reorder sdks listing in sidebar
The previous list order didn't seem to have any reason behind it. This
is a suggestion for new order.

Index (the introduction) is first, followed by the proxy. Then comes
all the official sdks in alphabetic order (punctuation placed before
alpha). At the end of the list is the 'community sdks' link.

I'm open to suggestions and discussion here, but was working on this
list, so thought it could use some love.
2022-01-11 10:07:24 +01:00
Thomas Heartman
eb89d4505d docs: add link to /sdks/community-sdks
This serves two purposes:
1. For people who know the structure, it won't look like anything's
missing
2. For people who don't know the structure, it'll make community sdks
more discoverable.
2022-01-11 09:22:30 +01:00
Thomas Heartman
c3d78bc028 docs: delete /sdks/community page
This page was more or less a duplicate of the final section of the
SDK overview. I've moved the section on implementing your own SDK into
the SDK overview instead.
2022-01-10 14:53:41 +01:00
Thomas Heartman
575ad1093e docs: add dummy how-to; link from reference docs 2022-01-07 11:49:33 +01:00
Thomas Heartman
45fe483924 docs: add placeholder how-to-guide for custom project roles 2022-01-06 12:34:20 +01:00
Thomas Heartman
9791783be5 docs(strats): separate reference and how-to 2021-12-22 09:59:32 +01:00
Thomas Heartman
498ac4ff6d docs(context): spilt strat constraints into ref and how-to. 2021-12-20 14:28:00 +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
b86ffb9bc9
Merge pull request #1172 from Unleash/docs/a-b-testing-discussion
docs: Add topic guide for A/B testing
2021-12-13 13:18:40 +01:00
Thomas Heartman
ead86ed621 docs(a/b-testing): rename 'concepts' -> 'topics' 2021-12-13 12:33:47 +01:00
Thomas Heartman
e4d0c4fb50 docs(variants): rename 'discussion' -> 'concepts' 2021-12-09 12:07:25 +01:00
Thomas Heartman
735b8996a1 docs(variants): rename A/B testing file 2021-12-09 12:02:37 +01:00
Thomas Heartman
9e7f48931a docs(variants): add discussion topic on a/b testing 2021-12-09 11:34:02 +01:00
Ivar Conradi Østhus
642a2371ef fix: updated API docs to reflect v4.3 2021-12-06 15:31:50 +01:00
Thomas Heartman
1837a6ec35 docs: add environments post to side bar. 2021-11-26 13:53:32 +01:00
Thomas Heartman
e9e1de4a89 docs: Add stickiness document to advanced section. 2021-11-24 10:48:28 +01:00
Christopher Kolstad
52ae753466
docs: remove jira cloud plugin docs for now (#1118) 2021-11-22 11:43:06 +01:00
Christopher Kolstad
00558a28d4
docs: Add docs for Jira server plugin 2021-11-12 14:00:41 +01:00
Ivar Conradi Østhus
ffec4f6342 fix: rename websitev2 to website 2021-10-26 11:25:19 +02:00