Restructured docs navigation tree

site/docs/ci-integration/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Integrating with your CI",
+  "position": 1.3
+}

site/docs/integrations/github-plugin.md → site/docs/ci-integration/github-plugin.md

@@ -1,4 +1,5 @@
 ---
+sidebar_position: 3
 title: GitHub Plugin
 ---
 

site/docs/ci-integration/index.md

@@ -0,0 +1,10 @@
+---
+title: Integrating Preevy with your CI
+parent: /ci-integration
+---
+
+## **Automatically create preview environments from your CI Workflow**
+
+Preevy is designed to be easily run in CI workflows, such as [GH Actions](https://github.com/features/actions), [Circle CI](https://circleci.com/) and others. This automatically creates shareable preview environments for every upcoming pull request and code change.
+
+By sharing [profiles](https://preevy.dev/intro/under-the-hood#profile-configuration), Preevy is able to easily deploy to the same VM when new code is pushed to some branch.

site/docs/cli-reference/_category_.json

@@ -1,4 +1,4 @@
 {
   "label": "CLI Reference",
-  "position": 8
+  "position": 5
 }

site/docs/cloud-providers/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Supported Cloud Providers",
+  "position": 3
+}

site/docs/drivers/aws-lightsail.md → site/docs/cloud-providers/aws-lightsail.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 1
-title: AWS Lightsail Driver
+title: Deploy to AWS Lightsail
 ---
 
 # AWS Lightsail Driver

site/docs/drivers/azure.md → site/docs/cloud-providers/azure.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 3
-title: Microsoft Azure Driver
+title: Deploy to Microsoft Azure
 ---
 
 # Microsoft Azure Driver

site/docs/drivers/gcp-gce.md → site/docs/cloud-providers/gcp-gce.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 2
-title: GCP Compute Engine Driver
+title: Deploy to Google Cloud Platform
 ---
 
 # GCP Compute Engine Driver

site/docs/cloud-providers/index.md

@@ -0,0 +1,13 @@
+---
+title: Supported Cloud Providers
+parent: /cloud-providers
+---
+
+## **Self-hosted deploy previews in your cloud or Kubernetes cluster**
+
+
+Preevy allows you to easily provision preview environments for your Docker Compose applications to the cloud provider or Kubernetes cluster you're using:
+   - For AWS: use `aws configure`. See [AWS lightsail credentials configurations](/drivers/aws-lightsail#credentials-configuration).
+   - For GCP: use `gcloud auth application-default login`. See [GCP credentials configuration](/drivers/gcp-gce#credentials-configuration)
+   - For Azure: use `az login`. See [Azure credentials configuration](/drivers/azure#credentials-configuration)
+   - For Kubernetes: See [Kubernetes credentials configuration](/drivers/kube-pod#requirements)

site/docs/drivers/kube-pod.md → site/docs/cloud-providers/kube-pod.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 4
-title: Kubernetes single Pod driver
+title: Deploy to Kubernetes Single Pod
 ---
 
 # Kubernetes single Pod driver

site/docs/local-development.md → site/docs/contribute-to-open-source.md

@@ -1,6 +1,6 @@
 ---
-title: Local Development
-sidebar_position: 9
+title: Contribute to Preevy Open Source
+sidebar_position: 8
 ---
 
 # Setting up a local dev environment

site/docs/dashboard/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "The Dashboard",
+  "position": 10
+}

site/docs/dashboard/collaborative-reviews.md

@@ -0,0 +1,12 @@
+---
+sidebar_position: 2
+title: Collaborative reviews
+---
+
+## Collaborative reviews
+
+Livecycle makes it easy to not only create previews of your latest changes, but also to share them and collect feedback in context. 
+
+Each of Livecycle's shared preview environments include built-in tools that enable technical teammates to review changes and access services from a browser, so they can see real-time logging, catch errors and execute commands in a terminal, and you can collaboratively fix issues mug earlier in the development lifecycle.
+
+<iframe width="560" height="315" src="https://www.youtube.com/embed/_grdYVad_cM?si=G0HXS6kOV3Cwsxgh" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

site/docs/dashboard/index.md

@@ -0,0 +1,10 @@
+---
+title: The Livecycle Dashboard
+parent: /dashboard
+---
+
+## **Share code changes. Collect feedback.**
+
+Livecycle makes it easy to not only create previews of your latest changes, but also to share them and collect feedback in context.
+
+Using the Dashboard, you can invite teammates to ephemeral environments to review and provide feedback. Each team member can see the open projects assigned to them and review changes in their browser.

site/docs/integrations/docker-extension.md → site/docs/docker-extension.md

@@ -1,5 +1,6 @@
 ---
 title: Livecycle Docker Extension
+sidebar_position: 11
 ---
 
 # Livecycle Docker Extension 🐳

site/docs/faq.md

@@ -1,4 +1,50 @@
 ---
 title: FAQ
-sidebar_position: 6
----
+sidebar_position: 15
+---
+
+## Common questions about using Preevy
+
+<details>
+  <summary>What is the difference between the Livecycle Docker Extension and Ngrok?</summary>
+
+  The Livecycle Docker Extension is integrated with Docker, and provides a smoother experience for Docker users.  
+  Consistent URLs, private environments, organizations and Google/Github authentication are supported out of the box.  
+  Livecycle dashboard provides debugging capabilities that includes log inspection, shell access, and container inspection.  
+  Lastly, integration with the Preevy CLI allows you to create preview environments for Pull Requests - remote ephemeral environments that can be used when your development machine is offline.
+</details>
+
+<details>
+  <summary>Which frameworks and languages does Livecycle support?</summary>
+
+  Livecycle is language and framework agnostic. It works with anything that runs in a Docker container.
+</details>
+
+<details>
+  <summary>What security features does the Livecycle Docker extension offer?</summary>
+
+  The Livecycle Docker Extension uses a secure <a href="https://livecycle.io/blogs/preevy-proxy-service-2/" target="_blank">SSH tunnel</a> to expose your local development environment using Livecycle's tunnel server, which is only accessible using HTTPS.
+
+  You can enable private URLs to restrict access to your environment.
+</details>
+
+<details>
+  <summary>How do I get started with the Livecycle Docker Extension?</summary>
+
+  You can get started with the Livecycle Docker Extension by following the steps in the Getting Started section of this document.
+</details>
+
+<details>
+  <summary>What makes the Livecycle Docker Extension different from other tools?</summary>
+
+  Livecycle Docker extension is integrated with the Preevy CLI and the Livecycle managed service.
+  Using the Preevy CLI, you can provision remote ephemeral environments that can be used in addition to sharing local environments.  
+  This functionality can also be used in your CI pipeline to provision preview environments for Pull Requests.  
+  The Livecycle managed service adds additional layers of management, collaboration, review and debugging on top of shared environments.  
+</details>
+
+<details>
+  <summary>How do I get support for the Livecycle Docker Extension?</summary>
+
+  Join the <a href="https://community.livecycle.io" target="_blank">Livecycle Community</a> on Slack to get support for the Livecycle Docker Extension.
+</details>

site/docs/intro/getting-started.mdx → site/docs/getting-started.md

@@ -1,22 +1,8 @@
 ---
-sidebar_position: 1
-parent: /
-slug: /
-title: Getting started
-hide_title: true
+title: Installing the Preevy CLI
+sidebar_position: 1.2
 ---
 
-import { Logo } from "@site/src/components/Logo";
-
-<div>
-  <h1 style={{marginTop: "1.25rem", marginBottom: "0.25rem", lineHeight: "38px"}}>
-    <Logo /> Preevy
-  </h1>
-  <p style={{ fontSize: "14px" }}>
-    by <a href="https://livecycle.io">Livecycle</a>
-  </p>
-</div>
-
 <span style={{ fontSize: "x-large" }}>
   Provision <span style={{ fontStyle: "italic" }}>preview environments</span>{" "}
   for Docker Compose applications with minimal configuration

site/docs/intro/_category_.json

@@ -1,7 +1,4 @@
 {
-  "label": "Introduction",
-  "position": 1,
-  "link": {
-    "type": "generated-index"
-  }
+  "label": "Intro to Preevy",
+  "position": 1.1
 }

site/docs/intro/index.md

@@ -0,0 +1,28 @@
+---
+title: About Preevy
+parent: /intro
+---
+
+## Preevy - Easily create and manage ephemeral environments
+
+Preevy is an open source tool from Livecycle designed to easily provision, manage, and expose ephemeral environments for containerized applications in the cloud.
+
+These environments are inexpensive, easy to integrate, customizable, and accessible for both technical and non-technical users.
+
+It’s simple, flexible, and doesn’t require deep DevOps knowledge, making it ideal for adding preview environments to your “pull/merge request” flows.
+
+Preevy can deploy your app with public or protected access, on the public internet or inside your existing private network.
+
+### Benefits of working with Preevy
+
+Deploying a preview environment per Pull Request offers a range of benefits:
+
+- 🌍 **Universal Access:** Just by sharing a URL, you can allow anyone to try your product revision on any device.
+- 📩 **Effortless Asynchronous Updates:** Keep non-technical stakeholders in the loop without coordinating synchronous meetings.
+- 🎨 **Hassle-free Design Reviews:** Designers can verify implementation independently, minimizing interruptions.
+- 🚀 **Parallel E2E Tests:** Use external test agents against preview environments expedite the testing process.
+- 💡 **Streamlined Feedback Cycle:** Preview environments let your team engage with and feedback on new features early in the pipeline.
+- 🧪 **Non-production Experimentation:** Develop and share unique versions of your product for presentations, examples, or tests.
+- 🔐 **Secure Collaboration:** Generate private sandboxes to share with external stakeholders, ensuring secure collaborative efforts.
+
+Read more about the Preevy [origin story and motivation](/intro/motivation).

site/docs/roadmap.md

@@ -1,6 +1,6 @@
 ---
 title: Roadmap
-sidebar_position: 7
+sidebar_position: 14
 ---
 
 # Roadmap

site/docs/security.md

@@ -0,0 +1,28 @@
+---
+title: Security
+sidebar_position: 12
+---
+## Security
+
+In case you find a security issue or have something you would like to discuss, refer to our [security policy](https://github.com/livecycle/preevy/blob/main/security.md).
+
+### Private environments
+
+Preevy can add an authentication layer to your provisioned environments. When you configure your service as [private](https://preevy.dev/recipes/private-services/) the Tunnel Server restricts access based on a pre-shared secret or a Livecycle login (SSO via Google/Microsoft/GitHub).
+
+### Notice on preview environments exposure
+
+Services on provisioned environments are not exposed directly, but rather via a [tunnel](https://livecycle.io/blogs/preevy-proxy-service-2/) created by the tunneling server.
+
+Every Compose service is exposed individually with a generated URL in the following format:
+`https://{service}-{[port]}-{env-id}-{client-id}.{tunnel-server-domain}`. If the service exposes a single port, the `port` part is omitted. See [here](https://livecycle.io/blogs/preevy-proxy-service-1/) for a more detailed explanation.
+
+<!--lint disable awesome-list-item-->
+- `env-id` can be specified using the `--id` flag of the `preevy up` command, or automatically generated by git context.
+- `client-id` is a random identifier based on the profile's public tunneling SSH key (generated in `preevy init`).
+- `tunnel-service-domain` is where the tunnel service is hosted. It can be specified using the `--tunnel-url` flag of the `preevy up` command, and defaults to our free service at `*.livecycle.run`.
+<!--lint enable awesome-list-item-->
+
+### Network isolation
+
+The Tunnel Server can be deployed on a your private network (e.g, VPC), which access to your environments at the network level.

site/docs/support.md

@@ -0,0 +1,16 @@
+---
+title: Contact us
+sidebar_position: 16
+---
+
+# Conact us
+
+## Any questions? Get in touch!
+
+- [Join the Livecycle Slack community](https://community.livecycle.io/) to ask questions speak to the team and other Livecycle users
+
+- [Follow us on X (Twitter)](https://twitter.com/get_livecycle)
+
+- [Follow us on LinkedIn](https://www.linkedin.com/company/livecycleio/)
+
+- [Check out our YouTube channel](https://www.youtube.com/@getlivecycle)

site/docs/telemetry.md

@@ -0,0 +1,16 @@
+---
+title: Telemetry
+sidebar_position: 13
+---
+
+# Telemetry
+
+The Preevy CLI collects telemetry data to help us understand product usage and direct future development.
+
+The data collected is anonymous and cannot be used to uniquely identify a user. Access to the data is limited to Livecycle's employees and not shared with 3rd parties.
+
+To see the collected data, set the environment variable `PREEVY_TELEMETRY_FILE` to a filename.
+
+We appreciate the usage data sent to us as - it's the most basic and raw type of feedback we get from our users. However, if you are concerned about sending out data, you may choose to disable telemetry.
+
+Telemetry collection can be disabled by setting the environment variable `PREEVY_DISABLE_TELEMETRY` to 1 or true.

site/docs/troubleshooting/_category_.json

@@ -1,7 +1,4 @@
 {
   "label": "Troubleshooting",
-  "position": 5,
-  "link": {
-    "type": "generated-index"
-  }
+  "position": 7
 }