Skip to content

chore(docs): clarify j2cli installation prerequisite#223

Open
cyw233 wants to merge 1 commit into
sonic-net:masterfrom
cyw233:polish-j2cli-prereq
Open

chore(docs): clarify j2cli installation prerequisite#223
cyw233 wants to merge 1 commit into
sonic-net:masterfrom
cyw233:polish-j2cli-prereq

Conversation

@cyw233
Copy link
Copy Markdown

@cyw233 cyw233 commented Apr 27, 2026

Summary

  • Replaces the sudo pip3 install j2cli prerequisite with safer installation guidance.
  • Asks readers to first check whether j2cli is already installed using j2 --version.
  • Adds a reminder that pip user installs may require $HOME/.local/bin to be added to PATH.

Motivation:

Using sudo pip3 install ... is not recommended because it can modify the system Python environment as root and conflict with packages managed by the OS package manager. The updated instructions prefer distro packages or user-local pip installation.

@linux-foundation-easycla
Copy link
Copy Markdown

linux-foundation-easycla Bot commented Apr 27, 2026

CLA Not Signed

@mssonicbld
Copy link
Copy Markdown

/azp run

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: chenyangwang <chenyangwang@users.noreply.github.com>
@cyw233 cyw233 force-pushed the polish-j2cli-prereq branch from 90c9995 to 823f4c2 Compare April 27, 2026 04:50
@mssonicbld
Copy link
Copy Markdown

/azp run

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

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.

3 participants