From fce2be5731b5a09bf3f8bdeb138c7283761d1663 Mon Sep 17 00:00:00 2001 From: dovholuknf <46322585+dovholuknf@users.noreply.github.com> Date: Sun, 29 Jan 2023 14:28:30 -0500 Subject: [PATCH] reworking docs, rearranging, small edits, etc --- README.md | 2 +- .../v0.3_reserved_services.md | 0 .../{ => core-concepts}/v0.3_sharing_modes.md | 2 +- docs/getting-started/downloads.md | 9 +++++ .../v0.2_account_requests.md | 0 docs/{ => getting-started}/v0.2_quickstart.md | 2 +- .../v0.3_getting_started/getting_started.md | 8 ++-- .../images/zrok_docs_share.png | Bin .../images/zrok_enable_modal.png | Bin .../images/zrok_not_found.png | Bin .../images/zrok_registration_success.png | Bin .../images/zrok_reserved_not_found.png | Bin .../images/zrok_share_reserved.png | Bin .../images/zrok_verify.png | Bin .../images/zrok_web_console_empty.png | Bin .../zrok_web_console_environment_spark.png | Bin .../zrok_web_console_explorer_share.png | Bin .../images/zrok_web_console_share_detail.png | Bin .../zrok_web_console_share_frontend.png | Bin .../images/zrok_web_login.png | Bin .../zrok_web_ui_empty_environment_detail.png | Bin .../images/zrok_web_ui_empty_shares.png | Bin .../images/zrok_web_ui_new_environment.png | Bin .../images/zrok_zoom_to_fit.png | Bin docs/{ => guides}/v0.3_nginx_tls_guide.md | 2 +- docs/{ => guides}/v0.3_self_hosting_guide.md | 10 ++--- docs/index.md | 7 ---- docs/{v0.1_overview.md => overview.md} | 7 +++- website/docusaurus.config.js | 16 +++++++- website/src/css/custom.css | 37 +++++++++++++----- 30 files changed, 69 insertions(+), 33 deletions(-) rename docs/{ => core-concepts}/v0.3_reserved_services.md (100%) rename docs/{ => core-concepts}/v0.3_sharing_modes.md (98%) create mode 100644 docs/getting-started/downloads.md rename docs/{ => getting-started}/v0.2_account_requests.md (100%) rename docs/{ => getting-started}/v0.2_quickstart.md (98%) rename docs/{ => getting-started}/v0.3_getting_started/getting_started.md (98%) rename docs/{ => getting-started}/v0.3_getting_started/images/zrok_docs_share.png (100%) rename docs/{ => getting-started}/v0.3_getting_started/images/zrok_enable_modal.png (100%) rename docs/{ => getting-started}/v0.3_getting_started/images/zrok_not_found.png (100%) rename docs/{ => getting-started}/v0.3_getting_started/images/zrok_registration_success.png (100%) rename docs/{ => getting-started}/v0.3_getting_started/images/zrok_reserved_not_found.png (100%) rename docs/{ => getting-started}/v0.3_getting_started/images/zrok_share_reserved.png (100%) rename docs/{ => getting-started}/v0.3_getting_started/images/zrok_verify.png (100%) rename docs/{ => getting-started}/v0.3_getting_started/images/zrok_web_console_empty.png (100%) rename docs/{ => getting-started}/v0.3_getting_started/images/zrok_web_console_environment_spark.png (100%) rename docs/{ => getting-started}/v0.3_getting_started/images/zrok_web_console_explorer_share.png (100%) rename docs/{ => getting-started}/v0.3_getting_started/images/zrok_web_console_share_detail.png (100%) rename docs/{ => getting-started}/v0.3_getting_started/images/zrok_web_console_share_frontend.png (100%) rename docs/{ => getting-started}/v0.3_getting_started/images/zrok_web_login.png (100%) rename docs/{ => getting-started}/v0.3_getting_started/images/zrok_web_ui_empty_environment_detail.png (100%) rename docs/{ => getting-started}/v0.3_getting_started/images/zrok_web_ui_empty_shares.png (100%) rename docs/{ => getting-started}/v0.3_getting_started/images/zrok_web_ui_new_environment.png (100%) rename docs/{ => getting-started}/v0.3_getting_started/images/zrok_zoom_to_fit.png (100%) rename docs/{ => guides}/v0.3_nginx_tls_guide.md (96%) rename docs/{ => guides}/v0.3_self_hosting_guide.md (97%) delete mode 100644 docs/index.md rename docs/{v0.1_overview.md => overview.md} (99%) diff --git a/README.md b/README.md index 0c771e4c..f70836a5 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ You can be up and sharing using the `zrok.io` service in minutes. Here is a syno * `zrok share` to share resources immediately, simply and securely -See the [Concepts and Getting Started Guide](docs/v0.3_getting_started/getting_started.md) for a full overview. +See the [Concepts and Getting Started Guide](docs/getting-started/v0.3_getting_started/getting_started.md) for a full overview. ## Self-Hosting diff --git a/docs/v0.3_reserved_services.md b/docs/core-concepts/v0.3_reserved_services.md similarity index 100% rename from docs/v0.3_reserved_services.md rename to docs/core-concepts/v0.3_reserved_services.md diff --git a/docs/v0.3_sharing_modes.md b/docs/core-concepts/v0.3_sharing_modes.md similarity index 98% rename from docs/v0.3_sharing_modes.md rename to docs/core-concepts/v0.3_sharing_modes.md index 06ac5c7a..da030871 100644 --- a/docs/v0.3_sharing_modes.md +++ b/docs/core-concepts/v0.3_sharing_modes.md @@ -46,7 +46,7 @@ This allows users to create read/write repositories of files that can be shared The following illustration shows the possibilities available. -![v0.3 Frontend Selection](images/zrok_frontends_v0.3.png) +![v0.3 Frontend Selection](../images/zrok_frontends_v0.3.png) The `*.in.zrok.io` frontend is a "public" frontend, available to all `zrok` users. Most `zrok` installations will want to have at least one public, global frontend for all public, internet-facing ingress traffic for private backend instances. In the underlying data store, the public frontend will have a `name` set to `public` (or some other representative name), allowing users to reference that `frontend` using a friendly label. diff --git a/docs/getting-started/downloads.md b/docs/getting-started/downloads.md new file mode 100644 index 00000000..57e7d13a --- /dev/null +++ b/docs/getting-started/downloads.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 50 +--- + +# Downloads + +Right now all `zrok` binaries are delivered from the release page at GitHub. + +Head over to https://github.com/openziti/zrok/releases/latest to find the latest downloads. \ No newline at end of file diff --git a/docs/v0.2_account_requests.md b/docs/getting-started/v0.2_account_requests.md similarity index 100% rename from docs/v0.2_account_requests.md rename to docs/getting-started/v0.2_account_requests.md diff --git a/docs/v0.2_quickstart.md b/docs/getting-started/v0.2_quickstart.md similarity index 98% rename from docs/v0.2_quickstart.md rename to docs/getting-started/v0.2_quickstart.md index 190862f8..70927cf6 100644 --- a/docs/v0.2_quickstart.md +++ b/docs/getting-started/v0.2_quickstart.md @@ -82,7 +82,7 @@ $ zrok proxy ~/.zrok/proxy.json ``` $ zrok create account -New Username: michael@quigley.com +New Username: user@domain.com New Password: Confirm Password: [ 3.122] INFO main.glob..func1: api token: 9ae56d39a6e96d65a45518b5ea1637a0677581a33ba44bbc3c103f6351ec478fb8185e97a993382ed2daa26720d40b052824dbce5ef38874c82893f33e445b06 diff --git a/docs/v0.3_getting_started/getting_started.md b/docs/getting-started/v0.3_getting_started/getting_started.md similarity index 98% rename from docs/v0.3_getting_started/getting_started.md rename to docs/getting-started/v0.3_getting_started/getting_started.md index f5fc3786..ebadc190 100644 --- a/docs/v0.3_getting_started/getting_started.md +++ b/docs/getting-started/v0.3_getting_started/getting_started.md @@ -124,12 +124,12 @@ $ zrok invite enter and confirm your email address... -> michael.quigley@netfoundry.io -> michael.quigley@netfoundry.io +> user@domain.com +> user@domain.com [ Submit ] -invitation sent to 'michael.quigley@netfoundry.io'! +invitation sent to 'user@domain.com'! ``` The `zrok invite` command presents a small form that allows you to enter (and then confirm) your email address. Tabbing to the `[ Submit ]` button will send the request to your configured `zrok` service. @@ -366,7 +366,7 @@ You use the `zrok reserve` command to create _reserved shares_. Reserved shares ## Self-Hosting a Service Instance -Interested in self-hosting your own `zrok` service instance? See the [self-hosting guide](../v0.3_self_hosting_guide.md) for details. +Interested in self-hosting your own `zrok` service instance? See the [self-hosting guide](../../guides/v0.3_self_hosting_guide.md) for details. [openziti]: https://docs.openziti.io/ "OpenZiti" [ zrok-download]: https://zrok.io "Zrok Download" diff --git a/docs/v0.3_getting_started/images/zrok_docs_share.png b/docs/getting-started/v0.3_getting_started/images/zrok_docs_share.png similarity index 100% rename from docs/v0.3_getting_started/images/zrok_docs_share.png rename to docs/getting-started/v0.3_getting_started/images/zrok_docs_share.png diff --git a/docs/v0.3_getting_started/images/zrok_enable_modal.png b/docs/getting-started/v0.3_getting_started/images/zrok_enable_modal.png similarity index 100% rename from docs/v0.3_getting_started/images/zrok_enable_modal.png rename to docs/getting-started/v0.3_getting_started/images/zrok_enable_modal.png diff --git a/docs/v0.3_getting_started/images/zrok_not_found.png b/docs/getting-started/v0.3_getting_started/images/zrok_not_found.png similarity index 100% rename from docs/v0.3_getting_started/images/zrok_not_found.png rename to docs/getting-started/v0.3_getting_started/images/zrok_not_found.png diff --git a/docs/v0.3_getting_started/images/zrok_registration_success.png b/docs/getting-started/v0.3_getting_started/images/zrok_registration_success.png similarity index 100% rename from docs/v0.3_getting_started/images/zrok_registration_success.png rename to docs/getting-started/v0.3_getting_started/images/zrok_registration_success.png diff --git a/docs/v0.3_getting_started/images/zrok_reserved_not_found.png b/docs/getting-started/v0.3_getting_started/images/zrok_reserved_not_found.png similarity index 100% rename from docs/v0.3_getting_started/images/zrok_reserved_not_found.png rename to docs/getting-started/v0.3_getting_started/images/zrok_reserved_not_found.png diff --git a/docs/v0.3_getting_started/images/zrok_share_reserved.png b/docs/getting-started/v0.3_getting_started/images/zrok_share_reserved.png similarity index 100% rename from docs/v0.3_getting_started/images/zrok_share_reserved.png rename to docs/getting-started/v0.3_getting_started/images/zrok_share_reserved.png diff --git a/docs/v0.3_getting_started/images/zrok_verify.png b/docs/getting-started/v0.3_getting_started/images/zrok_verify.png similarity index 100% rename from docs/v0.3_getting_started/images/zrok_verify.png rename to docs/getting-started/v0.3_getting_started/images/zrok_verify.png diff --git a/docs/v0.3_getting_started/images/zrok_web_console_empty.png b/docs/getting-started/v0.3_getting_started/images/zrok_web_console_empty.png similarity index 100% rename from docs/v0.3_getting_started/images/zrok_web_console_empty.png rename to docs/getting-started/v0.3_getting_started/images/zrok_web_console_empty.png diff --git a/docs/v0.3_getting_started/images/zrok_web_console_environment_spark.png b/docs/getting-started/v0.3_getting_started/images/zrok_web_console_environment_spark.png similarity index 100% rename from docs/v0.3_getting_started/images/zrok_web_console_environment_spark.png rename to docs/getting-started/v0.3_getting_started/images/zrok_web_console_environment_spark.png diff --git a/docs/v0.3_getting_started/images/zrok_web_console_explorer_share.png b/docs/getting-started/v0.3_getting_started/images/zrok_web_console_explorer_share.png similarity index 100% rename from docs/v0.3_getting_started/images/zrok_web_console_explorer_share.png rename to docs/getting-started/v0.3_getting_started/images/zrok_web_console_explorer_share.png diff --git a/docs/v0.3_getting_started/images/zrok_web_console_share_detail.png b/docs/getting-started/v0.3_getting_started/images/zrok_web_console_share_detail.png similarity index 100% rename from docs/v0.3_getting_started/images/zrok_web_console_share_detail.png rename to docs/getting-started/v0.3_getting_started/images/zrok_web_console_share_detail.png diff --git a/docs/v0.3_getting_started/images/zrok_web_console_share_frontend.png b/docs/getting-started/v0.3_getting_started/images/zrok_web_console_share_frontend.png similarity index 100% rename from docs/v0.3_getting_started/images/zrok_web_console_share_frontend.png rename to docs/getting-started/v0.3_getting_started/images/zrok_web_console_share_frontend.png diff --git a/docs/v0.3_getting_started/images/zrok_web_login.png b/docs/getting-started/v0.3_getting_started/images/zrok_web_login.png similarity index 100% rename from docs/v0.3_getting_started/images/zrok_web_login.png rename to docs/getting-started/v0.3_getting_started/images/zrok_web_login.png diff --git a/docs/v0.3_getting_started/images/zrok_web_ui_empty_environment_detail.png b/docs/getting-started/v0.3_getting_started/images/zrok_web_ui_empty_environment_detail.png similarity index 100% rename from docs/v0.3_getting_started/images/zrok_web_ui_empty_environment_detail.png rename to docs/getting-started/v0.3_getting_started/images/zrok_web_ui_empty_environment_detail.png diff --git a/docs/v0.3_getting_started/images/zrok_web_ui_empty_shares.png b/docs/getting-started/v0.3_getting_started/images/zrok_web_ui_empty_shares.png similarity index 100% rename from docs/v0.3_getting_started/images/zrok_web_ui_empty_shares.png rename to docs/getting-started/v0.3_getting_started/images/zrok_web_ui_empty_shares.png diff --git a/docs/v0.3_getting_started/images/zrok_web_ui_new_environment.png b/docs/getting-started/v0.3_getting_started/images/zrok_web_ui_new_environment.png similarity index 100% rename from docs/v0.3_getting_started/images/zrok_web_ui_new_environment.png rename to docs/getting-started/v0.3_getting_started/images/zrok_web_ui_new_environment.png diff --git a/docs/v0.3_getting_started/images/zrok_zoom_to_fit.png b/docs/getting-started/v0.3_getting_started/images/zrok_zoom_to_fit.png similarity index 100% rename from docs/v0.3_getting_started/images/zrok_zoom_to_fit.png rename to docs/getting-started/v0.3_getting_started/images/zrok_zoom_to_fit.png diff --git a/docs/v0.3_nginx_tls_guide.md b/docs/guides/v0.3_nginx_tls_guide.md similarity index 96% rename from docs/v0.3_nginx_tls_guide.md rename to docs/guides/v0.3_nginx_tls_guide.md index fb204fcc..86ec1cb7 100644 --- a/docs/v0.3_nginx_tls_guide.md +++ b/docs/guides/v0.3_nginx_tls_guide.md @@ -1,6 +1,6 @@ # Nginx Reverse Proxy for zrok -I'll assume you have a running zrok controller and public frontend and wish to front both with Nginx providing server TLS. Go back to [the hosting quickstart](v0.2_quickstart.md) if you still need to spin those up. +I'll assume you have a running zrok controller and public frontend and wish to front both with Nginx providing server TLS. Go back to [the hosting quickstart](../getting-started/v0.2_quickstart.md) if you still need to spin those up. ## Choose a Reverse Proxy Address diff --git a/docs/v0.3_self_hosting_guide.md b/docs/guides/v0.3_self_hosting_guide.md similarity index 97% rename from docs/v0.3_self_hosting_guide.md rename to docs/guides/v0.3_self_hosting_guide.md index 2fab9be1..ee1fd444 100644 --- a/docs/v0.3_self_hosting_guide.md +++ b/docs/guides/v0.3_self_hosting_guide.md @@ -169,15 +169,15 @@ This process uses the `frontend` identity created during the bootstrap process t ```bash $ zrok invite -New Email: michael@quigley.com -Confirm Email: michael@quigley.com -invitation sent to 'michael@quigley.com'! +New Email: user@domain.com +Confirm Email: user@domain.com +invitation sent to 'user@domain.com'! ``` If you look at the console output from your `zrok` controller, you'll see a message like this: ``` -[ 238.168] INFO zrok/controller.(*inviteHandler).Handle: account request for 'michael@quigley.com' has registration token 'U2Ewt1UCn3ql' +[ 238.168] INFO zrok/controller.(*inviteHandler).Handle: account request for 'user@domain.com' has registration token 'U2Ewt1UCn3ql' ``` You can access your `zrok` controller's registration UI by pointing a web browser at: @@ -191,7 +191,7 @@ The UI will ask you to set a password for your new account. Go ahead and do that After doing that, I see the following output in my controller console: ``` -[ 516.778] INFO zrok/controller.(*registerHandler).Handle: created account 'michael@quigley.com' with token 'SuGzRPjVDIcF' +[ 516.778] INFO zrok/controller.(*registerHandler).Handle: created account 'user@domain.com' with token 'SuGzRPjVDIcF' ``` Keep track of the token listed above (`SuGzRPjVDIcF`). We'll use this to enable our shell for this `zrok` deployment. diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 66b51d5e..00000000 --- a/docs/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# Zrok - -This is zrok. A globally-distributed, zero trust proxy. - -## Overview - -This is where you'd place overview material. diff --git a/docs/v0.1_overview.md b/docs/overview.md similarity index 99% rename from docs/v0.1_overview.md rename to docs/overview.md index e29d0aca..002cb70b 100644 --- a/docs/v0.1_overview.md +++ b/docs/overview.md @@ -1,6 +1,9 @@ -# zrok v0.1.x +--- +sidebar_position: 0 +--- +# What is zrok -## What Is `zrok`? +## Overview `zrok` is a super-lightweight tool for providing on-demand access to dark, unreachable resources. The super-power of `zrok` is providing a single-step solution to creating ephemeral network connectivity. From an end-user perspective, `zrok` is a tool packaged as a single executable, which can be used as a "shim" to quickly create public endpoints for dark resources. diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 17714994..2a60eed9 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -75,10 +75,22 @@ const config = { items: [ { type: 'doc', - docId: 'index', - position: 'left', + docId: 'overview', + position: 'right', + label: 'What is zrok?', + }, + { + type: 'doc', + docId: 'overview', + position: 'right', label: 'Docs', }, + { + type: 'doc', + docId: 'overview', + position: 'right', + label: 'Downloads', + }, { href: 'https://github.com/openziti/zrok', label: 'GitHub', diff --git a/website/src/css/custom.css b/website/src/css/custom.css index f2bf293a..428581f2 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -20,6 +20,10 @@ --ifm-code-font-size: 95%; --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); --ifm-menu-color: #252525; + --code-background-color: rgba(62,38,147,.1); + --code-font-color: #252525; + --selection-font-color: #0f023b; + --selection-background: #9BF316; } /* For readability concerns, you should choose a lighter palette in dark mode. */ @@ -32,6 +36,9 @@ --ifm-color-primary-lighter: #9af90a; --ifm-color-primary-lightest: #99ff00; --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); + --code-background-color: rgba(76, 55, 123, 0.53); + --code-font-color: rgb(167, 130, 217); + --selection-color: #0f023b; } @media (min-width: 1416px) { @@ -56,17 +63,17 @@ --ifm-navbar-background-color: #0d0235; --ifm-background-color: unset; --ifm-link-color: #9bf316; - --ifm-menu-color: #ffffff; - + --ifm-menu-color: #FFFFFFD4; + } .footer--dark { --ifm-footer-background-color: #0d0235; } -[data-theme='dark'] +[data-theme='dark'] #__docusaurus { - background: linear-gradient(180deg, rgba(14,2,56,1) 0%, rgba(35,16,105,1) 100%); + background: linear-gradient(180deg, rgba(20,12,66,1) 0%, rgba(35,16,105,1) 100%); } .menu__link--active:not(.menu__link--sublist) { @@ -99,7 +106,7 @@ html { [data-theme='dark'] .menu__link { - color: #ffffff; + color: #FFFFFFD4; } .navbar__link:hover, .navbar__link--active { @@ -116,10 +123,13 @@ code { font-weight: 800; white-space: break-spaces; background-color: #f2f2f2; - color: #ff0048; + color2: rgb(167, 130, 217); + color: var(--code-font-color); border-radius: 6px; border-width: 0px; - border-color: rgba(240, 240, 240, 1); + border-color: var(--code-background-color); + background-color2: rgba(76, 55, 123, 0.53); + background-color: var(--code-background-color); } [data-theme='dark'] @@ -134,7 +144,7 @@ h3, h4, h5, h6 { - color: #ffffff; + color: var(--ifm-heading-color); } [data-theme='dark'] @@ -147,5 +157,14 @@ h6 { } a code { - color: #ff0048; + color: rgb(167, 130, 217); } +::-moz-selection { /* Code for Firefox */ + color: var(--selection-font-color); + background: var(--selection-background); +} + +::selection { + color: var(--selection-font-color); + background: var(--selection-background); +} \ No newline at end of file