Skip to content

Commit

Permalink
Updated Preevy docs content
Browse files Browse the repository at this point in the history
  • Loading branch information
Zevi Reinitz committed Dec 6, 2023
1 parent 65a025d commit eaaca0a
Show file tree
Hide file tree
Showing 21 changed files with 160 additions and 241 deletions.
Binary file added site/docs/Livecycle_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 3 additions & 6 deletions site/docs/ci-integration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,8 @@ title: Integrating Preevy with your CI
parent: /ci-integration
---

## **Add 5555555 to your workflow**
## **Automatically create preview environments from your CI Workflow**

Livecycle is flexible by design, so there are several ways to add Livecycle to your 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.

- **Use our open source CLI to create self-hosted preview environments** - Our open source CLI “Preevy” provisions ephemeral preview environments on your cloud provider or Kubernetes cluster with a single command.
- **Add Livecycle to your CI and get deploy previews for every PR** - By adding Livecycle to your CI/CD pipeline, you can automatically provision shareable preview environments for every commit or pull request.
- **Instantly share local containers -** The Livecycle Docker Extension lets you share your local containerized app and get feedback while the code is still on your machine, without the hassle of CI builds or staging servers.
- **Start collaborative review cycles with the team** - Every shared Livecycle preview environment includes built-in feedback tools that collect technical and visual feedback from the team. This means faster, more collaborative review cycles for everyone invovled.
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.
2 changes: 1 addition & 1 deletion site/docs/cloud-providers/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Supported cloud providers",
"label": "Supported Cloud Providers",
"position": 3
}
2 changes: 1 addition & 1 deletion site/docs/cloud-providers/aws-lightsail.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 1
title: AWS Lightsail Driver
title: Deploy to AWS Lightsail
---

# AWS Lightsail Driver
Expand Down
2 changes: 1 addition & 1 deletion site/docs/cloud-providers/azure.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 3
title: Microsoft Azure Driver
title: Deploy to Microsoft Azure
---

# Microsoft Azure Driver
Expand Down
2 changes: 1 addition & 1 deletion site/docs/cloud-providers/gcp-gce.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 2
title: GCP Compute Engine Driver
title: Deploy to Google Cloud Platform
---

# GCP Compute Engine Driver
Expand Down
12 changes: 6 additions & 6 deletions site/docs/cloud-providers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ title: Supported Cloud Providers
parent: /cloud-providers
---

## **recipies index55 to your workflow**
## **Self-hosted deploy previews in your cloud or Kubernetes cluster**

Livecycle is flexible by design, so there are several ways to add Livecycle to your workflow:

- **Use our open source CLI to create self-hosted preview environments** - Our open source CLI “Preevy” provisions ephemeral preview environments on your cloud provider or Kubernetes cluster with a single command.
- **Add Livecycle to your CI and get deploy previews for every PR** - By adding Livecycle to your CI/CD pipeline, you can automatically provision shareable preview environments for every commit or pull request.
- **Instantly share local containers -** The Livecycle Docker Extension lets you share your local containerized app and get feedback while the code is still on your machine, without the hassle of CI builds or staging servers.
- **Start collaborative review cycles with the team** - Every shared Livecycle preview environment includes built-in feedback tools that collect technical and visual feedback from the team. This means faster, more collaborative review cycles for everyone invovled.
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)
2 changes: 1 addition & 1 deletion site/docs/cloud-providers/kube-pod.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 4
title: Kubernetes single Pod driver
title: Deploy to Kubernetes Single Pod
---

# Kubernetes single Pod driver
Expand Down
12 changes: 12 additions & 0 deletions site/docs/dashboard/collaborative-reviews.md
Original file line number Diff line number Diff line change
@@ -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>
11 changes: 4 additions & 7 deletions site/docs/dashboard/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
---
title: The Livevcvle Dashboard
title: The Livecycle Dashboard
parent: /dashboard
---

## **Add 5555555 to your workflow**
## **Share code changes. Collect feedback.**

Livecycle is flexible by design, so there are several ways to add Livecycle to your workflow:
Livecycle makes it easy to not only create previews of your latest changes, but also to share them and collect feedback in context.

- **Use our open source CLI to create self-hosted preview environments** - Our open source CLI “Preevy” provisions ephemeral preview environments on your cloud provider or Kubernetes cluster with a single command.
- **Add Livecycle to your CI and get deploy previews for every PR** - By adding Livecycle to your CI/CD pipeline, you can automatically provision shareable preview environments for every commit or pull request.
- **Instantly share local containers -** The Livecycle Docker Extension lets you share your local containerized app and get feedback while the code is still on your machine, without the hassle of CI builds or staging servers.
- **Start collaborative review cycles with the team** - Every shared Livecycle preview environment includes built-in feedback tools that collect technical and visual feedback from the team. This means faster, more collaborative review cycles for everyone invovled.
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.
92 changes: 0 additions & 92 deletions site/docs/dashboard/remote-debug.md

This file was deleted.

26 changes: 0 additions & 26 deletions site/docs/dashboard/share-environments.md

This file was deleted.

48 changes: 47 additions & 1 deletion site/docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,50 @@
---
title: FAQ
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>
27 changes: 21 additions & 6 deletions site/docs/intro/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,26 @@ title: About Preevy
parent: /intro
---

## **Add 5555555 to your workflow**
## Preevy - Easily create and manage ephemeral environments

Livecycle is flexible by design, so there are several ways to add Livecycle to your workflow:
Preevy is an open source tool from Livecycle designed to easily provision, manage, and expose ephemeral environments for containerized applications in the cloud.

- **Use our open source CLI to create self-hosted preview environments** - Our open source CLI “Preevy” provisions ephemeral preview environments on your cloud provider or Kubernetes cluster with a single command.
- **Add Livecycle to your CI and get deploy previews for every PR** - By adding Livecycle to your CI/CD pipeline, you can automatically provision shareable preview environments for every commit or pull request.
- **Instantly share local containers -** The Livecycle Docker Extension lets you share your local containerized app and get feedback while the code is still on your machine, without the hassle of CI builds or staging servers.
- **Start collaborative review cycles with the team** - Every shared Livecycle preview environment includes built-in feedback tools that collect technical and visual feedback from the team. This means faster, more collaborative review cycles for everyone invovled.
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).
26 changes: 0 additions & 26 deletions site/docs/observability.md

This file was deleted.

Binary file added site/docs/preevy-terminal.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit eaaca0a

Please sign in to comment.