Skip to content
This repository was archived by the owner on Feb 24, 2022. It is now read-only.

Home

Jump to bottom
Greg Turnquist edited this page May 6, 2015 · 11 revisions

Asking for a new document

If you are interested in a new document (guide/pattern/reference), then open an issue with details.

NOTE: If you have spotted an issue with an existing document, please go to that repository and open an issue. This repo is only for working on new documents.

Authoring Content

Getting Started Guides

Getting Started Guides (GSGs) are:

  • task-focused, ideally on tasks that developers would naturally Google when they're faced with implementing something they've never done before.

  • the hello world of a given particular development task.

  • about copying and pasting your way to working code. Users of any skill level, background, etc should be able to walk through GSGs in a context-free fashion, needing no prerequisites other than a JDK, a build system, and a Pivotal CF environment with the requisite services.

  • designed to capture users' attention and interest, making them want to know more. GSGs connect to reference documentation, tutorials, and project pages, where users can drill into more detailed documentation.

  • optimized for competition. GSGs should hold up well in inter-office technology bake-offs, e.g. service discovery provider X vs. Cloud Foundry service discovery, configuration server Y vs Cloud Foundry configuration server, etc.

  • a complement to tutorials, reference apps, and project-specific sample apps.

  • keep it short, short, and SHORT. Don't write a book; write it as simple as possible.

Patterns

Patterns are ways of solving problems learned in the problem space of microservices. A given pattern doesn't have code. Instead, it documents the issue at hand and how the pattern mitigates or solves it.

References

These are collections of diagrams and other aggregate content used to describe a collection of problems, patterns, and other solutions in the context of microservices.

Contributing to existing content

If you wish to contribute to an existing item, fork this project and submit your changes as a pull request. Remember: only guides actually have code. For patterns and references, you should discuss your idea with the Spring/PCF team.

Tasks

Clone this wiki locally