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

docs: Add docs for Livecycle Docker extension #294

Merged
merged 21 commits into from
Oct 23, 2023

Conversation

Pradumnasaraf
Copy link
Contributor

@Pradumnasaraf Pradumnasaraf commented Oct 19, 2023

Add docs for Livecycle Docker Extension

This is a

  • Doc improvement

Preview

Screen.Recording.2023-10-19.at.12.16.16.PM.mov

Note:

Later we can add how it's connected to Preevy and Livecycle Saas

@Pradumnasaraf Pradumnasaraf added the documentation Improvements or additions to documentation label Oct 19, 2023
Copy link
Collaborator

@royra royra left a comment

Choose a reason for hiding this comment

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

Lots of nit comments, but the thing that really needs to be worked out is explaining the voyage from trying out the extension, to trying the preevy CLI, to integrating it in the CLI. I think this deserves a section on its own (@Yshayy I suggest you phrase the initial version).

site/docs/integrations/docker-extension.md Outdated Show resolved Hide resolved
site/docs/integrations/docker-extension.md Outdated Show resolved Hide resolved
site/docs/integrations/docker-extension.md Outdated Show resolved Hide resolved
site/docs/integrations/docker-extension.md Outdated Show resolved Hide resolved
site/docs/integrations/docker-extension.md Outdated Show resolved Hide resolved
site/docs/integrations/docker-extension.md Outdated Show resolved Hide resolved
site/docs/integrations/docker-extension.md Outdated Show resolved Hide resolved
<summary>What makes Livecycle Docker Extension different from other tools?</summary>
<p>
Support provisioning to your cloud provider or k8s cluster -> In that context we are not bound to abilities like tunnel or ngrok as we allow the environment to be available and accessible regardless of your local setup. We also support your CI pipeline- showing that it can be added to your GH actions for example while also add comments to your GH.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This explanation needs some clarification - you can't really do those things with just the extension.

Suggested change
Support provisioning to your cloud provider or k8s cluster -> In that context we are not bound to abilities like tunnel or ngrok as we allow the environment to be available and accessible regardless of your local setup. We also support your CI pipeline- showing that it can be added to your GH actions for example while also add comments to your GH.
Support provisioning to your cloud provider or k8s cluster -> In that context we are not bound to abilities like tunnel or ngrok as we allow the environment to be available and accessible regardless of your local setup. We also support your CI pipeline- showing that it can be added to your GH actions for example while also add comments to your GH.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hey, thanks

Can you tell me what should I write instead of that?

site/docs/integrations/docker-extension.md Outdated Show resolved Hide resolved
site/docs/integrations/docker-extension.md Outdated Show resolved Hide resolved
Copy link
Contributor

@Yshayy Yshayy left a comment

Choose a reason for hiding this comment

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

Clarify few points and add some fixes

site/docs/integrations/docker-extension.md Outdated Show resolved Hide resolved
Consistent URLs, private environments, organizations and Google/Github authentication are supported out of the box.
Livecycle dashboard provides debugging capabilites that includes log inspection, shell access, and container inspection.
Lastly, the integration with Preevy allow you to create remote ephemeral environments that can be used when your workstation is offline or futher in your SDLC (preview environments for Pull Requests).
Copy link
Collaborator

Choose a reason for hiding this comment

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

IMO further in your SDLC is too jargon

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't like it that much, as well, but it's the best I could come up with to indicate it can be used further in the development process.

site/docs/integrations/docker-extension.md Outdated Show resolved Hide resolved
site/docs/integrations/docker-extension.md Outdated Show resolved Hide resolved
Copy link
Contributor

@Yshayy Yshayy left a comment

Choose a reason for hiding this comment

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

fix

@Yshayy Yshayy enabled auto-merge (squash) October 23, 2023 14:42
@Yshayy Yshayy merged commit 008ad68 into livecycle:main Oct 23, 2023
5 checks passed
@Pradumnasaraf Pradumnasaraf deleted the docs-extension branch January 31, 2024 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants