Update README.md and instructions to host locally

[jeffreyjgong]

The readme could be populated with some more information

• Update README.md with specificity regarding the submodule structure

[jeffreyjgong]

@nsnave I'm confused about what the difference is between this repo and this one. That one has instructions for hosting it locally, is that how you would do it for this site?

[nsnave]

Good question, it looks like the "site" repo is the private one which includes the public one as a submodule so you should probably work off of the "site" one unless there's something you need to change in this one. I've never worked on the website and this repo was the first one I saw...

@seunomonije , @Firebird1029 Can either of you confirm or provide more info? Also, what information do we need to keep private which justifies splitting the repo up anyway?

[Phionx]

Nice to see people working on the site!

Since I got notified about this issue, I can elaborate a bit. The public repo (this repo) contains all the generated site pages and should ideally never be modified directly. Perhaps, this can be written explicitly in the README of this repo.

Instead, please work on the yaleqc/site repo, which has all the markdown used to generate these pages. I think there are several advantages is splitting the repo up into the yaleqc/site repo and its submodule theme and public repos, with some pros enumerated here and others found by a quick Google search. Personally, I find that it's nice to work on private draft pages, and separate privileges as to who can work on markdown pages (i.e. work on yaleqc/site) and who can actually deploy to the public site (i.e. build and push to this repo). Also, this allows you to potentially store sensitive information on the private repo (e.g. Google analytics keys, though not used by us) in the future.

That said, working with submodules is not easy, so I have written scripts on yaleqc/site to make pulling and pushing updates a bit smoother.

[jeffreyjgong]

@Phionx @nsnave Thanks guys! I'll update this issue and transfer the other issue over.