mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-22 19:07:54 +01:00
0e3e725a17
## What
This PR
1. adds a new topic document, "The Anatomy of Unleash", which explains
how Unleash is built up as a system.
2. It also moves the "topic guides" sidebar entry from position 4 to
position 2.
3. Finally, it introduces a new `Figure` component for the
documentation, to be used with images that should be shown with
captions.
## Why
Referring to the same numbers as mentioned above, here's some background
for these changes:
1. We have gotten requests from enterprise users for a way to help new
Unleash users understand the system. Together with customer success and
customer journey, we agreed that an explanatory guide would be suitable.
It aims to give the reader an introduction into what pieces constitute
the Unleash system.
2. As part of a discussion, it was suggested to move topic guides higher
up to make them more visible. There's a few reasons for this:
1. New users of Unleash should be able to keep reading about Unleash
after the basic introductory material. When left at the bottom, topic
guides are often overlooked
2. As a justification, it was proposed that reference docs are often the
last thing you look for, so it makes sense to put that last.
3. Thinking about a new user's flow, it also makes some sense: first
read introductory material, then dive deeper into what Unleash is and
what you can use it for, then look for how-to guides if you're stuck,
and finally consult the reference material for later.
3. These diagrams aren't necessarily very self-explanatory, so adding a
caption makes a lot of sense. We didn't have a component from this
previously, so I added one.
Co-authored-by: NicolaeUnleash <103567375+NicolaeUnleash@users.noreply.github.com>
Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
## Commits
* docs: add raw export of anatomy document
* docs: move the topic guides section to near top of sidebar
* docs: add inter-doc links, some reformatting
* docs: fix broken links
* docs: add a Figure element for figures with captions
* docs: add more styling to figures
* docs: align on styles
* Fix: add fuller figure caption
* docs: rephrase heading
* Docs(test): try new way of importing images
* Docs(test): images take 3
* docs: Convert all images to using the figure component
* docs: add projects to list of top-level resources
* docs: add captions for all figures.
* docs: reorder images
* Docs(fix): typo: extra brackets
* Docs(style): remove box shadows and border on fig caption images
* Docs(chore): remove commented-out css
* Docs(refactor): use css variable for small font size.
To facilitate reusability and convey meaning.
* docs: rename anatomy doc
* docs: add note about strategies vs constraints
* Updating the images
* Apply suggestions from code review
Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
* Update website/docs/topics/the-anatomy-of-unleash.mdx
* Docs(fix): remove redundant comma
* docs: add link to node js sdk
* docs: mention that a toggle must be active in an env to be enabled
* docs: add note about environments and api keys
* Docs(reword): swap dev and prod in example
* docs: fix typo in the image
* docs: make figures in text full-width
* docs: move environments and API keys call-out to after figure
* docs: add borders to figures
* docs: add image float css idea
* Revert "docs: add image float css idea"
This reverts commit
|
||
|---|---|---|
| .. | ||
| favicon | ||
| add-constraint.png | ||
| add-group-to-project-step-1.png | ||
| add-group-to-project-step-2.png | ||
| add-group-to-project-step-3.png | ||
| add-group-to-project-step-4.png | ||
| add-group-to-project-step-5.png | ||
| add-user-to-group-step-1.png | ||
| add-user-to-group-step-2.png | ||
| add-user-to-group-step-3.png | ||
| admin_configure_api.png | ||
| admin_copy_token.png | ||
| admin_cors.png | ||
| admin_create_token_form.png | ||
| admin_new_api_key_button.png | ||
| admin-authentication.png | ||
| amedia-logo.png | ||
| anatomy-of-unleash-constraint.png | ||
| anatomy-of-unleash-customer-tiers.png | ||
| anatomy-of-unleash-environment.png | ||
| anatomy-of-unleash-environments-strategies2.png | ||
| anatomy-of-unleash-environments-strategies.png | ||
| anatomy-of-unleash-features.png | ||
| anatomy-of-unleash-new-feature-rollout.png | ||
| anatomy-of-unleash-segments.png | ||
| anatomy-of-unleash-strategy.png | ||
| anatomy-of-unleash-variants.png | ||
| api_access_history.png | ||
| api_access_navigation.png | ||
| archive-toggle-delete.png | ||
| archive-toggle-revive.png | ||
| archive-toggle.png | ||
| assign-cpr-step-1.png | ||
| assign-cpr-step-2.png | ||
| assign-cpr-step-3a.png | ||
| assign-cpr-step-3b.png | ||
| budgets.png | ||
| constraints_legal_values.png | ||
| constraints-add-additional.png | ||
| constraints-add-to-strategy.png | ||
| context-field-create-button.png | ||
| context-fields-create.png | ||
| context-fields.png | ||
| control_rollout_multiple_strategies.png | ||
| control_rollout_standard_strategy.png | ||
| control_rollout_userid_strategy.png | ||
| create_feat_impression.png | ||
| create_project1.png | ||
| create_project2.png | ||
| create_project3.png | ||
| create_project4.png | ||
| create_strategy.png | ||
| create_token.png | ||
| create-cpr-step-1.png | ||
| create-cpr-step-2.png | ||
| create-cpr-step-3.png | ||
| create-cpr-step-4.png | ||
| create-pat-1.png | ||
| create-pat-2.png | ||
| create-pat-3.png | ||
| create-pat-4.png | ||
| create-pat-5.png | ||
| create-toggle-add-constraint.png | ||
| create-toggle-add-segment.png | ||
| create-toggle-add-strategy.png | ||
| create-toggle-add-variants.png | ||
| create-toggle-edit-strategy.png | ||
| create-toggle-enable-env.png | ||
| create-toggle-new-toggle.png | ||
| create-ug-step-1.png | ||
| create-ug-step-2.png | ||
| create-ug-step-3.png | ||
| create-ug-step-4.png | ||
| custom-strategy-enable-after.png | ||
| custom-strategy-navigation.png | ||
| dashboard_new.png | ||
| dashboard.png | ||
| default_activation_strategy.png | ||
| docusaurus.png | ||
| docusaurus.svg | ||
| edit-ug-step-2.png | ||
| enable_custom_stickiness.png | ||
| enable-impression-data-existing-toggle.png | ||
| enable-impression-data.png | ||
| environments_api_keys.png | ||
| environments_configure.png | ||
| environments_overview.svg | ||
| environments_strategies.png | ||
| environments_strategy_constraints.png | ||
| favicon.ico | ||
| feature_toggles_menu.png | ||
| finn.jpg | ||
| ft_create_assign_project.png | ||
| ft_create_chose_project.png | ||
| ft_filter_on_project.png | ||
| ft_project_filter.png | ||
| global_audit_log.png | ||
| google_auth_settings.png | ||
| hash_and_normalise.png | ||
| instance_admin_sdk.png | ||
| jira_server_add_existing_toggle.png | ||
| jira_server_add_new_toggle.png | ||
| jira_server_delete_connected_toggles.png | ||
| jira_server_delete_server_confirmation.png | ||
| jira_server_disconnect_toggle_dialog.png | ||
| jira_server_disconnect_toggle.png | ||
| jira_server_edit_server.png | ||
| jira_server_installed_ready_to_go.png | ||
| jira_server_issue_panel_button.png | ||
| jira_server_manage_apps.png | ||
| jira_server_manage_servers.png | ||
| jira_server_manage_unleash_admin.png | ||
| jira_server_toggle_status.png | ||
| jira_upload_app.png | ||
| keykloak_step1-768x347.png | ||
| keykloak_step2b-768x242.png | ||
| keykloak_step3-768x235.png | ||
| keykloak_step4-768x644.png | ||
| Logo_DarkBlue_Transparent_Horizontal.png | ||
| Logo_DarkBlue_Transparent_Portrait.png | ||
| Logo_White_Transparent_Horizontal.png | ||
| Logo_White_Transparent_Vertical.png | ||
| logo-inverted.png | ||
| logo.png | ||
| logo.svg | ||
| nav.jpg | ||
| new_context_field.png | ||
| oidc-unleash.png | ||
| okta_add_application-768x345.png | ||
| okta_configure_saml2.0-768x832.png | ||
| okta_create_new_application-768x467.png | ||
| okta_setup-instructions-768x731.png | ||
| okta-oidc-configure.png | ||
| okta-oidc-create.png | ||
| okta-oidc-details.png | ||
| otovo.png | ||
| playground-detailed-results.png | ||
| playground-form.png | ||
| playground-results.png | ||
| project_concept.png | ||
| project_main_menu.png | ||
| project_menu_item.png | ||
| project_select.png | ||
| projects_button.png | ||
| projects_change_project.png | ||
| projects_delete_button.png | ||
| projects_existing_toggle_dropdown.png | ||
| projects_menu_button.png | ||
| projects_menu_open.png | ||
| projects_menu.png | ||
| projects_new_project.png | ||
| projects_save_new_project.png | ||
| projects_select_dropdown.png | ||
| projects_toggle_project_dropdown.png | ||
| proxy-hosting-all-unleash.svg | ||
| proxy-hosting-customer-multi.svg | ||
| proxy-hosting-customer-single.svg | ||
| proxy-hosting-unleash-api-customer-proxy.svg | ||
| public-invite_signup.png | ||
| public-invite_step2_signed_in.png | ||
| public-signup-step1.png | ||
| public-signup-step2.png | ||
| public-signup-step3-create_link.png | ||
| public-signup-step4_link_Created.png | ||
| rbac.png | ||
| remove-user-from-group-step-1.png | ||
| remove-user-from-group-step-2.png | ||
| reportcard.png | ||
| reporting.png | ||
| saml-2.0-unleash.png | ||
| segments-page.png | ||
| sign-in-google.png | ||
| sign-in.png | ||
| slack_addon_tags.png | ||
| sso-configure-saml.png | ||
| sso-configure.png | ||
| sso-google-secret.png | ||
| sso-oidc-okta.png | ||
| sso-oidc-unleash.png | ||
| sso-oidc-verify.png | ||
| sso-oidc.png | ||
| sso-saml-okta-edit.png | ||
| sso-saml-okta-signout-unleash.png | ||
| sso-saml-okta-signout-url.png | ||
| sso-saml-okta-signout.png | ||
| sso-saml-unleash.png | ||
| strategy_constraints.png | ||
| strategy-constraint-date-after.png | ||
| strategy-constraints.png | ||
| strategy-parameters-ui-controls.png | ||
| Symbol_DarkBlue_Transparent.png | ||
| Symbol_DarkBlue_Transparent.svg | ||
| Symbol_White_Transparent.png | ||
| Symbol_White_Transparent.svg | ||
| The-Unleash-Proxy-API.png | ||
| The-unleash-proxy.png | ||
| timestamp_create_strategy.png | ||
| timestamp_use_strategy.png | ||
| toggle_type_icons.png | ||
| togglelist.png | ||
| undraw_docusaurus_mountain.svg | ||
| undraw_docusaurus_react.svg | ||
| undraw_docusaurus_tree.svg | ||
| unleash_logo.png | ||
| unleash-architecture.svg | ||
| unleash-diagram.png | ||
| unleash-hosted.svg | ||
| unleash-logo-scaled.png | ||
| unleash-oss-logo-v2.png | ||
| unleash-toggle-history.png | ||
| user_admin_add_user_modal.png | ||
| user_admin_list_button.png | ||
| user_admin-add-user.jpg | ||
| userWithId_activation_strategy.png | ||
| variant-creation-form.png | ||
| variants.png | ||
