1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-11 00:08:30 +01:00
unleash.unleash/website/static/img
Thomas Heartman 415e1b0596
Source proxy and Edge docs from GitHub (#3122)
## What

The main purpose of this PR is to

1. Delete the proxy docs in this repo and replace them with the proxy's
GitHub readme.
2. Add the docs for Unleash Edge.

### Detailed change description

This PR contains a lot of small changes in a large number of files. To
make it easier to get an overview, here's a detailed description of what
happens where:

#### In the `website/docs`directory

Except for the deletion of the proxy doc, all changes in this directory
are rewriting internal links, so that they point to the newly generated
document instead.

#### `package.json` and `yarn.lock`

When including the documentation for Edge, we also want to render the
mermaid diagrams it uses. Docusaurus supports this via a plugin. All
changes in these files are related to installing that plugin.

#### `docusaurus.config.js`

There's two types of changes in this file:

1. Mermaid-related changes: we ask docusaurus to render mermaid in
markdown files and add the plugin

2. Document generation. There's some rewrites to the sdk doc generation
plus an entirely new section that generates docs for Edge and the proxy

#### `sidebars.js`

Two things:

1. Add the edge docs
2. Move both the Edge and the proxy docs up a level, so that they're
directly under "reference docs" instead of nested inside "unleash
concepts".

#### In the `website/remote-content` directory

These are the remote content files. Previously, all of this lived only
in a `readme-fns.js` file, but with the introduction of Edge and proxy
docs, this has been moved into its own directory and refactored into
three files (`shared`, `sdks`, `edge-proxy`).

#### `custom.css`

Style updates to center mermaid diagrams and provide more space around
them.

#### In `static/img`

The image files that were included in the proxy doc and that have been
deleted.

## Why

For two reasons:

1. Reduce duplication for the proxy. Have one source of truth.
2. Add docs for edge.

## Discussion points and review wishes

This is a big PR, and I don't expect anyone to do a line-by-line review
of it, nor do I think that is particularly useful. Instead, I'd like to
ask reviewers to:

1. Visit the [documentation
preview](https://unleash-docs-git-docs-source-proxy-gh-unleash-team.vercel.app/reference/unleash-proxy)
and have a look at both the proxy docs and the Edge docs. Potentially
have a look at the SDK docs too to verify that everything still works.

2. Consider whether they think moving the proxy and edge docs up a level
(in the sidebar) makes sense.

3. Let me know what slug they'd prefer for the Edge docs. I've gone with
`unleash-edge` for now (so that it's
`docs.getunleash.io/reference/unleash-edge`), but we could potentially
also just use `edge`. WDYT?

4. Read through the detailed changes section.

5. Let me know if they have any other concerns or questions.

## Screenies

The new proxy doc:


![image](https://user-images.githubusercontent.com/17786332/219043145-1c75c83e-4191-45a3-acb5-775d05d13862.png)

The new edge doc:


![image](https://user-images.githubusercontent.com/17786332/219043220-1f5daf13-972e-4d56-8aaf-70ff1812863e.png)
2023-02-16 13:36:28 +01:00
..
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-per-environment.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
change-request-banner.png
change-request-configuration.png
change-request-flow.png
change-request-overview.png
clone-environment-1.png
clone-environment-2.png
clone-environment-3.png
clone-environment-4.png
clone-environment-5.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
service-account-1.png
service-account-2.png
service-account-3.png
service-account-4.png
service-account-5.png
service-account-6.png
service-account-table.png
service-account-tokens.png
setup-keycloak-sync-1.png
setup-keycloak-sync-2.png
setup-keycloak-sync-3.png
setup-keycloak-sync-4.png
setup-keycloak-sync-5.png
setup-keycloak-sync-6.png
setup-keycloak-sync-7.png
setup-keycloak-sync-8.png
setup-keycloak-sync-9.png
setup-keycloak-sync-10.png
setup-keycloak-sync-11.png
setup-keycloak-sync-12.png
setup-keycloak-sync-13.png
setup-keycloak-sync-14.png
setup-keycloak-sync-15.png
setup-sso-group-sync-1.png
setup-sso-group-sync-2.png
setup-sso-group-sync-3.png
setup-sso-group-sync-4.png
setup-sso-group-sync-5.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
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