From 75f90aa1eff44babd7494095ebc962a897004423 Mon Sep 17 00:00:00 2001 From: dovholuknf <46322585+dovholuknf@users.noreply.github.com> Date: Sun, 29 Jan 2023 15:54:27 -0500 Subject: [PATCH] continued refinement of doc --- README.md | 2 +- docs/core-concepts/_category_.json | 8 ++++++++ docs/core-concepts/v0.3_reserved_services.md | 2 +- docs/core-concepts/v0.3_sharing_modes.md | 4 ++-- docs/{getting-started => }/downloads.md | 2 +- docs/getting-started/_category_.json | 8 ++++++++ docs/guides/_category_.json | 8 ++++++++ docs/guides/v0.3_self_hosting_guide.md | 2 +- docs/network/_category_.json | 8 ++++++++ docs/overview.md | 3 ++- website/docusaurus.config.js | 2 +- website/src/css/custom.css | 7 +++++-- 12 files changed, 46 insertions(+), 10 deletions(-) create mode 100644 docs/core-concepts/_category_.json rename docs/{getting-started => }/downloads.md (86%) create mode 100644 docs/getting-started/_category_.json create mode 100644 docs/guides/_category_.json create mode 100644 docs/network/_category_.json diff --git a/README.md b/README.md index f70836a5..8a35b279 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ See the [Concepts and Getting Started Guide](docs/getting-started/v0.3_getting_s The single `zrok` binary contains everything you need to operate `zrok` environments and also host your own service instances. Just add a Ziti network and you're up and running. -See the [v0.3 Quick Start](docs/v0.3_quickstart.md) for details on getting your own `zrok` service instance running. This builds on top of the [Ziti Quick Start](https://docs.openziti.io/docs/learn/quickstarts/network/) to have you running a `zrok` service instance in minutes. +See the [Quick Start](docs/v0.3_quickstart.md) for details on getting your own `zrok` service instance running. This builds on top of the [Ziti Quick Start](https://docs.openziti.io/docs/learn/quickstarts/network/) to have you running a `zrok` service instance in minutes. ## Building diff --git a/docs/core-concepts/_category_.json b/docs/core-concepts/_category_.json new file mode 100644 index 00000000..41bb1e72 --- /dev/null +++ b/docs/core-concepts/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Core Concepts", + "position": 10, + "link": { + "type": "generated-index", + "title": "Tutorial overview" + } +} \ No newline at end of file diff --git a/docs/core-concepts/v0.3_reserved_services.md b/docs/core-concepts/v0.3_reserved_services.md index dec865bc..66904dab 100644 --- a/docs/core-concepts/v0.3_reserved_services.md +++ b/docs/core-concepts/v0.3_reserved_services.md @@ -1,4 +1,4 @@ -# v0.3 Reserved Services +# Reserved Services The `v0.3` series introduces a concept of "reserving" services. The intention is that the `zrok` control plane will support limits on the number of reserved services (and eventually `frontend`instances) that an account is allowed to utilize. Service reservations could also be time-limited, or possibly even bandwidth-limited (the reservation expires after a bandwidth threshold is crossed). diff --git a/docs/core-concepts/v0.3_sharing_modes.md b/docs/core-concepts/v0.3_sharing_modes.md index da030871..f49d2afe 100644 --- a/docs/core-concepts/v0.3_sharing_modes.md +++ b/docs/core-concepts/v0.3_sharing_modes.md @@ -1,4 +1,4 @@ -# v0.3 Public/Private Sharing +# Public/Private Sharing The `v0.3` series introduces new sharing modes, and new types of built-in services. @@ -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) +![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/downloads.md similarity index 86% rename from docs/getting-started/downloads.md rename to docs/downloads.md index 57e7d13a..f72207fb 100644 --- a/docs/getting-started/downloads.md +++ b/docs/downloads.md @@ -1,5 +1,5 @@ --- -sidebar_position: 50 +sidebar_position: 100 --- # Downloads diff --git a/docs/getting-started/_category_.json b/docs/getting-started/_category_.json new file mode 100644 index 00000000..fb3c776b --- /dev/null +++ b/docs/getting-started/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Getting Started", + "position": 20, + "link": { + "type": "generated-index", + "title": "Tutorial overview" + } +} \ No newline at end of file diff --git a/docs/guides/_category_.json b/docs/guides/_category_.json new file mode 100644 index 00000000..fcd9e030 --- /dev/null +++ b/docs/guides/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Guides", + "position": 30, + "link": { + "type": "generated-index", + "title": "Tutorial overview" + } +} \ No newline at end of file diff --git a/docs/guides/v0.3_self_hosting_guide.md b/docs/guides/v0.3_self_hosting_guide.md index ee1fd444..34c5284b 100644 --- a/docs/guides/v0.3_self_hosting_guide.md +++ b/docs/guides/v0.3_self_hosting_guide.md @@ -1,4 +1,4 @@ -# v0.3 Self-Hosting Guide +# Self-Hosting Guide ## Ziti Quickstart diff --git a/docs/network/_category_.json b/docs/network/_category_.json new file mode 100644 index 00000000..4645917d --- /dev/null +++ b/docs/network/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Network", + "position": 60, + "link": { + "type": "generated-index", + "title": "Tutorial overview" + } +} \ No newline at end of file diff --git a/docs/overview.md b/docs/overview.md index 002cb70b..58c5a5ad 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -1,7 +1,8 @@ --- sidebar_position: 0 +sidebar_label: What is zrok --- -# What is zrok +# What is `zrok` ## Overview diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 2a60eed9..5f5e390a 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -87,7 +87,7 @@ const config = { }, { type: 'doc', - docId: 'overview', + docId: 'downloads', position: 'right', label: 'Downloads', }, diff --git a/website/src/css/custom.css b/website/src/css/custom.css index 428581f2..e68ef2ba 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -24,6 +24,9 @@ --code-font-color: #252525; --selection-font-color: #0f023b; --selection-background: #9BF316; + --ifm-menu-color-background-hover: #6747d955; + --ifm-menu-color-background-active: #FF0; + --sidebar-selected: #6747d955; } /* For readability concerns, you should choose a lighter palette in dark mode. */ @@ -37,7 +40,7 @@ --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); + --code-font-color: rgb(197, 160, 247); --selection-color: #0f023b; } @@ -77,7 +80,7 @@ } .menu__link--active:not(.menu__link--sublist) { - background-color: rgba(62,38,147,.1); + background-color: var(--sidebar-selected); } h1, h2, h3, h4, h5, h6 {