ongoing changes to overview.md #981
Closed
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
* jrnl-org#783 Allow keyring >19.0, <22.0 instead of ^19.0
…ers (jrnl-org#908) * [Markdown Exporter] [YAML Exporter] Ensure exported entires end in a newline Fixes jrnl-org#768, Fixes jrnl-org#881. If the exported entry does not have a final empty line, this will add one on export. Some Markdown parsers get picky about not having a empty line above a heading.... * fix black formatting issues * explicitly sort filenames to deal with inconsistent default file ordering on different OS's * Update .gitignore * Update test for typo fix Co-authored-by: Jonathan Wren <[email protected]>
* [Travis] update Windows Python versions * Update Python versions to be uniform across the board Co-authored-by: Jonathan Wren <[email protected]>
* Added financial contributors to the README
The MIT license is a bit outdated, and doesn't provide the protections we'd like in a modern open-source application. Co-authored-by: Micah Jerome Ellison <[email protected]>
Editing the config file doen't always destroy your journal, luckily :-)
* Improve GitHub PR Template * suggest running commands with `poetry run ...` pyflakes here is given only certain subdirectories because `.` will try and run across all packages installed in the virtual environment, if the virtual environment is within the project's root folder (which is my common practice).
* Prevent filtered deletion from deleting entire journal jrnl-org#932 and add lots of deletion tests * Undo removal of deletion feature * Use more performant deletion
* improvements to lockbot for Github comments * [lockbot] just the comment
* Fix editor config when an argument with a space is used * skip broken test on windows * fix jrnl not behaving nicely with testing suite * fix argument parsing for test suite * fix one windows test, disable one windows test
* clean up templates and issues * fix some title-casing
* Cleaned up usage.md for clarity, formatting, and grammar. While working on it, I hard-wrapped the lines to 80 characters. Hope that doesn't complicate things. Note: I changed the Steve Buscemi quote to maintain compliance with the Code of Conduct. * more changes to the usage page Includes information about two new functions (`--delete`) and (`-contains`). It's starting to look quite different from the original...
…#965) * Force *.journal line endings to LF * Force LF line endings for .feature files
* Improve slow imports * Fix codestyle * fix twice version validation * Fix a syntax mistake
…rnl-org#958) * remove period parsing in title * fix title splitter * revert title-body switch * keep both splitting types * make black happy * make it lstrip not strip * fix title-body order for the last time * make black happy again * added test * second test for single line entry with punctuation * delete extra blank lines
* fix keyring problems * black * remove else and use stderr * black * add tests * black * change description of nokeyring * dumb syntax error
* Updating changelog [ci skip] * Incrementing version to v2.4 [ci skip] * [DayOne] remove extra spaces from the titles of edited DayOne entries Otherwise, a leading space was being introduced * [DayOne] maintain existing tags stored in DayOne metadata * [DayOne] brings back extended DayOne attributes * [DayOne] maintain metadata on edited entries Fixes jrnl-org#358, See also jrnl-org#159 * [DayOne Exporter] apply black formatting * [JSON Exporter] add support for extended DayOne Metadata * [DayOne] [Tests] test that extended DayOne metadata is added to new entries Co-authored-by: Jrnl Bot <[email protected]>
* Extensive modifications to overview.md. I tried to add clarity and details while maintaining the spirit of the original document. However, it might be a bit too 'dry' now. I'd be happy to liven it up a bit. I'm only serious when I feel like I _have_ to be. One of my opinions (which may be at odds with yours) is that the documentation should emphasize `jrnl`'s advantages without downplaying any other existing solutions. If I have time, I'd like to add more information about the documented benefits of journaling, particularly the mental health aspects. That will probably need its own page, but I'm new here, so I don't want to overstay my welcome. :) * More changes to overview.md in response to feedback "why keep a journal" section removed -- it could be re-added as its own page, but it's not front-page material * More changes to overview.md: - fixed up the headings - added information about multi-platform support This is a work in progress and _not_ ready for prime-time. - need to add to Command-Line Interface section, among other things * More changes to overview.md: - moved "`jrnl` is a simple..." to "Command-Line Interface" section
* create dir if it doesn't exist * switch order of print and creation * makedirs instead of mkdir and stderr printing * add test * black reformatting
i twitched
|
The readme also has to be updated. |
micahellison
requested changes
Jun 13, 2020
docs/overview.md
Outdated
|
|
||
| `jrnl` is a simple but powerful plain text journal application for the command |
There was a problem hiding this comment.
I know I mentioned this in the other PR but I think it's good to 1) keep the mention of the plain text format, and 2) keep a more conversational tone in the documentation.
docs/overview.md
Outdated
|
|
||
| `jrnl` stores your journals as human-readable, future-proof plain text files. |
| encryption](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard) using | ||
| [cryptography.io](https://cryptography.io). | ||
| [cryptography.Fernet](https://cryptography.io/en/latest/fernet/). The | ||
| [encryption page](./encryption.md) explains `jrnl`'s cryptographic framework in |
There was a problem hiding this comment.
Maybe this sentence could be a bit lighter - "See the encryption page for more information" or something like that?
6 tasks
|
Merge conflicts fixed in #1031. |
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.
importantly, the section on encryption has been updated (see #979)
Checklist
for the same issue.