Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove/update references to Heroku #2099

Merged
merged 15 commits into from Oct 19, 2022
Merged

Remove/update references to Heroku #2099

merged 15 commits into from Oct 19, 2022

Conversation

thomasheartman
Copy link
Contributor

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.

@vercel
Copy link

vercel bot commented Sep 27, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
unleash-docs ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Oct 19, 2022 at 0:04AM (UTC)
unleash-monorepo-frontend ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Oct 19, 2022 at 0:04AM (UTC)

@github-actions
Copy link

Coverage report

Multiple errors occurred

 1 | Error: The process '/usr/local/bin/yarn' failed with exit code 1
 2 | Error: The process '/usr/local/bin/yarn' failed with exit code 1
 3 | Coverage output file not found. (file "report.json" not found)
 4 | Getting code coverage data failed.
St.
Category Percentage Covered / Total
🟢 Statements 91.38% 5287/5786
🟡 Branches 79.55% 817/1027
🟢 Functions 86.23% 1227/1423
🟢 Lines 91.3% 5166/5658

Test suite run success

868 tests passing in 124 suites.

Report generated by 🧪jest coverage report action from d139c3d

frontend/README.md Outdated Show resolved Hide resolved
frontend/package.json Outdated Show resolved Hide resolved
@@ -20,6 +20,6 @@ yarn-debug.log*
yarn-error.log*

# OpenAPI docusaurus generated stuff
docs/reference/apis/**/sidebar.js
docs/reference/api/**/sidebar.js
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is due to a last-minute change in where we generate OpenAPI docs. This change simply makes sure the new generated docs get ignored.

website/docs/user_guide/unleash_overview.md Outdated Show resolved Hide resolved
website/docusaurus.config.js Show resolved Hide resolved
Copy link
Contributor

@chriswk chriswk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems reasonable :)

frontend/package.json Outdated Show resolved Hide resolved
Copy link
Contributor

@chriswk chriswk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 LGTM

@thomasheartman thomasheartman enabled auto-merge (squash) October 19, 2022 11:57
@thomasheartman thomasheartman merged commit 8916de7 into main Oct 19, 2022
@thomasheartman thomasheartman deleted the docs/cleanup branch October 19, 2022 12:02
sighphyre pushed a commit that referenced this pull request Oct 27, 2022
## 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants