Skip to content

Add installation command explanation#321

Open
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/add-install-command-explanation-56881
Open

Add installation command explanation#321
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/add-install-command-explanation-56881

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Feb 12, 2026

Added a brief explanation of what the curl -fsS https://openops.sh/install | sh command does in the Quick Start Guide. This helps users understand that the command downloads and runs an automated installation script that handles Docker setup, image downloads, and environment configuration.

Files changed

  • getting-started/quick-start-guide.mdx - Added 3-sentence explanation after the AutoInstall component

Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

<AutoInstall/>

This command downloads an installation script from openops.sh and runs it on your machine. The script automatically installs Docker if needed, downloads OpenOps Docker images, and configures the environment. It's a one-command automated installer for quick setup.
Copy link
Contributor

@ravikiranvm ravikiranvm Feb 12, 2026

Choose a reason for hiding this comment

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

@marco-comi-openops An user asked Mintlify AI in our docs website about this curl command. Do you think we should add this explanation to the installation command?

Choose a reason for hiding this comment

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

This sentence

The script automatically installs Docker if needed
contradicts the following sentence just above:

You’ll also need Docker, so see Docker requirements to make sure you have a compatible version of a Docker client.

Which one is correct?

Copy link

@marco-comi-openops marco-comi-openops left a comment

Choose a reason for hiding this comment

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

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