Simon Hornby
90cb737202
docs: add documentation for user group syncing ( #2314 )
...
* docs: add documentation for user group syncing and a end to end example for keycloak
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-11-03 14:59:12 +02:00
Nuno Góis
20310bf1a4
docs: add environment cloning and how-to guide ( #2249 )
...
* docs: add environment cloning and how-to guide
* add next steps in how-to, update reference
* update how-to, add images
* Update website/docs/how-to/how-to-clone-environment.mdx
Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
* Update website/docs/how-to/how-to-clone-environment.mdx
Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
* Update website/docs/user_guide/environments.md
Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
* Update website/docs/how-to/how-to-clone-environment.mdx
Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
* Update website/docs/user_guide/environments.md
Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
* Update website/docs/how-to/how-to-clone-environment.mdx
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update website/docs/how-to/how-to-clone-environment.mdx
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update website/docs/how-to/how-to-clone-environment.mdx
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update website/sidebars.js
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update website/docs/how-to/how-to-clone-environment.mdx
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update website/docs/how-to/how-to-clone-environment.mdx
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update website/docs/how-to/how-to-clone-environment.mdx
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update website/docs/user_guide/environments.md
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update website/docs/user_guide/environments.md
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* address PR comments
* Update website/docs/how-to/how-to-clone-environments.mdx
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update website/docs/user_guide/environments.md
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update website/docs/user_guide/environments.md
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update website/docs/user_guide/environments.md
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* fix uppercase in guide
Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-11-03 14:14:08 +02:00
Thomas Heartman
0e3e725a17
docs: add "The Anatomy of Unleash" ( #2138 )
...
## What
This PR
1. adds a new topic document, "The Anatomy of Unleash", which explains
how Unleash is built up as a system.
2. It also moves the "topic guides" sidebar entry from position 4 to
position 2.
3. Finally, it introduces a new `Figure` component for the
documentation, to be used with images that should be shown with
captions.
## Why
Referring to the same numbers as mentioned above, here's some background
for these changes:
1. We have gotten requests from enterprise users for a way to help new
Unleash users understand the system. Together with customer success and
customer journey, we agreed that an explanatory guide would be suitable.
It aims to give the reader an introduction into what pieces constitute
the Unleash system.
2. As part of a discussion, it was suggested to move topic guides higher
up to make them more visible. There's a few reasons for this:
1. New users of Unleash should be able to keep reading about Unleash
after the basic introductory material. When left at the bottom, topic
guides are often overlooked
2. As a justification, it was proposed that reference docs are often the
last thing you look for, so it makes sense to put that last.
3. Thinking about a new user's flow, it also makes some sense: first
read introductory material, then dive deeper into what Unleash is and
what you can use it for, then look for how-to guides if you're stuck,
and finally consult the reference material for later.
3. These diagrams aren't necessarily very self-explanatory, so adding a
caption makes a lot of sense. We didn't have a component from this
previously, so I added one.
Co-authored-by: NicolaeUnleash <103567375+NicolaeUnleash@users.noreply.github.com>
Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
## Commits
* docs: add raw export of anatomy document
* docs: move the topic guides section to near top of sidebar
* docs: add inter-doc links, some reformatting
* docs: fix broken links
* docs: add a Figure element for figures with captions
* docs: add more styling to figures
* docs: align on styles
* Fix: add fuller figure caption
* docs: rephrase heading
* Docs(test): try new way of importing images
* Docs(test): images take 3
* docs: Convert all images to using the figure component
* docs: add projects to list of top-level resources
* docs: add captions for all figures.
* docs: reorder images
* Docs(fix): typo: extra brackets
* Docs(style): remove box shadows and border on fig caption images
* Docs(chore): remove commented-out css
* Docs(refactor): use css variable for small font size.
To facilitate reusability and convey meaning.
* docs: rename anatomy doc
* docs: add note about strategies vs constraints
* Updating the images
* Apply suggestions from code review
Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
* Update website/docs/topics/the-anatomy-of-unleash.mdx
* Docs(fix): remove redundant comma
* docs: add link to node js sdk
* docs: mention that a toggle must be active in an env to be enabled
* docs: add note about environments and api keys
* Docs(reword): swap dev and prod in example
* docs: fix typo in the image
* docs: make figures in text full-width
* docs: move environments and API keys call-out to after figure
* docs: add borders to figures
* docs: add image float css idea
* Revert "docs: add image float css idea"
This reverts commit 69f27d304b
2022-10-19 13:14:49 +02:00
Simon Hornby
b1a877e56c
docs: adds documentation for personal api tokens ( #2164 )
...
* docs: adds documentation for personal api tokens
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-10-13 11:02:04 +02:00
andreas-unleash
0651c83bd1
Docs/public signup ( #2070 )
...
* update snapshot
* add api doc
* describe api
* reference initial
* updated public signup api docs
created public invite api docs
* docs
* docs update
* docs update
* add description to openapi endpoints
* add description to openapi endpoints
* fix snapshot
* Update src/lib/openapi/spec/public-signup-token-create-schema.ts
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update src/lib/openapi/spec/public-signup-token-schema.ts
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update src/lib/routes/admin-api/public-signup.ts
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update src/lib/routes/public-invite.ts
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update src/lib/openapi/spec/public-signup-token-schema.ts
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update src/lib/routes/admin-api/public-signup.ts
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update website/docs/reference/public-signup.mdx
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* PR comments
* delete api docs
* fix snapshot
* Update src/lib/routes/admin-api/public-signup.ts
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* bug fix
* bug fix
* bug fix
* Update src/lib/openapi/spec/public-signup-token-create-schema.ts
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update src/lib/openapi/spec/public-signup-token-schema.ts
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update src/lib/openapi/spec/public-signup-token-update-schema.ts
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update src/lib/routes/admin-api/public-signup.ts
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update src/lib/routes/admin-api/public-signup.ts
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Update src/lib/routes/public-invite.ts
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* bug fix
* fix links
* update snapshot
* update snapshot
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-10-10 16:12:11 +03:00
Thomas Heartman
0302b3d2e3
fix: Update UI labeling: custom constraint -> (strategy) constraint ( #2101 )
...
* fix: change every instance of "custom constraint"
This changes every instance of "custom constraint" to "constraint" or
"strategy constraint" depending on the context.
* fix: rename custom-constraint.png to avoid confusion
* Update images-constraints
Co-authored-by: NicolaeUnleash <103567375+NicolaeUnleash@users.noreply.github.com>
2022-09-29 11:43:04 +02:00
Tymoteusz Czech
2cd5028125
Docs: update API access for new token type ( #1958 )
...
* refactor how-to guide for creating a token
* fix token links
* update SDK reference
* beginning of direct api guide
* refactored frontend api guide
* lint staged breaking notes
* update docs - cors for frontend
* update token guide images
* update after review
* Apply suggestions from code review
`website/docs/user_guide/token.mdx`
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Apply suggestions from code review
`website/docs/topics/frontend-api.md`
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Apply suggestions from code review
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* Apply suggestions from code review
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* pr review
* docs: Add info about front-end tokens + formatting
* docs: add info about token anatomy
* docs: link to correct place in doc
* docs: replace "direct access API" -> "front-end API"
* docs: rename file frontend-api -> front-end-api
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-09-15 09:02:10 +02:00
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
Simon Hornby
46b1a25181
docs: update group docs with new screenshots and requirements for users ( #1910 )
2022-08-11 14:01:32 +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
NicolaeUnleash
7c275917f3
docs: Update api_access_navigation.png ( #1784 )
2022-06-30 15:58:13 +03: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
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
2e1423095e
fix: Add missing segments image
2022-04-11 12:17:02 +02:00
sighphyre
0d4360b997
docs: add installation instructions for jira plugin for marketplace
2022-03-25 09:24:26 +02:00
Thomas Heartman
0d2e72eeea
docs: delete images that are no longer in use.
2022-03-24 16:12:40 +01:00
Thomas Heartman
b3faf3e622
docs: add screenies and update descriptions accordingly
2022-03-17 08:41:57 +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
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
299afd97ff
docs(chore): update images; remove empty space.
2022-01-14 11:09:32 +01:00
Thomas Heartman
7897ee2e87
docs: add how-to screenies for cpr
2022-01-14 10:59:18 +01:00
Thomas Heartman
d60dcfa9d4
docs(strats): start filling in how-to for custom strats
2021-12-22 11:36:08 +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
6b7f4f3544
docs(context): rough draft of how to create custom context fields.
2021-12-20 12:54:59 +01:00
Thomas Heartman
e061ccccb4
Merge pull request #1186 from Unleash/docs/4.3-minor-updates
...
docs: update existing articles and screenshots to match version 4.3
2021-12-15 10:58:54 +01:00
Thomas Heartman
5653331eea
docs(4.3): update tech debt section.
2021-12-14 14:23:39 +01:00
Thomas Heartman
d59d2f141e
docs(4.3): update the custom strategy documentation.
2021-12-14 14:13:24 +01:00
Thomas Heartman
74aa185392
docs(4.3): update control-rollout document.
2021-12-14 14:03:28 +01:00
Thomas Heartman
23d06264a1
docs(4.3): update project images.
2021-12-14 13:30:06 +01:00
Thomas Heartman
cfeef6b4ba
docs(4.3): update environments section.
2021-12-14 12:33:29 +01:00
Thomas Heartman
c9ef7c1f44
docs(4.3): update API access document.
2021-12-14 12:19:19 +01:00
Thomas Heartman
bfeb19f5f1
docs(4.3): update audit log chapter.
2021-12-14 12:10:04 +01:00
Thomas Heartman
c0b5f27a3c
docs(4.3): Update archive page.
2021-12-14 11:52:57 +01:00
Thomas Heartman
de420dde14
docs(4.3): update variants screenshot
2021-12-14 11:30:59 +01:00
Thomas Heartman
915be4c2ed
docs(4.3): update strategy constraints documentation.
2021-12-14 11:19:16 +01:00
Thomas Heartman
23dafcb230
docs(4.3): delete env strat constraint image, rewrite paragraph.
2021-12-13 12:44:11 +01:00
Thomas Heartman
4b6f166e95
docs: start documenting variant properties and weights
2021-12-07 13:32:11 +01:00
Thomas Heartman
e8478126a5
Merge branch 'master' into docs/add-stickiness
2021-11-24 13:59:56 +01:00
Thomas Heartman
d15cb50792
docs: update stickiness docs.
2021-11-24 11:52:17 +01:00
Thomas Heartman
7feff57977
docs: add image for custom stickiness.
2021-11-24 11:43:27 +01:00
Thomas Heartman
ff4114e7d2
Merge branch 'master' into docs/more-feature-toggle-type-info
2021-11-24 08:47:16 +01:00
Thomas Heartman
aef10d1d83
docs: first pass at updating the feature toggle types entry.
2021-11-23 11:15:20 +01:00
Thomas Heartman
98cdc1674f
docs: add initial (untested) steps on how to run the proxy locally.
...
I haven't yet tested connecting to the `unleash:4242` address.
2021-11-22 16:16:38 +01:00
Christopher Kolstad
52ae753466
docs: remove jira cloud plugin docs for now ( #1118 )
2021-11-22 11:43:06 +01:00
Christopher Kolstad
061fc560ab
docs: added screenshot successful install
2021-11-12 15:40:10 +01:00
Christopher Kolstad
00558a28d4
docs: Add docs for Jira server plugin
2021-11-12 14:00:41 +01:00
