add cinder runbook#25013
Conversation
88f66f6 to
0cbac87
Compare
0cbac87 to
f58145b
Compare
|
Christina has been allocated the review - along with the general r? I'd be interested to know if this explains Cinder to you, as someone who was not already familiar with it. Mat - I'm interested, does this "fit" with our existing docs, is it written as a runbook, should it be somewhere else in the docs, (should it be split up?) etc. |
It's a weird one - what you have here is fine IMHO, what I would maybe do is make it clear this is more engineer-focused with a sentence towards the beginning stating that fact. We're not trying to document how moderators/operations should use it, just how we use it in AMO engineering land to set up scenarios etc. |
chrstinalin
left a comment
There was a problem hiding this comment.
I'd be interested to know if this explains Cinder to you, as someone who was not already familiar with it.
Seems a pretty good explanation to me
| Locally, the webhook payload can be copied to a local .json file and consumed, skipping authentication, with `./manage.py fake_cinder_webhook`. The default location for the payload file is `./tmp/payload.json`. | ||
|
|
||
|
|
||
| ## Useful waffle switches to enable |
There was a problem hiding this comment.
Probably not be necessary given I imagine anyone touching this would be familiar with it already, but it might be nice to link to the waffle switch section here
Fixes mozilla/addons#15639
Description
Adds a runbook for Cinder.
Context
I also tinkered with the runbooks in general - despite the instructions, defining the steps with ## Steps and then the steps at level 3 means the TOC doesn't show the step names.
After writing this file, I'm not sure if it should live in runbooks or elsewhere - it's part explainer, part runbook? Suggestions welcome. About the structure/content too.
Testing
Checklist
#ISSUENUMat the top of your PR to an existing open issue in the mozilla/addons repository.