Thomas Heartman
8916de76be
docs: Remove/update references to Heroku ( #2099 )
...
## What
This PR removes or updates references in the docs to Heroku. Most of the code samples have been replaced with a more generic `unleash.example.com` url, while other references have been removed or updated.
Also removes old OpenAPI files that are out of date and redundant with the new generation.
## Background
Come November and Heroku will no longer offer free deployments of Unleash, so it's about time we remove that claim.
Links to the heroku instance are also outdated because we don't have that instance running anymore.
Finally, the OpenAPI files we do have there are old and static, so they don't match the current reality.
## Commits
* Meta: update ignore file to ignore autogenerated docs
I must've missed the ignore file when looking for patterns.
* docs: delete old openapi file.
This seems to have been a holdover from 2020 and is probably
hand-written. It has been superseded by the new autogenerated OpenAPI docs.
* docs: add notes for heroku changes to the frontend readme and pkg
* docs: remove old openapi article and add redirects to new openapi
* docs: fix link in overview doc: point to GitHub instead of heroku
* docs: update quickstart docs with new heroku details
* docs: remove reference to crashing heroku instance
* docs: remove references to herokuapp in code samples
* docs: add a placeholder comment
* docs: update references for heroku updates
* docs: keep using unleash4 for enterprise
* docs: remove start:heroku script in favor of start:sandbox
* docs: remove 'deploy on heroku button'
Now that it's not free anymore (or won't be very shortly), let's
remove it.
* docs: remove extra newline
2022-10-19 12:02:00 +00: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
Thomas Heartman
0e4734af38
docs: Update docs with new constraint availability ( #2113 )
...
* docs: fix duplicated image.
* docs: add announcement banner for constraints
* docs: style announcement bar via CSS
* docs: update doc availability notices
* docs: remove commented-out announcement bar code
2022-10-04 14:13:52 +02: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
Thomas Heartman
a3585343e1
docs: Move user groups section to after permissions section ( #2081 )
...
The permissions section is a subsection of the CPR section and
shouldn't be separated. This seems to have been an oversight.
2022-09-23 11:15:15 +02:00
Thomas Heartman
2484720c74
docs: fix broken link to how-to-create-API token guide ( #2073 )
2022-09-19 13:18:44 +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
Allan Luartes
d73200ed16
docs: fix typo for overview guide ( #1942 )
...
Edit (_we're talk nano-seconds_) to (_we're talking nano-seconds_)
2022-08-20 07:31:21 +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
Thomas Heartman
b06cbb0f75
docs: remove references to deprecated proxy config variable ( #1902 )
2022-08-09 16:20:28 +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
Erik
19b95b1bd9
docs: Update activation-strategies.md ( #1824 )
...
Fixing a typo in `Multiple activation strategies` section
2022-07-18 13:03:27 +02:00
ltickett
a3b9dbad24
Add GitLab to Unleash server options ( #1799 )
2022-07-13 09:33:36 +02:00
Nuno Góis
5ba5edcaca
docs: add svelte and vue front-end SDKs ( #1760 )
...
* docs: add svelte and vue front-end SDKs
* docs: add solid and react native SDKs as Community SDKs
* fix: reorder community SDKs so that they are sorted alphabetically
* fix: note and table
* fix: note scope, reorder community SDKs alphabetically by tech
* fix: make some text consistent across SDKs
* fix: svelte docs
* Update website/docs/sdks/proxy-svelte.md
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
* fix: headings
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-06-29 12:04:21 +01:00
andreas-unleash
66452e2860
open-api addon controller ( #1721 )
...
* open-api addon controller
* bug fixes
* bug fixes
* resolve merge conflict
* bug fix
* bug fix
* bug fix
* PR comments
* PR comments
* Resolve merge conflics
* Resolve merge conflics
* bug and tests
2022-06-22 13:49:18 +03: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
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
