Review publishing cadence and strategy

[sharifsalah]

Right now, when we publish opencue.io, we just merge / pull changes from master into the publish branch.

I suspect the publishing steps will change over the coming months depending on various questions the project might consider:

• It would be useful to set up a permanent preview of changes coming to the site. So master would continuously auto-deployed to something like preview.opencue.io, which would be useful for a couple of reasons (but would require a one time DNS change):
  • Provide a preview of upcoming changes to the site
  • Provide more confidence to whoever is publishing the site and point of comparison
• We should also think about the publishing schedule:
  • Right now, I'm publishing the whole site ad-hoc
  • Many OSS projects publish to accompany new releases
  • Some OSS projects offer an archive of docs for past versions (see for example v0.3 of Kubeflow https://v0-3.kubeflow.org/)
  • This would however (I think), require ongoing DNS changes. I suspect some of these projects are managing DNS through Netlify, but I'm sure about this.
  • Alternatively we could just aim to publish docs at a regular cadence, such as weekly, and not worry about archives.
  • Whatever the case, we'll probably always need to publish one off changes to the landing page, blog, or other non-docs pages
  • We also need to write up notes about rolling back a bad deploy (based on Netlify's docs)