diff --git a/README.md b/README.md index 3bf26333..1e3d5d28 100644 --- a/README.md +++ b/README.md @@ -34,11 +34,11 @@ See the [Concepts and Getting Started Guide](docs/getting-started/getting_starte The single `zrok` binary contains everything you need to operate `zrok` environments and also host your own service instances. Just add an OpenZiti network and you're up and running. -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 [OpenZiti 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/getting-started/getting_started.md) for details on getting your own `zrok` service instance running. This builds on top of the [OpenZiti Quick Start](https://docs.openziti.io/docs/learn/quickstarts/network/) to have you running a `zrok` service instance in minutes. ## Building -If you are interested in building `zrok` for yourself instead of using a released package, please rerfer to [BUILD.md](./BUIlD.md) +If you are interested in building `zrok` for yourself instead of using a released package, please rerfer to [BUILD.md](./BUILD.md) ## Contributing diff --git a/docs/network/_category_.json b/docs/_attic/network/_category_.json similarity index 100% rename from docs/network/_category_.json rename to docs/_attic/network/_category_.json diff --git a/docs/network/prod/ziti-ctrl.service b/docs/_attic/network/prod/ziti-ctrl.service similarity index 100% rename from docs/network/prod/ziti-ctrl.service rename to docs/_attic/network/prod/ziti-ctrl.service diff --git a/docs/network/prod/ziti-ctrl.yml b/docs/_attic/network/prod/ziti-ctrl.yml similarity index 100% rename from docs/network/prod/ziti-ctrl.yml rename to docs/_attic/network/prod/ziti-ctrl.yml diff --git a/docs/network/prod/ziti-router0.service b/docs/_attic/network/prod/ziti-router0.service similarity index 100% rename from docs/network/prod/ziti-router0.service rename to docs/_attic/network/prod/ziti-router0.service diff --git a/docs/network/prod/ziti-router0.yml b/docs/_attic/network/prod/ziti-router0.yml similarity index 100% rename from docs/network/prod/ziti-router0.yml rename to docs/_attic/network/prod/ziti-router0.yml diff --git a/docs/network/prod/zrok-access-public.service b/docs/_attic/network/prod/zrok-access-public.service similarity index 100% rename from docs/network/prod/zrok-access-public.service rename to docs/_attic/network/prod/zrok-access-public.service diff --git a/docs/network/prod/zrok-ctrl.service b/docs/_attic/network/prod/zrok-ctrl.service similarity index 100% rename from docs/network/prod/zrok-ctrl.service rename to docs/_attic/network/prod/zrok-ctrl.service diff --git a/docs/network/prod/zrok-ctrl.yml b/docs/_attic/network/prod/zrok-ctrl.yml similarity index 100% rename from docs/network/prod/zrok-ctrl.yml rename to docs/_attic/network/prod/zrok-ctrl.yml diff --git a/docs/network/prod/zrok.io-network-skeleton.md b/docs/_attic/network/prod/zrok.io-network-skeleton.md similarity index 100% rename from docs/network/prod/zrok.io-network-skeleton.md rename to docs/_attic/network/prod/zrok.io-network-skeleton.md diff --git a/docs/overview.md b/docs/_attic/overview.md similarity index 99% rename from docs/overview.md rename to docs/_attic/overview.md index b3954bd2..d098ac63 100644 --- a/docs/overview.md +++ b/docs/_attic/overview.md @@ -41,7 +41,7 @@ This URL can be shared with anyone, anywhere, allowing access to the developer's At a high level, the `zrok` stack looks like this: -![zrok v0.1 overview](images/zrok_v0.1_overview.png) +![zrok v0.1 overview](../images/zrok_v0.1_overview.png) Let's discuss a couple of the flows through the above use case and talk about what's happening. diff --git a/docs/sharing/_category_.json b/docs/_attic/sharing/_category_.json similarity index 100% rename from docs/sharing/_category_.json rename to docs/_attic/sharing/_category_.json diff --git a/docs/sharing/reserved_services.md b/docs/_attic/sharing/reserved_services.md similarity index 100% rename from docs/sharing/reserved_services.md rename to docs/_attic/sharing/reserved_services.md diff --git a/docs/sharing/sharing_modes.md b/docs/_attic/sharing/sharing_modes.md similarity index 98% rename from docs/sharing/sharing_modes.md rename to docs/_attic/sharing/sharing_modes.md index 836ef283..efb8161a 100644 --- a/docs/sharing/sharing_modes.md +++ b/docs/_attic/sharing/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. -![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/v0.2_account_requests.md b/docs/_attic/v0.2_account_requests.md similarity index 100% rename from docs/getting-started/v0.2_account_requests.md rename to docs/_attic/v0.2_account_requests.md diff --git a/docs/getting-started/getting_started.md b/docs/getting-started.md similarity index 98% rename from docs/getting-started/getting_started.md rename to docs/getting-started.md index d813c2a6..536c58a7 100644 --- a/docs/getting-started/getting_started.md +++ b/docs/getting-started.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 0 +--- # Getting Started with zrok `zrok` is a next-generation sharing platform built on top of [OpenZiti](https://github.com/openziti/ziti/stargazers), a programmable zero trust network overlay. `zrok` is an _OpenZiti Native Application_. @@ -13,7 +16,7 @@ Let's take a look at how to get started with `zrok`. ## Downloading zrok -In order to use `zrok`, you will need a `zrok` executable. [Download](../downloads.md) a binary executable package for your platform at https://zrok.io. +In order to use `zrok`, you will need a `zrok` executable. [Download](downloads.md) a binary executable package for your platform at https://zrok.io. > Releases are also available from the `zrok` project repository on Github: https://github.com/openziti/zrok @@ -366,7 +369,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](../guides/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/getting-started/_category_.json b/docs/getting-started/_category_.json deleted file mode 100644 index 90164dbe..00000000 --- a/docs/getting-started/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Getting Started", - "position": 10, - "link": { - "type": "generated-index", - } -} \ No newline at end of file diff --git a/docs/getting-started/images/zrok_docs_share.png b/docs/images/zrok_docs_share.png similarity index 100% rename from docs/getting-started/images/zrok_docs_share.png rename to docs/images/zrok_docs_share.png diff --git a/docs/getting-started/images/zrok_enable_modal.png b/docs/images/zrok_enable_modal.png similarity index 100% rename from docs/getting-started/images/zrok_enable_modal.png rename to docs/images/zrok_enable_modal.png diff --git a/docs/getting-started/images/zrok_not_found.png b/docs/images/zrok_not_found.png similarity index 100% rename from docs/getting-started/images/zrok_not_found.png rename to docs/images/zrok_not_found.png diff --git a/docs/getting-started/images/zrok_registration_success.png b/docs/images/zrok_registration_success.png similarity index 100% rename from docs/getting-started/images/zrok_registration_success.png rename to docs/images/zrok_registration_success.png diff --git a/docs/getting-started/images/zrok_reserved_not_found.png b/docs/images/zrok_reserved_not_found.png similarity index 100% rename from docs/getting-started/images/zrok_reserved_not_found.png rename to docs/images/zrok_reserved_not_found.png diff --git a/docs/getting-started/images/zrok_share_reserved.png b/docs/images/zrok_share_reserved.png similarity index 100% rename from docs/getting-started/images/zrok_share_reserved.png rename to docs/images/zrok_share_reserved.png diff --git a/docs/getting-started/images/zrok_verify.png b/docs/images/zrok_verify.png similarity index 100% rename from docs/getting-started/images/zrok_verify.png rename to docs/images/zrok_verify.png diff --git a/docs/getting-started/images/zrok_web_console_empty.png b/docs/images/zrok_web_console_empty.png similarity index 100% rename from docs/getting-started/images/zrok_web_console_empty.png rename to docs/images/zrok_web_console_empty.png diff --git a/docs/getting-started/images/zrok_web_console_environment_spark.png b/docs/images/zrok_web_console_environment_spark.png similarity index 100% rename from docs/getting-started/images/zrok_web_console_environment_spark.png rename to docs/images/zrok_web_console_environment_spark.png diff --git a/docs/getting-started/images/zrok_web_console_explorer_share.png b/docs/images/zrok_web_console_explorer_share.png similarity index 100% rename from docs/getting-started/images/zrok_web_console_explorer_share.png rename to docs/images/zrok_web_console_explorer_share.png diff --git a/docs/getting-started/images/zrok_web_console_share_detail.png b/docs/images/zrok_web_console_share_detail.png similarity index 100% rename from docs/getting-started/images/zrok_web_console_share_detail.png rename to docs/images/zrok_web_console_share_detail.png diff --git a/docs/getting-started/images/zrok_web_console_share_frontend.png b/docs/images/zrok_web_console_share_frontend.png similarity index 100% rename from docs/getting-started/images/zrok_web_console_share_frontend.png rename to docs/images/zrok_web_console_share_frontend.png diff --git a/docs/getting-started/images/zrok_web_login.png b/docs/images/zrok_web_login.png similarity index 100% rename from docs/getting-started/images/zrok_web_login.png rename to docs/images/zrok_web_login.png diff --git a/docs/getting-started/images/zrok_web_ui_empty_environment_detail.png b/docs/images/zrok_web_ui_empty_environment_detail.png similarity index 100% rename from docs/getting-started/images/zrok_web_ui_empty_environment_detail.png rename to docs/images/zrok_web_ui_empty_environment_detail.png diff --git a/docs/getting-started/images/zrok_web_ui_empty_shares.png b/docs/images/zrok_web_ui_empty_shares.png similarity index 100% rename from docs/getting-started/images/zrok_web_ui_empty_shares.png rename to docs/images/zrok_web_ui_empty_shares.png diff --git a/docs/getting-started/images/zrok_web_ui_new_environment.png b/docs/images/zrok_web_ui_new_environment.png similarity index 100% rename from docs/getting-started/images/zrok_web_ui_new_environment.png rename to docs/images/zrok_web_ui_new_environment.png diff --git a/docs/getting-started/images/zrok_zoom_to_fit.png b/docs/images/zrok_zoom_to_fit.png similarity index 100% rename from docs/getting-started/images/zrok_zoom_to_fit.png rename to docs/images/zrok_zoom_to_fit.png diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 4ef90826..0490cb58 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -74,13 +74,13 @@ const config = { items: [ { type: 'doc', - docId: 'overview', + docId: 'getting-started', position: 'right', label: 'What is zrok?', }, { type: 'doc', - docId: 'overview', + docId: 'getting-started', position: 'right', label: 'Docs', }, diff --git a/website/src/pages/index.js b/website/src/pages/index.js index 91bb63cf..07bdf754 100644 --- a/website/src/pages/index.js +++ b/website/src/pages/index.js @@ -2,5 +2,5 @@ import React from 'react'; import {Redirect} from '@docusaurus/router'; export default function Home () { - return ; + return ; }; \ No newline at end of file