ably / engineering

Ably's new home for engineering guidance, including content previously served from Confluence at engineering.ably.com.
https://engineering.ably.com/
Apache License 2.0
2 stars 8 forks source link

Initial import of expert expectations #1

Closed QuintinWillison closed 2 years ago

QuintinWillison commented 2 years ago

Includes content from this internal Wiki page.

You can see a rendered version of this document here, however I'm yet to work out a system for this (still incubating) repository for previewing the GitHub Pages rendering for pull requests (i.e. in a Jekyll context). I've also got work to do on the Jekyll theme / layout (everything is default, out-of-the-box GitHub Pages right now).

This particular document has been identified as an immediate priority for publication, so while I acknowledge that there is yet to be an internal decision record defined to validate the creation of the GitHub pages site at ably.github.io and/or whether it ultimiately gets CNAME'd or not (see this internal Slack thread), I would appreciate it if reviewers could focus on the content - regardless of whether it ends up in a different home eventually.

TL;DR: Reviewers, please focus on the what, not the how.

QuintinWillison commented 2 years ago

Thanks, @niksilver - I think I've responded to all of your points by way of new commits.

The only one I wasn't sure about was the "(almost) obvious" point relating to commitment. This, perhaps, crosses over into the domain of what we've contractually agreed with individuals. So, for the time being, I think it's ok to omit that for this first-pass publish of this document. We can always iterate later.

niksilver commented 2 years ago

Happy to approve.