Skip to content

Add transparency and details to Getting Started documentation #29

@tonesoutherland

Description

@tonesoutherland

The Problem
The Getting Started guide is helpful, good information is provided. However, there is a strong dependency on one person: John. John's name is mentioned several times in the guide. There is some magic that John does to make things happen at certain steps. What happens if John disappears (not that he is planning to)? How do the other team members know what to do in those particular steps.

Proposed Solution
Replace "John" with a designated role, assign John to that role (these are just words, so easy enough to do, should this move forward).

More importantly, describe in detail what happens for certain steps that are "black box" such as this one:

John will setup the webhook to auto-build when you push updates https://us-central1-fhir-org-starter-project.cloudfunctions.net/ig-commit-trigger.

How is a webhook setup to auto-build? Is there a dependency on an external system or organizations (i.e HL7?). What are the steps involved here?

The goals is to make this process transparent and repeating so it's easy for anyone to pick up the torch and run with it.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions