8916de76be
## 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
3.1 KiB
| id | title | slug | sidebar_position |
|---|---|---|---|
| index | About the docs | / | 1 |
:::note The docs are currently undergoing some heavy restructuring and development 👷♀️👷🏽 If something is unclear, don't hesitate to let us know on Slack! :::
Welcome to the Unleash documentation, your one-stop shop to everything Unleash. Whether you're just getting started or have been using Unleash for years, you should be able to find answers to all your questions here.
Getting help
Have questions that you can't find the answer to in these docs? You can always turn to the Unleash Slack community and ask us questions directly (or just come and hang out 😄).
Documentation structure
Our documentation is split into four parts, using the Diátaxis documentation framework:
Tutorials and introductory material
New to Unleash? Not sure where to get started? The tutorials guide you through your first steps with Unleash:
How-to guides
Our how-to guides show you how to perform a number of common tasks that you'll want to do. Think of them as recipes. They are more advanced than the tutorials and assume you have some working knowledge of Unleash.
The guides are organized into the following categories:
- API how-tos
- Feature toggles, strategies, context, and general how-tos
- Users and permissions how-tos
- Single Sign-On (SSO) how-tos
Reference documentation
The reference docs contain technical reference for Unleash and the API. Go here to find out how Unleash works and what configuration options are available. They're like an Unleash encyclopedia and assume you have a grip on key Unleash concepts.
The reference docs are organized into the following topics:
- Addons
- API documentation
- Unleash SDKs
- Deployment and management of Unleash
- Integrations with other systems
- Unleash concepts
Topic guides
The topic guides discuss high-level concepts related to Unleash and provide extra background information and explanations around these concepts.
Other resources and communities
💻 The core of Unleash is all open source and hosted on GitHub.
💬 If you've got questions or just wanna chat to the team and other Unleash users, come join our Slack community
🐦 You can also follow us on Twitter, LinkedIn, or Instagram for more updates and extra content.