This repository is a prototype collection of examples and tutorials using TBD frameworks, SDKs, and services. It's a place for the community to contribute ideas demonstrating concepts provided by TBD APIs. The goal here is to give our tutorials and examples a common format, enabling us to:
This section is a draft open to suggestions and modifications.
Each example/tutorial will likely contain the following components:
The motivation for this work stemmed from Frank Hinek's excellent blog post highlighting early usage of the SSI Service. We asked ourselves: what if this could be tested, publishable, and repeatable for other use cases? Thus his example becomes a nice testing ground to port into a common format and build system we define here.
Brainstorm here.
These are open for discussion as Issues:
The Quarkus project runs a similar setup for tutorials, examples, and quickstarts called "Guides".
Each guide has a docs page, kind of like a blog post which shows how to run it and what it’s about. For example, this is the Getting Started doc.
The sections in the docs are generally:
All of the quickstarts live in one repo.
And because there’s a common way they’re built, they can be surfaced on the site and tested and run in a uniform way. It’s a nice example because the end user facing thing is surfaced on the site, everything’s tested, and everything is backed by real code that’s protected against going stale (tests would fail, prompting maintenance and a check against docs to ensure they’re up to date).
TODO
Project leads should complete, alongside this README:
The other files in this template repo may be used as-is:
| Resource | Description |
|---|---|
| CODEOWNERS | Outlines the project lead(s) |
| CODE_OF_CONDUCT.md | Expected behavior for project contributors, promoting a welcoming environment |
| CONTRIBUTING.md | Developer guide to build, test, run, access CI, chat, discuss, file issues |
| GOVERNANCE.md | Project governance |
| LICENSE | Apache License, Version 2.0 |