Clarify installation documentation (#1097) #1137
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wren
reviewed
Jan 2, 2021
docs/installation.md
Outdated
| @@ -17,6 +17,14 @@ On other platforms, install `jrnl` using [Python](https://www.python.org/) 3.6+ | |||
| pipx install jrnl | |||
| ``` | |||
|
|
|||
| !!! note | |||
| `pipx` should be installed through `pip`. Missing dependencies and other issues | |||
There was a problem hiding this comment.
Can we note here that pipx's favored install methods are brew and pip (in that order)? Maybe adding another link to pipx's installation page would be a good idea (in case their installation methods change).
wren
reviewed
Jan 2, 2021
docs/installation.md
Outdated
| `pipx` should be installed through `pip`. Missing dependencies and other issues | ||
| may occur when installing `pipx` through `apt` or another package manager. | ||
|
|
||
| !!! note |
There was a problem hiding this comment.
Could this be a tip instead of a note?
There was a problem hiding this comment.
Just for clarification, are you referring to the first note being changed to a tip, the second note being changed to a tip, or both?
wren
reviewed
Jan 2, 2021
docs/installation.md
Outdated
| may occur when installing `pipx` through `apt` or another package manager. | ||
|
|
||
| !!! note | ||
| If you experience path issues after installing `jrnl`, ensure that the previous |
There was a problem hiding this comment.
Can we say this in a more direct way? Maybe something like "Don't use sudo to install jrnl" or something along those lines.
wren
requested changes
Jan 2, 2021
|
No problem! I should have time to add these changes later tonight. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is intended to fix #1097. The documentation was updated to include two notes regarding issues that could be encountered during installation. This should reduce the confusion of issues that occur when pipx is installed via apt. It also should help clarify path issues that arise when the user uses the sudo command with pipx. I've attached a screenshot of what the installation documentation looks like:
Checklist
for the same issue.