Skip to content

[doc] Refactor the installation documentation based on install.sh#700

Open
JinkunLiu wants to merge 3 commits into
apache:mainfrom
JinkunLiu:feature/import-wizard-docs
Open

[doc] Refactor the installation documentation based on install.sh#700
JinkunLiu wants to merge 3 commits into
apache:mainfrom
JinkunLiu:feature/import-wizard-docs

Conversation

@JinkunLiu
Copy link
Copy Markdown
Contributor

@JinkunLiu JinkunLiu commented May 24, 2026

Linked issue: #699

Purpose of change

Update docs/get-started/installation.md

  • Provides Quick install (recommended) section
  • Move Prerequisites section to top

Change verification on install.sh as default

  • fix a python enviroment error on install.sh
  • update code style on main function
  • support curl|bash installs

Tests

not need

API

not

Documentation

  • doc-needed
  • doc-not-needed
  • doc-included

@github-actions github-actions Bot added doc-included Your PR already contains the necessary documentation updates. fixVersion/0.3.0 The feature or bug should be implemented/fixed in the 0.3.0 version. priority/major Default priority of the PR or issue. and removed doc-included Your PR already contains the necessary documentation updates. labels May 24, 2026
@JinkunLiu
Copy link
Copy Markdown
Contributor Author

Hi @xintongsong @wenjin272

I've refactored the installation documentation — please take a look thanks.

When the installer is invoked via `curl … | bash`, stdin is the pipe,
so is_non_interactive_shell short-circuits gum bootstrap and every
interactive prompt falls back to plain bash menus that can't read user
input either. Reattach stdin to the controlling terminal at the top
of main(), guarded by NO_PROMPT and a real /dev/tty open test so CI
and no-TTY containers continue to use the silent fallback.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added doc-included Your PR already contains the necessary documentation updates. and removed doc-included Your PR already contains the necessary documentation updates. labels May 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc-included Your PR already contains the necessary documentation updates. fixVersion/0.3.0 The feature or bug should be implemented/fixed in the 0.3.0 version. priority/major Default priority of the PR or issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant