Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-25 00:07:47 +01:00
Code Issues Projects Releases Wiki Activity

docs: Extend docs landing page; add more links, structure, etc.

Browse Source
This commit is contained in:
Thomas Heartman 2022-01-24 14:39:02 +01:00
parent 100e136951
commit f944a40d78
1 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
website/docs/user_guide/index.md
View File

@ -17,37 +17,44 @@ Have questions that you can't find the answer to in these docs? You can always t
## Documentation structure ## Documentation structure
Our documentation is split into four parts, using the [Diataxis documentation framework](https://diataxis.fr/): documentation, how-to guides, topic guides, and reference documentation. Our documentation is split into four parts, using the [Diataxis documentation framework](https://diataxis.fr/):
- [tutorials and introductory material](#tutorials)
- [how-to guides](#how-to-guides)
- [topic guides](#topic-guides)
- [reference documentation](#reference-documentation)
### Tutorials ### Tutorials and introductory material {#tutorials}
New to Unleash? Not sure where to get started? The tutorials guide you through taking your first steps with Unleash. New to Unleash? Not sure where to get started? The tutorials guide you through your first steps with Unleash:
- [Unleash introductory overview](unleash_overview.md)
- [Important Unleash concepts](important-concepts.md)
- [Quickstart guides](quickstart.md)
### How-to guides ### 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. 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 topics: The guides are organized into the following categories:
- API [/how-to/api] - [API how-tos](/how-to/api)
- Feature toggles, strategies, context [/how-to/general] - [Feature toggles, strategies, context, and general how-tos](/how-to/misc)
- Users and permissions [/how-to/permissions] - [Users and permissions how-tos](/how-to/users-and-permissions)
- SSO [/how-to/single-sign-on] - [Single Sign-On (SSO) how-tos](/how-to/sso)
### Reference documentation ### 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 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: The reference docs are organized into the following topics:
- Unleash concepts [/reference/concepts] - [Unleash concepts](/reference/concepts)
- APIs [/reference/api] - [API documentation](/api)
- Unleash SDKs [/reference/sdk] - [Unleash SDKs](/sdks)
- Deploy and manage unleash [/reference/deployment] - [Deploy and manage unleash](/deploy)
- Addons [/reference/addons] - [Addons](/addons)
- Integrations [/reference/integrations] - [Integrations](/integrations)
### Topic guides ### Topic guides
Topic guides discuss high-level concepts related to Unleash and provide extra background information and explanations around these concepts. [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 ## Other resources and communities