Skip to content

Commit 90edf26

Browse files
committed
wip: example ToC for maintainer guide
1 parent bf769d2 commit 90edf26

13 files changed

Lines changed: 189 additions & 4 deletions

File tree

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Checklist
3+
sidebar_label: Checklist
4+
---
5+
6+
# Checklist
7+
8+
## Hygiene
9+
10+
* [ ] Project created from template
11+
* [ ] Documentation populated from template
12+
* [ ] Documentation synced via automation to docs.pact.io
13+
* [ ] Issue templates added
14+
* [ ] Labels added
15+
* [ ] Example projects created
16+
* [ ] Tutorials/workshops to get started
17+
* [ ] Supports minimum OS/Arch combinations?
18+
19+
## Quality
20+
21+
* [ ] TCK completed and published
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Consumer
3+
sidebar_label: Consumer
4+
---
5+
6+
# Consumer DSL
7+
8+
- General consumer guidance
9+
- Matching Rules
10+
- Specification versions and how this impacts the DSL
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: HTTP
3+
sidebar_label: HTTP
4+
---
5+
6+
# HTTP DSL
7+
8+
## Consumer
9+
TBC
10+
11+
## Provider
12+
13+
TBC
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Message
3+
sidebar_label: Message
4+
---
5+
6+
# Message DSL
7+
8+
## Consumer
9+
TBC
10+
11+
## Provider
12+
13+
TBC
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Plugins
3+
sidebar_label: Plugins
4+
---
5+
6+
# Plugins DSL
7+
8+
## Consumer
9+
TBC
10+
11+
## Provider
12+
13+
TBC
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Provider
3+
sidebar_label: Provider
4+
---
5+
6+
# Provider DSL
7+
8+
- General provider guidance e.g.
9+
- Pact fetching guidance (local, broker etc.)
10+
- how to setup `pactffi_verifier_set_provider_info` and `pactffi_verifier_add_provider_transport` effectively to support multiple transports
11+
- state handlers, request filters
12+
- FFI calls
13+
- Transports (multiple, how they work, default host/port)
14+
- State Handlers (setup/teardown, use as hooks, and behaviour if there are no states)
15+
16+
see https://pact-foundation.slack.com/archives/C02BXLDJ7JR/p1683037785422899 and https://pact-foundation.slack.com/archives/C02BXLDJ7JR/p1683282113939749 for more on this
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: DSL
3+
sidebar_label: Introduction
4+
---
5+
6+
# DSL
7+
8+
DSL Implementation
9+
10+
Covers Pact nomenclature vs idiomatic naming of things, how to cater for different spec versions, and FFI methods to call.
11+
12+
*NOTE: It might make sense to split by consumer/provider, rather than use case*
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Example
3+
sidebar_label: Example
4+
---
5+
6+
## Reference Example
7+
8+
-> Annotated Pact JS/Pact Node code base
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: FFI
3+
sidebar_label: FFI
4+
---
5+
6+
## FFI (Framework? SDK?)
7+
8+
- Introduction to the Pact Reference implementation / SDK framework / FFI
9+
- Hello FFI (https://github.com/YOU54F/hello_ffi)
10+
- Getting started (where to find, download)
11+
- Ergonomics (make it easy on the end user)
12+
- General usage, boundaries between FFI and Application
13+
- Setting up for logging, debugging etc.
14+
- Specific methods to call (or should this be spread across the DSL implementation?)
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: General
3+
sidebar_label: General
4+
---
5+
6+
## General
7+
8+
- Language / Naming Things / Idioms
9+
- Minimum supported OS/Arch combinations
10+
- Logging
11+
- Debugging
12+
- Repository hygiene (issue labels, triage etc.)
13+
- Specification versions
14+
- A short comparison between the different versions, and how this should be considered in API/DSL design

0 commit comments

Comments
 (0)