Single entrypoint (i.e. knative serving) proxy documentation

[Will Plusnick <pw...@us.ibm.com>]

Hello all,
I want to start this off by apologizing for my disorganization during the Technical Interchange Meeting. I did a poor job of both contextualizing the changes and explaining what the changes were.

This proposal was all about documentation. We've been discussing with Michele Sciabarra, Alessio Marinelli, and Alessanddro Sanino on how to best standardize the work we have been doing for Knative Serving compatible runtimes. So far these have all followed a contract defined in code, but otherwise not documented in an incomplete and scattered way.

The following PR will attempt to take this otherwise code defined contract and standardize it in writing so that future implementors, users, and maintainers do not have to rely on piecing together code and fragmented mailing list discussions. Ideally the same JSON payloads outlined in the documentation will be implemented in the current Scala framework. For now though, I'm merely proposing the following markdown files to spell out what the existing implementations have done in code.

Documentation PR: https://github.com/apache/openwhisk/pull/4850
In additon we are moving the existing example cases over to openwhisk-test for ease of automation in the furture: https://github.com/apache/openwhisk-test/pull/10

Re: Single entrypoint (i.e. knative serving) proxy documentation

[Rodric Rabbah <ro...@gmail.com>]

Will, thank you for following up on the discussion from yesterday's call.
The PRs and details shared here are very helpful (at least for me) in
understanding the contribution.

-r

On Thu, Mar 5, 2020 at 1:20 PM Will Plusnick <pw...@us.ibm.com> wrote:

> Hello all,
> I want to start this off by apologizing for my disorganization during the
> Technical Interchange Meeting. I did a poor job of both contextualizing the
> changes and explaining what the changes were.
>
> This proposal was all about documentation. We've been discussing with
> Michele Sciabarra, Alessio Marinelli, and Alessanddro Sanino on how to best
> standardize the work we have been doing for Knative Serving compatible
> runtimes. So far these have all followed a contract defined in code, but
> otherwise not documented in an incomplete and scattered way.
>
> The following PR will attempt to take this otherwise code defined contract
> and standardize it in writing so that future implementors, users, and
> maintainers do not have to rely on piecing together code and fragmented
> mailing list discussions. Ideally the same JSON payloads outlined in the
> documentation will be implemented in the current Scala framework. For now
> though, I'm merely proposing the following markdown files to spell out what
> the existing implementations have done in code.
>
> Documentation PR: https://github.com/apache/openwhisk/pull/4850
> In additon we are moving the existing example cases over to openwhisk-test
> for ease of automation in the furture:
> https://github.com/apache/openwhisk-test/pull/10
>