Merge pull request github#5 from github/skeefree-updates

Skeefree: updates

Author: Shlomi Noach

skeefree/docs/how-action.md

@@ -34,11 +34,12 @@ As result, an action has no access to our production databases, to the `skeefree
 
 `skeema` is an actively developed open source tool. It's objective is to operate schema management cycles. It can both diff schema changes as well as apply them. However:
 
-- While it integrates with `pt-online-schema-change` it does not (yet) integrate with `gh-ost`. While we could write the integration it doesn't follow that we'd want `skeema` to be the one to run `gh-ost`.
+- `skeema` integrates with `pt-online-schema-change` and with `gh-ost`. However, we do not use `skeema` to invoke `gh-ost`.
   - Right now `skeema` runs from within the Action scope, and obviously cannot run anything in production, let alone multi-day migrations.
   - If we were to then extract `skeema` from Actions and run it from the outside, we'd be duplicating flow.
   - We'd still be unable to run `skeema` on our `k8s` servers: remember, schema changes can run for hours and days.
-  - Last, we want to be able to run concurrent migrations (on different clusters), and to schedule migrations; so, much of the logic we already need to take care of, ourselves.
+  - We want to be able to run concurrent migrations (on different clusters), and to schedule migrations; so, much of the logic we already need to take care of, ourselves.
+  - We were building on top of already-existing-and-proven infrastructure. If we were to build `skeefree` from scratch, the design may have been different.
 - Entirely possible `skeema` offers something more that we could use, but the above illustrates how we got here.
 
 And so we only use `skeema` up to the point it generates _diff_ statements. This is no small feat. `skeema` is doing this job fantastically:

skeefree/docs/how.md

@@ -11,7 +11,7 @@ Some of the operations depicted in the above are best dealt with using designate
 
 As result, the complete flow is not owned by any single process. The flow is a coordination of efforts by multiple processes, communicating with each other in different ways. There are three main actors in the flow:
 
-- [skeema-diff](how-action.md): a GitHub Action utilizing [skeefree](https://github.com/skeema/skeema) to generate diff statements and annotate with labels
+- [skeema-diff](how-action.md): a GitHub Action utilizing [skeema](https://github.com/skeema/skeema) to generate diff statements and annotate with labels
 - [skeefree](how-skeefree.md): this repo, acting as the controller; detects PRs, puts context to the migration, runs the migrations, provides visibility and control via chatops.
 - [gh-ost](how-gh-ost.md): our schema migration tool, uses a `skeefree` binary together with hooks, to read schema migration assignments, execute and update status.