Skip to content

Add a Developer Handbook #652

@rhuss

Description

@rhuss

This "handbook" is supposed to be a standalone manual which should help to understand the development flow of the client and also should make it easier for newcomers to ramp up.

Describe the feature:

A Developer Handbook should describe:

  • How to get started with client development
  • Described build.sh in detail
  • How dependency are to be updated (see DEVELOPMENT.md should describe how to update dependency versions #58)
  • How PR process works
  • How E2E work and how they can be run locally
  • How the code is organized (roughly)
  • What the kn client API actually is
  • How we deal with different version of Knative eventing & serving
  • Deprecation process
  • CLI option convention
    • boolean options (wait, no-wait, ...)
    • array options (traffic, ....)
    • map options (env, label, ..)
  • Mock Clients for Unit testing and how to use them

Part of #510

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions