Rework user guide - Githubissues

cjstehno / ersatz

🤖 A simulated HTTP server for testing client code with configurable responses.

https://cjstehno.github.io/ersatz

Apache License 2.0

47 stars 5 forks source link

Rework user guide #46

Closed cjstehno closed 7 years ago

cjstehno commented 7 years ago

Rework the user guide to have better organization and more details and examples about each feature.

[x] Make sure the GroovyDocs have documentation links from override methods
[x] Add package info to GroovyDocs
[x] Try to find a way to get Markdown or AsciiDoc to work in GroovyDocs (maybe there is a way now)
[x] Re-align the sections of the User Guide (see comment below)
[x] More inline examples in GroovyDocs
[ ] Add more content type examples for request/response transforming
[x] Examples of using Closures as Hamcrest matchers
[x] Information about using with Kotlin
[x] Any relevant information about using with Groovy 2.5
[x] add contributors section to user guide

cjstehno commented 7 years ago

Draft of new guide outline:


Introduction
Getting Started
Sever
    Lifecycle
    Configuration (note that can be in server ctor or instance)
        - Closure
        - Consumer
    httpPort/httpsPort
    httpUrl/httpsUrl
    start/stop
    verify
Configuration
    Authentication
        BASIC
        DIGEST
    Auto-start
    Decoder
    Encoder
    Expectations
    Expects
    Https
    keystore
Decoders (more examples)
Encoders (more examples)
Cookies
Matchers
    - also using closures as matchers
Multipart
    Request
    Response
Compression
Use Case Examples
    Form data
    File upload