search

koki / short

Manageable Kubernetes manifests through a composable, reusable syntax
https://docs.koki.io/short
Apache License 2.0
122 stars 14 forks source link

update module system docs #198

Closed ublubu closed 6 years ago

ublubu commented 6 years ago

@wlan0

wlan0 commented 6 years ago

I just read the beginning of this file. The beginning should include more contextual information about how users should think about the module system following this structure. The docs are the best method we have to communicate to the user.

  1. Why are modules needed
  2. How they are designed
  3. How the user is expected to use them
  4. Specifics of the features this module system provides

Multiple files may be required here.

ublubu commented 6 years ago

updated for points 1, 3, and (in combination with existing material) 4. @wlan0

ublubu commented 6 years ago

updated, @wlan0