Background

The SSF API WG is creating a common list of use cases that detail collaboration based design patterns which in most cases include implementation detail leveraging existing APIs or projects. In most cases, there are preexisting examples that can be referenced, built using the diverse language bindings in the community. Historically, feedback from the community has always pushed to identify the value of existing contributed work and more importantly the potential areas of collaboration that truly add value. In addition, community new joiners can look to this project in an effort to quickly bootstrap required knowledge.

Proposal

As part of the API WG, create a project repository that contains documentation and examples based on use cases that apply to the API's, language bindings and SDKs being developed within the Symphony community. Documentation of design patterns and practical use cases are a key focus. In most cases, examples should be deep linked into project from external repositories. With this said, contributed code snippets and full examples are allowed.

The project will leverage github pages as a distribution in order to support access and versioning. The pages will be stored under the root folder /docs and use a markdown format for all content pages. The overall format of the site will use the following structure Pages Structure

Although this work stems from discussions and goals in the API WG, it can support a wider "Symphony Cookbook" of information that the community can benefit from.

Rationale

Ongoing feedback suggest that the Symphony community requires a better way to detail use cases that add value. Creating a way for anyone to identify a solution with either existing work or a clear design approach is beneficial. This will also support alignment of language bindings and other API's as the implementation approaches are analyzed.

Current State

Existing materials scattered through confluence and existing projects will be collated.

Near Term Goals

Pull all existing materials into repository in a loose structure.

Future Goals

Reformat documentation to from basic concepts to advanced use cases over the different implementations.
Market this work to a wider audience (SSF Members and general community)
Push committers to adding content.

Code and Core Developers

Current SCM:

New project

Code Transfer Approach:

N/A

Desired GIT Repository Name(s)

symphony-by-example

Owners:

API WG

Committers:

API WG

Do you require access to the Open Developer Platform (for unit testing and continuous integration & delivery)?

No