TiddlyWiki / TiddlyWikiClassic

TiddlyWiki Classic (not to be confused with TiddlyWiki5: https://github.com/Jermolene/TiddlyWiki5)
https://classic.tiddlywiki.com/
492 stars 114 forks source link

fixup docs: SaveBackups #267

Closed markkerrigan closed 2 years ago

markkerrigan commented 4 years ago

Clarify a saver must be set up to allow for automatic backups.

YakovL commented 2 years ago

Hello Mark, thanks for the PR!

I wonder if creating a new tiddler [[Improving Documentation]] ("content/Improving%20Documentation.tid" file) was intentional, looks like a copy of [[Improving documentation via GitHub]]. Did you mean to rename it? I doubt since you haven't changed any links to it or content/split.recipe.

And I have one question about the change of [[SaveBackups]]. Your idea is to clarify it, so can't help asking what does

Using the manual download saving method will not overwrite the ~TiddlyWiki file in place unless the user chooses the overwrite the existing ~TiddlyWiki file.

mean? Does this rewording means the same?

If the manual download saving method is used, it asks for filename of a backup, and one shouldn't choose the same filename as the main ~TiddlyWiki file.

Is it really necessary to specify this? To me, it seems a little excessive, but ok if you think otherwise.

markkerrigan commented 2 years ago

Hello Yakov not sure what happened with this PR.

I removed the commit for Improving Documentation.

This commit is the only one with changes. Not sure where you're seeing these changes. The following is the text I'm proposing for [[SaveBackups]]

If no [[saver method|Setting up saving]] is configured, no backup file will be created. Using the manual download saving method will not overwrite the ~TiddlyWiki file in place unless the user chooses the overwrite the existing ~TiddlyWiki file.

YakovL commented 2 years ago

Hm, yeah, this does sound weird. I've seen a different text, presumably in the "Files changed" tab, but now I see the text you've cite in there and it's great. I'll squash-merge this so that one sane commit goes to the master branch. And the additions look clear and helpful, thanks!

PS I've got somewhat familiar with github CI recently, so there's a chance that I'll setup automatic update of github pages on merge, but there are still some non-trivial questions, so this may get delayed.

YakovL commented 2 years ago

Alright, I've implemented a semi-automatic solution: now update of index.html is done by couple of clicks in Actions (may be not visible for your and currently not available for you to run) and typing commit message, username and email. Later I'll make it trigger on commits to TiddlyWiki/TiddlyWiki automatically, but this already helps to update https://classic.tiddlywiki.com quicker (you can review the uploaded changes if you like).