Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructured docs navigation tree #362

Merged
merged 21 commits into from
Dec 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,9 +159,7 @@ If you already have a locally stored Preevy Profile, it can be migrated to a rem

Once the profile is created, it can be imported to the CI runtime using `preevy init --from <profile-url>`

Examples:
- [Using AWS Lightsail](https://preevy.dev/ci/example-github-actions)
- [Using Google Cloud Engine](https://preevy.dev/ci/example-github-actions-gce)
[Examples](https://preevy.dev/ci)

### Faster builds in CI

Expand Down Expand Up @@ -254,7 +252,7 @@ The following properties are supported, all of them optional:
#### `driver`

<!--lint disable double-link-->
Override the default [driver](https://preevy.dev/category/drivers) to use for this Compose project.
Override the default [driver](https://preevy.dev/deploy-runtimes/) to use for this Compose project.
Available values: `lightsail`, `gce`, `azure`, `kube-pod`.
<!--lint enable double-link-->

Expand All @@ -263,7 +261,7 @@ This value can be overridden per command execution using the `--driver` CLI flag
#### `drivers`

<!--lint disable double-link-->
Override the default the default options per driver for this Compose project. See the [specific driver documentation](https://preevy.dev/category/drivers).
Override the default options per driver for this Compose project. See the [specific driver documentation](https://preevy.dev/deploy-runtimes/).
<!--lint enable double-link-->

These values can be overridden per command execution using the specific driver CLI flags, e.g, `--lightsail-bundle-id=2xlarge_2_0`
Expand Down
2 changes: 1 addition & 1 deletion contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Thanks for considering a contribution!

Preevy is open source and we love to receive contributions from the community. Here are a few ideas for contributions:
Preevy is Open Source and we love to receive contributions from the community. Here are a few ideas for contributions:

* Expand and correct the documentation where needed
* Add examples and how-tos for using Preevy in various scenarios: Guides on adding Preview Environments for your favorite front-end framework, Example CI integrations for more providers.
Expand Down
14 changes: 7 additions & 7 deletions packages/plugin-github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This plugin is bundled with Preevy and enabled by default. To disable it, see [b

## GitHub PR comment for your environment

![Demo comment](./demo.png)
![Demo comment](https://github.com/livecycle/preevy/blob/main/packages/plugin-github/demo.png?raw=true)

### Automatic PR comment at `up` and `down`

Expand Down Expand Up @@ -50,11 +50,11 @@ At runtime, the plugin will attempt to detect the configuration it needs from en

The plugin can automatically detect its configuration when running in a CI provider supported by `@preevy/core`:

* [GitHub Actions](../core/src/ci-providers/github-actions.ts)
* [GitLab Actions](../core/src/ci-providers/gitlab.ts)
* [Circle CI](../core/src/ci-providers/circle.ts)
* [Travis CI](../core/src/ci-providers/travis.ts)
* [Azure Pipelines](../core/src/ci-providers/azure-pipelines.ts)
* [GitHub Actions](https://github.com/livecycle/preevy/tree/main/packages/core/src/ci-providers/github-actions.ts)
* [GitLab Actions](https://github.com/livecycle/preevy/tree/main/packages/core/src/ci-providers/gitlab.ts)
* [Circle CI](https://github.com/livecycle/preevy/tree/main/packages/core/src/ci-providers/circle.ts)
* [Travis CI](https://github.com/livecycle/preevy/tree/main/packages/core/src/ci-providers/travis.ts)
* [Azure Pipelines](https://github.com/livecycle/preevy/tree/main/packages/core/src/ci-providers/azure-pipelines.ts)

To disable auto-detection, specify `detect: false` at the plugin configuration in the Docker Compose file.

Expand Down Expand Up @@ -131,7 +131,7 @@ The following flags can be specified at the Preevy CLI:
The generated PR comment can be customized by specifying a template in your Docker Compose file, or in a separate file (see above). The template is rendered by [`nunjucks`](https://mozilla.github.io/nunjucks/templating.html) and receives a context containing a `urls` property which is one of the following:

* `undefined`: The environment is being deleted, or the `uncomment` command has been invoked.
* Otherwise, the result of the [preevy `urls` command](../cli/README.md#preevy-urls-service-port): an array of `{ service: string; port: number; url: string; project: string }`
* Otherwise, the result of the [preevy `urls` command](https://github.com/livecycle/preevy/blob/main/packages/cli/README.md#preevy-urls-service-port): an array of `{ service: string; port: number; url: string; project: string }`

Here is an example of a configuration file containing a customized template:

Expand Down
8 changes: 8 additions & 0 deletions site/docs/FAQs/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "FAQ",
"position": 15.1,
"link": {
"type": "generated-index"
}

}
51 changes: 51 additions & 0 deletions site/docs/FAQs/docker-extension.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: FAQ - Docker Extension
sidebar_label: Docker Extension
sidebar_position: 15.1
---

## Common questions about using the Livecycle Docker Extension

<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>
8 changes: 8 additions & 0 deletions site/docs/FAQs/livecycle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: FAQ - Dashboard
sidebar_label: Dashboard
sidebar_position: 15.2
---

## Common questions about using The Livecycle Dashboard

8 changes: 8 additions & 0 deletions site/docs/FAQs/preevy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: FAQ - Preevy CLI
sidebar_label: Preevy CLI
sidebar_position: 15
---

## Common questions about using the Preevy CLI

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.
38 changes: 0 additions & 38 deletions site/docs/benefits.md

This file was deleted.

7 changes: 2 additions & 5 deletions site/docs/ci/_category_.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
{
"label": "CI",
"position": 2,
"link": {
"type": "generated-index"
}
"label": "Integrating with your CI",
"position": 1.3
}
File renamed without changes
8 changes: 0 additions & 8 deletions site/docs/ci/example-github-actions-gce.md

This file was deleted.

138 changes: 0 additions & 138 deletions site/docs/ci/example-github-actions.md

This file was deleted.

Loading
Loading