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

Conversation

zevireinitz
Copy link
Contributor

Updating the preevy docs

[Is this a bugfix/feature/doc-improvement?]

This is a

  • Doc improvement

@zevireinitz zevireinitz marked this pull request as draft December 6, 2023 12:55
@zevireinitz zevireinitz marked this pull request as ready for review December 6, 2023 17:57
@zevireinitz zevireinitz requested a review from royra December 6, 2023 17:57
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

was this file deleted, renamed, split? where should the old link redirect to?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

redirect to preevy.dev root

site/docs/ci-integration/index.md Outdated Show resolved Hide resolved
site/docs/cloud-providers/index.md Outdated Show resolved Hide resolved
site/docs/faq.md Outdated Show resolved Hide resolved
site/docs/faq.md Outdated Show resolved Hide resolved

## 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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: capitalization

Suggested change
Preevy is an open source tool from Livecycle designed to easily provision, manage, and expose ephemeral environments for containerized applications in the cloud.
Preevy is an Open Source tool from Livecycle designed to easily provision, manage, and expose ephemeral environments for containerized applications in the cloud.

site/docs/security.md Outdated Show resolved Hide resolved
site/docs/support.md Outdated Show resolved Hide resolved
site/docs/telemetry.md Outdated Show resolved Hide resolved
site/docs/welcome.mdx Outdated Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The GitHub plugin doesn't exactly fall under "CI integration". It provides several features that are related to GitHub. Most are useful in CI, but that could be said about anything in Preevy.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this not the last step in a standard CI integration? Where else should we include it?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

re: rename from "driver" to "cloud provider" - Kubernetes doesn't technically fall under the category of "cloud provider". If "driver" sounds too ambiguous, may "environment provider" is better? dunno.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thats fine. I can go with that

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: Deploy to Kubernetes Single Pod
title: Deploy to Kubernetes

- add redirect plugin
- fixed links to renamed docs
@royra royra force-pushed the preevy-docs-update branch from 6da4fbe to b079021 Compare December 7, 2023 13:37
@royra royra merged commit ec6ea51 into livecycle:main Dec 10, 2023
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants