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]: getting_started/installation section should be fixed #588

Closed
2 of 3 tasks
mechan1sm opened this issue Sep 25, 2023 · 6 comments
Closed
2 of 3 tasks

[docs]: getting_started/installation section should be fixed #588

mechan1sm opened this issue Sep 25, 2023 · 6 comments
Assignees
Labels
documentation 📝 Solely about the documentation of the project. no-stale 🔒 This is exempt from the stale bot

Comments

@mechan1sm
Copy link

mechan1sm commented Sep 25, 2023

Description

The Problem

https://wiki.zshell.dev/docs/getting_started/installation
suggest the user to paste the unconditional curl execution into .zshrc

This is a bad idea due to several reasons:

  1. Curl execution degrades startup time (significantly - for slow internet connections)
  2. If there is no internet, curl fails and plugin manager doesn't start
  3. The practice of executing the "unknown" code at zsh startup is extremely insecure.

Also, the snippet provided in "Manual Setup" section

typeset -Ag ZI
typeset -gx ZI[HOME_DIR]="${HOME}/.zi" ZI[BIN_DIR]="${ZI[HOME_DIR]}/bin"

creates the following array

ZI[HOME_DIR]=${HOME}/.zi
ZI[BIN_DIR]=/bin

instead of

ZI[HOME_DIR]=${HOME}/.zi
ZI[BIN_DIR]=${HOME}/.zi/bin

Possible solution

I think it's better to remove all the unconditional curl executions and add the following snippet

typeset -Ag ZI
ZI[HOME_DIR]="${HOME}/.zi"
ZI[BIN_DIR]="${ZI[HOME_DIR]}/bin"
[ ! -d ${ZI[BIN_DIR]} ] && mkdir -p "${ZI[BIN_DIR]}"
[ ! -d ${ZI[BIN_DIR]}/.git ] && git clone https://github.com/z-shell/zi.git "${ZI[BIN_DIR]}"
source "${ZI[BIN_DIR]}/zi.zsh"

Select the area that is associated with this issue.

ZI (this repository)

Self-service

  • I'd be willing to address this documentation request myself.

Have you read the Contributing Guidelines?

Are you familiar with the Contributor Covenant Code of Conduct?

Contact Details

No response

@mechan1sm mechan1sm added the documentation 📝 Solely about the documentation of the project. label Sep 25, 2023
@mechan1sm mechan1sm changed the title [docs]: Getting started section should be fixed [docs]: getting_started/installation section should be fixed Sep 25, 2023
@github-actions

This comment was marked as outdated.

@github-actions github-actions bot added the stale 👻 No activity for quite some time. label Oct 26, 2023
@ss-o ss-o added no-stale 🔒 This is exempt from the stale bot and removed stale 👻 No activity for quite some time. labels Oct 26, 2023
@emirkmo
Copy link

emirkmo commented Apr 2, 2024

Is this still valid? Trying to make sense of the documentation.

@aidan-gibson
Copy link

This should be prioritized; they're skewering this project alive https://news.ycombinator.com/item?id=39973341

@LeoDog896
Copy link

@ss-o any news on this?

@mechan1sm

This comment was marked as off-topic.

@ss-o ss-o transferred this issue from z-shell/zi Jun 23, 2024
@ss-o ss-o closed this as not planned Won't fix, can't repro, duplicate, stale Aug 3, 2024
@ss-o
Copy link
Member

ss-o commented Sep 3, 2024

Issue closed and locked due to lack of activity. If you encounter this same issue, please open a new issue and refer to this closed one.

@z-shell z-shell locked and limited conversation to collaborators Sep 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation 📝 Solely about the documentation of the project. no-stale 🔒 This is exempt from the stale bot
Projects
Status: Done
Development

No branches or pull requests

5 participants