mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-22 19:07:54 +01:00
d5fbd0b743
## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
69 lines
3.1 KiB
Markdown
69 lines
3.1 KiB
Markdown
---
|
|
title: About the docs
|
|
slug: /
|
|
sidebar_position: 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](https://slack.unleash.run/)!
|
|
:::
|
|
|
|
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](https://slack.unleash.run/) 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](https://diataxis.fr/):
|
|
|
|
- [tutorials and introductory material](#tutorials)
|
|
- [how-to guides](#how-to-guides)
|
|
- [reference documentation](#reference-documentation)
|
|
- [topic guides](#topic-guides)
|
|
|
|
### Tutorials and introductory material {#tutorials}
|
|
|
|
New to Unleash? Not sure where to get started? The tutorials guide you through your first steps with Unleash:
|
|
|
|
- [Unleash introductory overview](./tutorials/unleash-overview.md)
|
|
- [Important Unleash concepts](./tutorials/important-concepts.md)
|
|
- [Quickstart guides](tutorials/quickstart.md)
|
|
|
|
### 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](/how-to/api)
|
|
- [Feature toggles, strategies, context, and general how-tos](/how-to/misc)
|
|
- [Users and permissions how-tos](/how-to/users-and-permissions)
|
|
- [Single Sign-On (SSO) how-tos](/how-to/sso)
|
|
|
|
### 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](/reference/addons/addons.md)
|
|
- [API documentation](/api)
|
|
- [Unleash SDKs](/sdks)
|
|
- [Deployment and management of Unleash](/deploy)
|
|
- [Integrations with other systems](/integrations)
|
|
- [Unleash concepts](/reference/concepts)
|
|
|
|
### Topic guides
|
|
|
|
[The topic guides](/topics) 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](https://github.com/Unleash/unleash/ 'Unleash on GitHub').
|
|
|
|
💬 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/)
|
|
|
|
🐦 You can also follow us [on Twitter](https://twitter.com/getunleash 'Unleash on Twitter'), [LinkedIn](https://www.linkedin.com/company/getunleash/ 'Unleash on LinkedIn'), or [Instagram](https://www.instagram.com/getunleash/ 'Unleash on Instagram') for more updates and extra content.
|