Merge pull request #189 from openziti/doc-updates

updates to doc

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
 

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.
 

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.
 

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"

docs/getting-started/_category_.json

@@ -1,7 +0,0 @@
-{
-  "label": "Getting Started",
-  "position": 10,
-  "link": {
-    "type": "generated-index",
-  }
-}

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',
           },

website/src/pages/index.js

@@ -2,5 +2,5 @@ import React from 'react';
 import {Redirect} from '@docusaurus/router';
 
 export default function Home () {
-    return <Redirect to="/docs/overview" />;
+    return <Redirect to="/docs/getting-started" />;
 };