Closed gjtorikian closed 5 years ago
Thank you for gardening this!
I haven’t reviewed this yet but I think there are some questions around two different t concepts:
• build-aware transforms, are transforms that push to a branch, then wait for a build to pass before raising a PR on said branch for the changes to merge back into base. If the build fails, the build-aware transform can create an issue via the issueRouter. • dry-run transforms, are no special transform. It just means the transform is invoked with —dry-run=true to test the changes. The resulting changes aren’t committed but just printed as a git diff back to requester.
I think this PR using dry-run transform where should actually refer to build-aware transforms.
I vote we create an issue with cd's comment, and merge this PR, because that bit is present already @gjtorikian
@cdupuis: does that jive with you?
@cdupuis: does that jive with you?
yepp.
One of the first things that threw me off when reading through the Atomist docs was this "SDM Concepts" page. Given the title, I had thought that it would focus on the core components of an SDM. It does, but it also jumps around between code samples and API signatures, which made following the "What is an SDM?" narrative harder to follow.
In this PR, I rearranged a lot of the content. I wanted to keep the SDM Concepts page strictly text--no code samples. In the need for calling out capabilities, like with GraphQL, I moved the content to an existing page. In the need for preserving code samples, I moved those to their own stand-alone article snippets.
In short, I personally think this page works best by describing the components of what makes an SDM, how it runs, what it can do, etc., and then link out to other docs for readers to get more familiarity.