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

117 Commits

Author SHA1 Message Date
Sebastian Bury
79806840e9
Update index.md (#2383)
Changed to reflect impression data in the proxy

<!-- Thanks for creating a PR! To make it easier for reviewers and
everyone else to understand what your changes relate to, please add some
relevant content to the headings below. Feel free to ignore or delete
sections that you don't think are relevant. Thank you! ❤️ -->

## About the changes
<!-- Describe the changes introduced. What are they and why are they
being introduced? Feel free to also add screenshots or steps to view the
changes if they're visual. -->

<!-- Does it close an issue? Multiple? -->
Closes #

<!-- (For internal contributors): Does it relate to an issue on public
roadmap? -->
<!--
Relates to [roadmap](https://github.com/orgs/Unleash/projects/10) item:
#
-->

### Important files
<!-- PRs can contain a lot of changes, but not all changes are equally
important. Where should a reviewer start looking to get an overview of
the changes? Are any files particularly important? -->


## Discussion points
<!-- Anything about the PR you'd like to discuss before it gets merged?
Got any questions or doubts? -->
2022-11-10 15:59:32 +01:00
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
Thomas Heartman
585ce12da1 Docs: Clarify proxy limitations 2022-10-11 10:53:20 +02:00
Thomas Heartman
523f4a9fd3
docs: add note about custom activation strats in hosted proxies (#2173)
## What

This change adds a note to the custom activation strategies section of
the proxy docs, clarifying that the hosted proxy can not use custom
activation strategies.

## Why

We had a customer asking whether this was possible and realized it's
not stated explicitly anywhere.
2022-10-11 10:39:29 +02:00
Ivar Conradi Østhus
26c88ff6aa
fix: update SDK matrix
with impression events supported for node.js
2022-09-15 13:35:51 +02:00
Ivar Conradi Østhus
2cf372364f
Update index.md 2022-09-15 13:34:07 +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
Thomas Heartman
469bd1622e
docs: update link for symfony sdk (#2048)
The doc link appears to have pointed at an address that is no longer reachable. Instead, let's point to the equivalent GitHub link

Relates to and closes #2047
2022-09-07 13:21:40 +00:00
Thomas Heartman
68cec1349b
Fix broken doc links (#2046)
## What

This PR fixes some broken links that have been hanging around in the
docs for what seems like a very long time.

## Why

As discovered by the link check in #1912, there are a fair few broken
links in the docs. Everyone hates broken links because it makes it
harder to understand what they were supposed to be pointing at.

## How

There are 3 types of links that have been fixed:
- Links that should have been internal but were absolute. E.g.
  `https://docs.getunleash.io/path/article` that should have been
  `./article.md`
- External links that have changed, such as Slack's API description
- GitHub links to files that either no longer exist or that have been
  moved. These links generally pointed to `master`/`main`, meaning
  they are subject to change. They have been replaced with permalinks
  pointing to specific commits.

-----

* docs: fix slack api doc link

* docs: update links in migration guide

* docs: fix broken link to ancient feature schema validation

* docs: update links to v3 auth hooks

* docs: update broken link in the go sdk article

* Fix: use permalink for GitHub link

* docs: fix wrong google auth link
2022-09-07 14:26:23 +02:00
Dominik Chrástecký
f206795d97
Docs: Update compatibility matrix for php (#1904)
* Docs: Update compatibility matrix for php

* Docs: Update php compatibility table to include IP CIDR syntax

* Docs: Update impression data documentation

* Docs: Mention JavaScript proxy clients in impression data support
2022-08-10 12:26:44 +02:00
sighphyre
c8f6c5cc75
docs: include custom header functionality for the Ruby SDK in the compatibility table (#1819) 2022-07-14 11:28:22 +02:00
Floyd
f2629dfdbc
Fixing indentation of Python example (#1794) 2022-07-13 09:33:58 +02:00
sellinjaanus
04fb065df4
Added missing archivedAt to featureSchema (#1779)
* Added missing archivedAt to featureSchema

* Added archivedAt to feature toggle.
Added archived_at to db

* Add test

* Add test

* Bug fix

* Bug fix

* update archivedAt to date-time

* Code refactoring done

* Conver to static and remove unused methods

* Add tests

* Fixes

* Fix

* Removed docker file from linting

* Fix segment test

* Fix failing test

* Make fixes

Co-authored-by: andreas-unleash <andreas@getunleash.ai>
Co-authored-by: andreas-unleash <104830839+andreas-unleash@users.noreply.github.com>
2022-07-01 11:51:26 +00: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
Thomas Heartman
611ef41703
docs: update python docs: fallback function / default values (#1752) 2022-06-27 11:16:46 +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
Christopher Kolstad
45c3df0598
docs: SDK Synchronization tips (#1720)
* docs: SDK Synchronization tips

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

* docs: Update csharp example with tabs

* docs: update java docs with tabs and sync examples

* docs: update node docs for sync init

* docs: remove plea to pay attention to env config option

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-06-15 09:49:56 +00:00
Christopher Kolstad
705eee654f
fix: pleas -> please (#1706) 2022-06-14 15:16:58 +02:00
Nuno Góis
40c920f184
docs: use named export instead of default (#1615) 2022-05-20 10:31:05 +01:00
Nuno Góis
46c253b964
docs: use named export instead of default (#1614) 2022-05-20 11:22:14 +02:00
Nuno Góis
16860c1469
docs: update import to use named export instead of default (#1609)
See: https://github.com/Unleash/proxy-client-react/pull/58
2022-05-20 07:48:01 +01:00
Thomas Heartman
a6753d9af3
docs: switch all slack links to slack.unleash.run (#1613) 2022-05-20 08:17:36 +02:00
Andreas Fauske
70f58b3a84
Update dot_net.md (#1598)
Fixed a typo.
2022-05-19 14:59:36 +02:00
Thomas Heartman
d384a76a28
docs: fix python sdk syntax highlighting, header levels (#1596)
* docs: fix python sdk syntax highlighting, header levels
* docs(fix): remove invalid toggle names
2022-05-16 10:30:28 +02:00
Thomas Heartman
943af1e804
docs: Update the react client install instructions (#1584)
The install instructions didn't previously add the
`unleash-proxy-client` package (presuming it'd be implicitly installed
by `npm`). This doesn't seem to be the case, so we'll list it explicitly.
2022-05-10 13:26:52 +02:00
Thomas Heartman
75e6df5b5b
docs: document Proxy openAPI integration (#1571)
* docs: document the new OpenAPI functionality

* docs: add availability note for openapi integration

* docs: rewrite openapi section
2022-05-09 09:24:48 +02:00
Fredrik Strand Oseberg
5f96cb3785
docs: update compat table with custom stickiness for go (#1544) 2022-04-28 15:49:05 +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
sjaanus
a1f28ef56d
fix: rename variable for consistency purposes (#1507) 2022-04-25 10:21:18 +02:00
Fredrik Strand Oseberg
60c1265ac4
chore: update matrix (#1511)
* chore: update matrix

* chore: update matrix without format
2022-04-20 15:41:32 +02:00
Thomas Heartman
9db36013b1 chore: delete reference doc scaffolding 2022-04-13 15:41:02 +02:00
Thomas Heartman
f1a4347534 chore: delete duplicate configuration section 2022-04-13 15:40:11 +02:00
Thomas Heartman
b43d9b05db docs: link to the how-to guide from the proxy reference docs 2022-04-13 15:39:04 +02:00
Thomas Heartman
ac9f800ba8 docs: add details to the configuration option table 2022-04-13 15:37:04 +02:00
Thomas Heartman
8f3018d092 docs: ad configuration variables to proxy reference 2022-04-12 16:00:07 +02:00
Thomas Heartman
29f77b8e27 docs: add configuration options header. 2022-04-12 15:59:12 +02:00
Thomas Heartman
3c63adddab docs: add more scaffolding to proxy docs 2022-04-12 15:59:12 +02:00
Thomas Heartman
4b0b08a2ea docs: start moving proxy details around 2022-04-12 15:59:12 +02:00
Thomas Heartman
f3a7ec5559
Merge pull request #1492 from Unleash/docs/update-sdk-compat
docs(sdk compat table): Add new strategy constraint  for .NET; add s for Proxy
2022-04-12 13:53:08 +02:00
Thomas Heartman
a327f55b3a docs: update client sdk overview title
When the title is only "Introduction" it's super hard to find via
search. Changing it to something more descriptive should make that easier.
2022-04-12 10:41:50 +02:00
Thomas Heartman
d86f898316 docs: Add s for proxy features 2022-04-08 15:24:56 +02:00
Thomas Heartman
3067001083 docs: add for .NET constraints since 2.1 2022-04-08 15:24:35 +02:00
Thomas Heartman
41485ec50a docs: change android docs to use clientKey, not clientSecret 2022-04-06 10:56:51 +02:00
Thomas Heartman
2ffe11a336 docs: list v1.3.1 of the PHP sdk as first compatible w/adv constr.
While 1.3 _does_ contain the advanced operators, it'll still break if
it doesn't recognize the operators or if you provide an invalid semver
version. 1.3.1 fixes this, so we should try and nudge people towards
that instead.
2022-03-23 13:14:20 +01:00
Thomas Heartman
0998ca4618 Merge branch 'main' into docs/sdk-min-version-for-advanced-operators 2022-03-18 15:01:39 +01:00
Thomas Heartman
b432ec8795 docs: only list feature versions for constraint ops inclusion 2022-03-18 14:23:26 +01:00
Thomas Heartman
e604b95e7d docs: update min versions for node, python, ruby 2022-03-18 13:55:31 +01:00
Thomas Heartman
8c8d165937 docs: add more comprehensive overview of sdk incompatibilities 2022-03-18 12:19:49 +01:00
Thomas Heartman
c999b4c43e docs: add php support version for advanced constraints 2022-03-18 11:34:51 +01:00
Thomas Heartman
a9a480d33f docs: note the minimum SDK versions necessary for adv constraints
Also formats the rest of the table to align with the new column
content. Please ignore whitespace for this.
2022-03-18 11:29:25 +01:00