kormyen / memex

Simple bookmarks and notes
https://kormyen.github.io/memex/
514 stars 67 forks source link

Seperate (exclude) database (data.ndtl) from repo? #8

Open kormyen opened 5 years ago

kormyen commented 5 years ago

Should the database be separated from this repository? It works fine as is for me personally, but would be a hassle for other's pulling the Memex repo updates.

Git-sub-module like (I assume) @drisc 's https://github.com/drisc/mem ? Or just entirely separate file like @joshavanier 's Log app.

ghost commented 5 years ago

You can add it to .gitignore or as a submodule so they can pull changes without affecting their local database but it's also good to have an example data.ndtl in the repo as a showcase for new users.

kormyen commented 5 years ago

That is probably what I will do... I like having the database version controlled. I just find submodules annoying.

Agree about having an example.

lcb931023 commented 5 years ago

if the data is ignored in .gitignore, it won't get pushed to github and gh-pages won't be able to build it.

Not sure how submodules work with gh-pages 🤔


Right now it's not too big a hassle to move the data file, I just copy my file out, force sync my branch with yours, and move my file back in.

The bigger hassle for me is manually adding my custom changes back, after syncing with your latest :P

kormyen commented 5 years ago

Hmmm that's a good point about gh pages not building if no db in repo.

Oh yeah, moving custom type definitions (and specified icons) into seperate file is on my to do list also. I assume those are the changes you mean @lcb931023 ?

I think submodule includes the actual files and a reference to the sub-repo and current sub-repo commit ID, it would work, just a hassle. More so a hassle for other people forking the main repo too, not sure how that would work.

lcb931023 commented 5 years ago

Wow I forgot to reply to this, sorry @kormyen

Yeah, custom type is the only change involving script logic. Awesome that you have it planned 👍 Besides that I also re-enabled scrolling on the left bar, since I use memex on a small screen.

Thinking of combining https://lcb931023.github.io/tsne-memex/ into my version of memex too. That's probably not a common change though.

TangentFoxy commented 4 years ago

The issue here is that people want to be able to update memex without pulling changes to your personal db. I'd suggest creating a separate branch that is where development of memex is maintained, with a demo ndtl file that is not modified or very rarely modified, and the one used for your personal db with all the media and such kept in it.

You could even make the one with your personal data the secondary branch (probably a better idea tbh) now that GitHub pages lets you specify a branch to build your site from! Master can stay what we all would pull from, while personal changes are kept out of the way.

kormyen commented 4 years ago

Thanks @TangentFoxy. Very good idea. I think that is the best way to do it. Will do when I have time.