datamade / how-to

📚 Doing all sorts of things, the DataMade way
MIT License
86 stars 12 forks source link

Migrate deploy-a-site docs to this repo #74

Closed jeancochrane closed 4 years ago

jeancochrane commented 4 years ago

Overview

As part of our migration to Heroku, migrate all active docs from the https://github.com/datamade/deploy-a-site/ repo to this repo. This includes:

Handles #61.

Notes

Once this PR has been pulled in, we can officially deprecate deploy-a-site in https://github.com/datamade/deploy-a-site/pull/82.

Testing Instructions

jeancochrane commented 4 years ago

Thanks for double-checking that I pulled over all relevant docs! My thoughts:

Guidance for RTD

I think these docs are actually now out of date. The current RTD docs recommend just setting a CNAME record for the subdomain you want to use on RTD, which is straightforward enough that I don't think we need our own internal documentation for it. We should definitely hold on to these docs in deploy-a-site because some of our documentation sites are deployed this way but since it's a deprecated deployment strategy (and also depends on Nginx configs, which we don't use on Heroku anyway) my instinct is not to move them over.

GPG basics (???)

I moved GPG docs over here: https://github.com/datamade/how-to/pull/74/files#diff-a63a571099a5d82ba3d000eb9ab98e0e Is there a part of the docs that I missed?

hancush commented 4 years ago

Oh, derp. My eagle eyes failed me. 🙃 This all LGTM!