mirror of
https://github.com/openziti/zrok.git
synced 2024-12-22 14:50:55 +01:00
continued refinement of doc
This commit is contained in:
parent
fce2be5731
commit
75f90aa1ef
@ -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
|
||||
|
||||
|
8
docs/core-concepts/_category_.json
Normal file
8
docs/core-concepts/_category_.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Core Concepts",
|
||||
"position": 10,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"title": "Tutorial overview"
|
||||
}
|
||||
}
|
@ -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).
|
||||
|
||||
|
@ -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.
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 50
|
||||
sidebar_position: 100
|
||||
---
|
||||
|
||||
# Downloads
|
8
docs/getting-started/_category_.json
Normal file
8
docs/getting-started/_category_.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Getting Started",
|
||||
"position": 20,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"title": "Tutorial overview"
|
||||
}
|
||||
}
|
8
docs/guides/_category_.json
Normal file
8
docs/guides/_category_.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Guides",
|
||||
"position": 30,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"title": "Tutorial overview"
|
||||
}
|
||||
}
|
@ -1,4 +1,4 @@
|
||||
# v0.3 Self-Hosting Guide
|
||||
# Self-Hosting Guide
|
||||
|
||||
## Ziti Quickstart
|
||||
|
||||
|
8
docs/network/_category_.json
Normal file
8
docs/network/_category_.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Network",
|
||||
"position": 60,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"title": "Tutorial overview"
|
||||
}
|
||||
}
|
@ -1,7 +1,8 @@
|
||||
---
|
||||
sidebar_position: 0
|
||||
sidebar_label: What is zrok
|
||||
---
|
||||
# What is zrok
|
||||
# What is `zrok`
|
||||
|
||||
## Overview
|
||||
|
||||
|
@ -87,7 +87,7 @@ const config = {
|
||||
},
|
||||
{
|
||||
type: 'doc',
|
||||
docId: 'overview',
|
||||
docId: 'downloads',
|
||||
position: 'right',
|
||||
label: 'Downloads',
|
||||
},
|
||||
|
@ -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 {
|
||||
|
Loading…
Reference in New Issue
Block a user