Add RFC 5 to the README

This commit is contained in:
R Tyler Croy 2020-01-07 21:46:09 -08:00
parent 44a8290e2a
commit 4e07844097
No known key found for this signature in database
GPG Key ID: E5C92681BEF6CEA2
2 changed files with 4 additions and 25 deletions

View File

@ -46,22 +46,8 @@ interoperable, such that users can bring their own services into the Otto
ecosystem without requiring any implementation changes from the existing
services.
== Specification
[TIP]
====
Provide a detailed specification what is being proposed. Be as technical and
detailed as needed to allow new or existing developers to reasonably understand
the scope/impact of an implementation.
* Use present tense - describe what the proposal "does" (as if it were already done) not what it will do.
* Do not discuss alternative designs that were rejected, those belong in the Reasoning section.
* Avoid in-depth discussion or justification of design choices, that belongs in the Reasoning section.
====
This specification describes the standard methoa and format for all
service-to-service interaction in the Otto distributed system. The interactions
in the system are expected to take two forms:
@ -140,17 +126,6 @@ message should not be retransmitted.
== Reasoning
[TIP]
====
Explain why particular design decisions were made.
Describe alternate designs that were considered and related work, e.g. how the feature is supported in other systems.
Provide evidence of consensus within the community and discuss important objections or concerns raised during discussion.
* Use sub-headings to organize this section for ease of readability.
* Do not talk about history or why this needs to be done, that is part of Motivation section.
====
Interprocess communication occurring via JSON over HTTP helps meet a number of
the key design goals for Otto:

View File

@ -27,6 +27,10 @@ Below is the list of RFCs:
| link:0003-resource-auctioning.adoc[Resource allocation by auction]
| Draft :speech_balloon:
| 0005
| link:0005-json-over-http.adoc[JSON over HTTP for data serialization and transport]
| Draft :speech_balloon:
|===