9a62f6a64f
<!-- Thanks for creating a PR! To make it easier for reviewers and everyone else to understand what your changes relate to, please add some relevant content to the headings below. Feel free to ignore or delete sections that you don't think are relevant. Thank you! ❤️ --> ## About the changes <!-- Describe the changes introduced. What are they and why are they being introduced? Feel free to also add screenshots or steps to view the changes if they're visual. --> <!-- Does it close an issue? Multiple? --> Closes # <!-- (For internal contributors): Does it relate to an issue on public roadmap? --> <!-- Relates to [roadmap](https://github.com/orgs/Unleash/projects/10) item: # --> ### Important files <!-- PRs can contain a lot of changes, but not all changes are equally important. Where should a reviewer start looking to get an overview of the changes? Are any files particularly important? --> ## Discussion points <!-- Anything about the PR you'd like to discuss before it gets merged? Got any questions or doubts? --> --------- Co-authored-by: Drew Gorton <dgorton@users.noreply.github.com> Co-authored-by: Mark Fulton <128738155+markunl@users.noreply.github.com>
3.2 KiB
| title | slug | sidebar_position |
|---|---|---|
| About the docs | / | 1 |
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 our GitHub or 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 flags, strategies, context, and general how-tos
- Users and permissions how-tos
- Single Sign-On (SSO) how-tos
- Troubleshooting 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:
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, leave us a little something on GitHub Discussions or come join our Slack community
🐦 You can also follow us on Twitter, LinkedIn, or Instagram for more updates and extra content.