From 6980ed1906f46a3aab5d0ab06cb6a31445f88cfb Mon Sep 17 00:00:00 2001 From: Gustavo Matias <681278+gumatias@users.noreply.github.com> Date: Sat, 9 Jan 2021 11:07:03 -0800 Subject: [PATCH 1/4] Emphasize installing dependencies before testing (#1148) As a beginner in Python it wasn't clear that `poetry install` needed to be run before `make test` for instance. That threw a sort of obscure error until I figured it out what the solution was. This is extremely minor, but make sure installing dependencies is the very first instruction can reduce some friction when contributing. --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4bf19932..1f5e691a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -85,9 +85,9 @@ You can find an inventory of commands in the `makefile`. \*nix users can run the A typical development workflow includes: + * Installing dependencies: `poetry install` * Running tests: `make test` * Running the source in a virtual environment: - * `poetry install` * `poetry shell` * `jrnl` (with or without arguments as necessary) * Linting the code to standardize its style: `make lint` From 08a0c2d11ff9a0a0794d206ee785d7dfcfa74d96 Mon Sep 17 00:00:00 2001 From: Jrnl Bot Date: Sat, 9 Jan 2021 19:08:44 +0000 Subject: [PATCH 2/4] Update changelog [ci skip] --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a75baaf9..da3164cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ **Implemented enhancements:** - Implement dependency tracker/updater [\#1120](https://github.com/jrnl-org/jrnl/issues/1120) +- Automate Arch deployment [\#1112](https://github.com/jrnl-org/jrnl/issues/1112) - Change temporary file names for better text editor integration [\#1080](https://github.com/jrnl-org/jrnl/issues/1080) - Allow custom file extension for `jrnl --edit` command [\#1059](https://github.com/jrnl-org/jrnl/issues/1059) - Allow custom extensions when editing \(for easier syntax highlighting\) [\#1139](https://github.com/jrnl-org/jrnl/pull/1139) ([KarimPwnz](https://github.com/KarimPwnz)) @@ -15,6 +16,7 @@ - Error if password exists in keyring, but retrieval fails for any reason [\#1020](https://github.com/jrnl-org/jrnl/issues/1020) - Fix keyring error handling [\#1138](https://github.com/jrnl-org/jrnl/pull/1138) ([KarimPwnz](https://github.com/KarimPwnz)) +- Notify user when config directory can't be created because there is already a file with the same name [\#1134](https://github.com/jrnl-org/jrnl/pull/1134) ([micahellison](https://github.com/micahellison)) **Build:** @@ -22,6 +24,7 @@ **Documentation:** +- Emphasize installing dependencies before testing [\#1148](https://github.com/jrnl-org/jrnl/pull/1148) ([gumatias](https://github.com/gumatias)) - Fix broken search bar in docs site [\#1135](https://github.com/jrnl-org/jrnl/pull/1135) ([wren](https://github.com/wren)) - Fix search on docs site [\#1133](https://github.com/jrnl-org/jrnl/pull/1133) ([wren](https://github.com/wren)) - Add packaging label to changelog generator config [\#1132](https://github.com/jrnl-org/jrnl/pull/1132) ([wren](https://github.com/wren)) From dbd12fc50093fea97a7df25ac4c5124ab42b8841 Mon Sep 17 00:00:00 2001 From: Seopril <49238562+Seopril@users.noreply.github.com> Date: Sat, 9 Jan 2021 15:39:06 -0500 Subject: [PATCH 3/4] Clarify installation documentation (#1097) (#1137) * Clarify installation documentation (#1097) * Update installation docs --- docs/installation.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/installation.md b/docs/installation.md index ee70893a..a37e21fd 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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 either `brew` or `pip`. Missing dependencies and other issues + may occur when installing `pipx` through `apt` or another package manager. Further installation + instructions can be found in [pipx's documentation](https://pipxproject.github.io/pipx/installation/). + +!!! tip + Do not use `sudo` while installing `jrnl`. This may lead to path issues. + The first time you run `jrnl` you will be asked where your journal file should be created and whether you wish to encrypt it. From 61f8406412e9e29aab197bd39b9b437509bb800c Mon Sep 17 00:00:00 2001 From: Jrnl Bot Date: Sat, 9 Jan 2021 20:40:42 +0000 Subject: [PATCH 4/4] Update changelog [ci skip] --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index da3164cb..6b9323db 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -24,7 +24,9 @@ **Documentation:** +- Clarify installation docs [\#1097](https://github.com/jrnl-org/jrnl/issues/1097) - Emphasize installing dependencies before testing [\#1148](https://github.com/jrnl-org/jrnl/pull/1148) ([gumatias](https://github.com/gumatias)) +- Clarify installation documentation \(\#1097\) [\#1137](https://github.com/jrnl-org/jrnl/pull/1137) ([Seopril](https://github.com/Seopril)) - Fix broken search bar in docs site [\#1135](https://github.com/jrnl-org/jrnl/pull/1135) ([wren](https://github.com/wren)) - Fix search on docs site [\#1133](https://github.com/jrnl-org/jrnl/pull/1133) ([wren](https://github.com/wren)) - Add packaging label to changelog generator config [\#1132](https://github.com/jrnl-org/jrnl/pull/1132) ([wren](https://github.com/wren))