Build System Architecture Paperwork [8]

[michaelkleinhenz]

Description

As a developer, I want to understand the architecture, incoming design decisions and requirements for creating the build service and the technical definitions required for it.

Functional Acceptance Criteria

1. There is a preliminary definition for the SPI for contract between Almighty and a build provider.
2. There is a preliminary definition of domain types supplied by the Build Service
3. There is a draft for the approach for visualizing build progress, build state, and access to build artifacts.

Note: this is a "technical userstory" that is not recommended in a Scrum process, but in reality very common. It provides means of doing technical groundwork that is not directly covered by user experiences. The "story" is needed to integrate the work entity into the existing process.

Non-functional Acceptance Criteria

1. The resulting artifact is a document.
2. The resulting artifact is considered a architecture/definition overview that includes all above FACs. Goal is to do detailed definitions in later stories.
3. Goal is to achieve a mutual understanding of the system at large and the needed definition / implementation work.

[tnozicka]

LGTM

[maxandersen]

I've added the "architecture" label to this so we can see this a "technical userstory" or "architectural runway" as called in other places.

and btw. I don't think this is a non-userstory since the user here are the developers needing to integrate with it ;)

[ldimaggi]

Where will the document be available? Will we maintain it here: https://github.com/almighty/almighty-devdoc

[tnozicka]

@ldimaggi Agreed; that was my thinking as well. (https://github.com/almighty/almighty-devdoc/tree/master/design)

[ALRubinger]

+1 on the direction here, @michaelkleinhenz and @tnozicka

[michaelkleinhenz]

Done. See document artifact here: https://docs.google.com/document/d/1fef63yIJpwvMJjSLdnQnpiP2-0CZA_xEnimODkE-Xy4/edit#heading=h.fd7gjbrqgd3u

[maxandersen]

could you take this and put on devdoc ? you can use https://github.com/maxandersen/gdoc2adoc to convert it to asciidoc.

[michaelkleinhenz]

Now also in devdoc/master as adoc.

[maxandersen]

for prosperity the doc is at http://devdoc.almighty.io/blueprints/build_concept.html