armada icon indicating copy to clipboard operation
armada copied to clipboard

SPIKE: Investigate options for generating example config files

Open jayofdoom opened this issue 3 years ago • 2 comments
trafficstars

We need to document possible configuration values for Armada and armadactl; however, it's extremely common for documentation of that nature to get outdated rapidly as the product evolves. Many open source projects solve this by generating configuration documentation manually out of code.

The output of this spike should be issues filed in github laying out the implementation steps and answers to the following questions:

  • Should we manually document configs or automatically generate that document?
  • What tooling should we use for that documentation?

jayofdoom avatar Sep 14 '22 20:09 jayofdoom

@jayofdoom we're iceboxing this pending further detail.

dave-gantenbein avatar Sep 21 '22 14:09 dave-gantenbein

Whoops; forgot to fill in a description here -- apologies. Will do that now.

jayofdoom avatar Sep 21 '22 15:09 jayofdoom