Add Readme and Install doc

[brunosan]

From the settings I get the deploy is done via netlify, but I'm not sure how is set up, who has access to that account. We should probably add it to a Readme.md.

[brunosan]

I've managed to run the site locally, but... it's different to the one deployed.

[mireille-raad]

😮 😮 😮

I was still writing the thing, I did not even expect that someone would be looking at it yet. Also, how did you figure out how to run it locally!? damn! usually you expect people not to be able to run documented code, not vice versa ;p

So far, I am using:

• hugo as a site generator
• forestry as a UI for those who need to edit without using git/github
• deploy is automatic on netlify.

I will create:

• readme
• a diagram for how things work and how they can be updated.
• document the theme a little bit by assuming someone doesn't know hugo or golang.

[brunosan]

I think this is partially or fully dealt with #5

[brunosan]

FYI: As I was testing this, Forestry made a commit 8ed20b5, which I reverted (62160ec) just in case , since it seems to remove some configuration options.

[mireille-raad]

Is this ok?

https://github.com/datapartnership/datapartnership.org/wiki

enough details? too much information?

If you are happy with the docs, you can close the issue.

[brunosan]

I've changed the Development to theme editing since it was only that, and I removed the duplicated documentation about deployment on Main, since it links to Deployment (So we can be DRY).

[brunosan]

My last point before closing here is to verify (and add to the doc) that anyone with access to the repo can set up Netlify and add this repo to it, but then it will only sync to deploy to a random URL generated by Netlify. The Netlify that deploys to the canonical URL is on the Netlify account of who? and it is set up to sync with the master branch.

Am I correct?

[mireille-raad]

Thanks for making the edits and making the docs clearer.

Anyone with access to this repo can set up this site anywhere, including netlify, on our intranet or another web server.

In case someone sets this up on netlify, then it will deploy to a randomly generated netlify url (so, yes this is correct). Technically that other person can also buy a new domain name and link to it.

As for who has the account that links to datapartnership.org, I made sure that Holly has a Netlify account and I did the setup from her computer. There are netlify teams and we are part of that team -- so we can do changes.

If there are 2 netlify sites, then when we push to the github, both will update and re-run the build.

To edit the site, we setup forestry. I also made sure that Holly owns the forestry site and can add people as team members as well... so people can edit the site directly in git/github or through forestry (this is written in the homepage documentation).

Does that answer the questions? If yes, you can close the issue.

[brunosan]

Yes. It's clear, thanks.
Info is on the Wiki now.
Closing 🎉