Skip to content

Commit 8916de7

Browse files
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
1 parent 0e3e725 commit 8916de7

14 files changed

+27
-1699
lines changed

docs/api/oas/openapi.yaml

Lines changed: 0 additions & 1671 deletions
This file was deleted.

frontend/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ yarn install
1313
yarn run start
1414
```
1515

16-
## Run with a heroku-hosted instance of unleash-api
16+
## Run with a sandbox instance of the Unleash API
1717

18-
Alternatively, instead of running unleash-api on localhost, use a remote instance:
18+
Alternatively, instead of running unleash-api on localhost, you can use a remote instance:
1919

2020
```
2121
cd ~/frontend
2222
yarn install
23-
yarn run start:heroku
23+
yarn run start:sandbox
2424
```
2525

2626
## Running end-to-end tests
@@ -30,7 +30,7 @@ so it's important that you check these yourself before submitting a PR.
3030
On the server the tests will run against the deployed Heroku app so this is what you probably want to test against:
3131

3232
```
33-
yarn run start:heroku
33+
yarn run start:sandbox
3434
```
3535

3636
In a different shell, you can run the tests themselves:

frontend/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"build": "vite build",
1414
"lint": "yarn fmt:check",
1515
"start": "vite",
16-
"start:heroku": "UNLEASH_API=https://unleash.herokuapp.com yarn run start",
16+
"start:sandbox": "UNLEASH_API=https://sandbox.getunleash.io/ospro yarn run start",
1717
"start:enterprise": "UNLEASH_API=https://unleash4.herokuapp.com yarn run start",
1818
"start:demo": "UNLEASH_BASE_PATH=/demo/ yarn start",
1919
"test": "tsc && vitest run",

website/docs/api/open-api.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

website/docs/deploy/import-export.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Example with curl:
6363
```sh
6464
curl -X GET -H "Content-Type: application/json" \
6565
-H "Authorization: Basic YWRtaW46" \
66-
http://unleash.herokuapp.com/api/admin/state/export?&featureToggles=1&strategies=0 > export.json
66+
https://unleash.example.com/api/admin/state/export?&featureToggles=1&strategies=0 > export.json
6767
```
6868

6969
### API Import {#api-import}

website/docs/deploy/securing-unleash-v3.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,6 @@ Examples of custom authentication hooks:
4747
- [basic-auth-hook.js](https://github.com/Unleash/unleash-examples/blob/7ed25f97a31dfd8f773c00847080b1a4c889fd87/v3/securing-basic-auth/basic-auth-hook.js)
4848
- [keycloak-auth-hook.js](https://github.com/Unleash/unleash-examples/blob/7ed25f97a31dfd8f773c00847080b1a4c889fd87/v3/securing-keycloak-auth/keycloak-auth-hook.js)
4949

50-
We also have a version of Unleash deployed on Heroku which uses Google OAuth 2.0: https://secure-unleash.herokuapp.com
51-
5250
## Securing the Client API {#securing-the-client-api}
5351

5452
A common way to support client access is to use pre-shared secrets. This can be solved by having clients send a shared key in an HTTP header with every client request to the Unleash API. All official Unleash clients should support this.

website/docs/how-to/how-to-use-custom-strategies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The steps to implement a custom strategy for your client depend on the kind of c
6565
}
6666

6767
const instance = initialize({
68-
url: 'http://unleash.herokuapp.com/api/',
68+
url: 'https://unleash.example.com/api/',
6969
appName: 'unleash-demo',
7070
instanceId: '1',
7171
// highlight-next-line

website/docs/sdks/go.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ func init() {
3232
unleash.Initialize(
3333
unleash.WithListener(&unleash.DebugListener{}),
3434
unleash.WithAppName("my-application"),
35-
unleash.WithUrl("http://unleash.herokuapp.com/api/"),
35+
unleash.WithUrl("https://unleash.example.com/api/"),
3636
unleash.WithCustomHeaders(http.Header{"Authorization": {"<API token>"}}),
3737
)
3838
}

website/docs/sdks/java.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ UnleashContextProvider contextProvider = new MyAwesomeContextProvider();
111111
UnleashConfig config = new UnleashConfig.Builder()
112112
.appName("java-test")
113113
.instanceId("instance x")
114-
.unleashAPI("http://unleash.herokuapp.com/api/")
114+
.unleashAPI("https://unleash.example.com/api/")
115115
.unleashContextProvider(contextProvider)
116116
.build();
117117

website/docs/sdks/php.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ $contextProvider = new MyAwesomeContextProvider();
9090
$unleash = UnleashBuilder::create()
9191
->withAppName('my.php-app')
9292
->withInstanceId('your-instance-1')
93-
->withAppUrl('http://unleash.herokuapp.com/api/')
93+
->withAppUrl('https://unleash.example.com/api/')
9494
->withContextProvider($contextProvider)
9595
->build();
9696

website/docs/user_guide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The reference docs are organized into the following topics:
6262

6363
## Other resources and communities
6464

65-
💻 The core of Unleash is all open source and [hosted on GitHub](https://www.heroku.com/deploy/?template=https://github.com/Unleash/unleash 'Unleash on GitHub').
65+
💻 The core of Unleash is all open source and [hosted on GitHub](https://github.com/Unleash/unleash/ 'Unleash on GitHub').
6666

6767
💬 If you've got questions or just wanna chat to the team and other Unleash users, come [join our Slack community](https://slack.unleash.run/)
6868

website/docs/user_guide/quickstart.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,21 +115,29 @@ Now you can fetch the feature toggle you created and try turning it on / off in
115115

116116
If you want to set up your own instance for testing purposes you can easily do so by using one of our premade setup kits for Heroku or DigitalOcean.
117117

118-
> The Heroku instance setup is FREE, and includes a DB to save your state but it will eventually go to sleep when not used. The DigitalOcean setup utilises droplets and will cost you around $10/month to run, but in turn it will not go to sleep. NOTE: If you use the DigitalOcean link below and are a new user, you will receive $100 in FREE credits.
118+
::: info Pricing
119119

120-
### Deploy a free version of Unleash to Heroku
120+
Both DigitalOcean and Heroku will charge you for running Unleash on their services. However, if you use the DigitalOcean link below and are a new user, you will receive $100 in free credits.
121+
122+
:::
123+
124+
### Deploy a paid version of Unleash to Heroku
121125

122126
[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.png)](https://www.heroku.com/deploy/?template=https://github.com/Unleash/unleash)
123127

124128
### Deploy a paid version of Unleash to DigitalOcean
125129

126-
> You'll receive $100 in free credits if you are a new DigitalOcean user using this link.
130+
:::tip Free credits
131+
132+
You'll receive $100 in free credits if you are a new DigitalOcean user using this link.
133+
134+
:::
127135

128136
[![Deploy to DigitalOcean](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/apps/new?repo=https://github.com/Unleash/unleash/tree/main&refcode=0e1d75187044)
129137

130138
### Accessing your new instance
131139

132-
Once you have set up the new instance, click the URL provided by either Heroku or DigitalOcean and you'll be taken to the application login screen.
140+
Once you have set up the new instance, follow the URL provided by either Heroku or DigitalOcean and it will take you to the application login screen.
133141

134142
Input the following credentials to log in:
135143

website/docs/user_guide/unleash_overview.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ Before you can connect your application to Unleash you need a Unleash server. Yo
1313
1. **Unleash Open-source**
1414
- [Docker](../deploy/getting-started.md)
1515
- [Helm Chart](https://github.com/unleash/helm-charts/)
16-
- [Click-to-deploy on Heroku](https://www.heroku.com/deploy/?template=https://github.com/Unleash/unleash)
1716
- [GitLab](https://docs.gitlab.com/ee/operations/feature_flags.html#choose-a-client-library)
1817
2. **Unleash Enterprise**
1918
- [Hosted Plans](https://www.getunleash.io/plans)

website/docusaurus.config.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,10 @@ module.exports = {
185185
from: '/advanced/audit_log',
186186
to: '/reference/event-log',
187187
},
188+
{
189+
from: '/api/open_api',
190+
to: '/reference/api/unleash',
191+
},
188192
],
189193
createRedirects: function (toPath) {
190194
if (

0 commit comments

Comments
 (0)