1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-28 00:06:53 +01:00
Commit Graph

6 Commits

Author SHA1 Message Date
Thomas Heartman
75c3fcd170
docs: update export/import examples (#2348)
## What

This change updates the availability notice and the code samples in the
import/export docs.

Specifically, the code samples have been moved to using the ApiRequest
component (and thus get examples in HTTP, cURL, and HTTPie), and the
import code sample now says which version it's using (version 3).

## Why

The import code sample didn't say which version of the data it used, so
Unleash would assume it was version 1 if you tried to run it. However,
the actual data was incompatible with the v1 data format, so you'd get
an error if you tried to actually import it.

While fixing this, I figured it'd also be alright to add some other
minor updates to bring the docs a bit more up to recent standards.
2022-11-08 13:42:06 +00: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
5573af675e docs: restructure startup import section to group actions by intent
This groups ways of importing together and ways of dropping together
instead of grouping the instructions by whether they use env variables
or command line options.

Should (?) make it easier to find what you want, but most importantly:
means we only need to explain the database drops once.
2022-01-07 08:03:49 +01:00
Thomas Heartman
72bbcaf517 docs: change wording slightly. 2022-01-06 10:57:39 +01:00
Thomas Heartman
70b9a2d37e docs: add information on using env vars for startup imports. 2022-01-06 10:54:31 +01:00
Ivar Conradi Østhus
ffec4f6342 fix: rename websitev2 to website 2021-10-26 11:25:19 +02:00