[installer] add doc generator for Config

[nandajavarma]

Description

This PR adds a small script that can be invoked from the Makefile that will create a Markdown document from the definition of the Config struct

This is a proposal to add extra tags and/or comments to the struct definition that will get by this newly added script. You can try running the script with:

go run ./scripts/structtag.go --version "v1" # "v1" is the default value

This script will basically look for the Config struct in a file ./pkg/config/v1/config.go(or whichever version you choose). Following are the info the script is hoping to extract:

• Doc about the Config structure itself
• Name of all the fields specified in the json tag
• Information about if the field is required or not from the validate tag
• A one liner description to be read from a new tag called doc
• Extra notes about the field to be read from a comment to the field

For example:

// Config is the struct we care about
type Config struct {
      // Kind is a field we care about
      // it is very nice. we can use it a lot in `code`
     kind                string             `json:"kind" validate:"required"  doc: "for the kind hearted"`
     domain              string             `json:"kind" doc:"domain to register"`
}

The above struct will produce the following output in ./pkg/config/v1/config.md:

---

Config

Config is the struct we care about

Supported parameters

Property	Required	Description	Notes
kind	Y	for the kind hearted	Kind is a field we care about it is very nice. we can use it a lot in code
domain	N	domain to register

---

Other than the json tag, every other tag is optional.

Related Issue(s)

Fixes #8441

How to test

To test immediately, one can simply run:

$ go run ./scripts/structtag.go # default version is `v1`

You can see the output in the file ./pkg/config/v1/config.md.

To see a more elaborate doc created, add Doc comments(the ones that are given in the line above to the code) and doc tags to the Config fields and re-run the above command.

Release Notes

NONE

Documentation

/werft no-preview

[nandajavarma]

/werft run

👍 started the job as gitpod-build-nvn-config-doc.5

[corneliusludmann]

(took the liberty to add /werft no-preview to the description since this change does not have any effect on a preview environment so that we can speed up the werft build by skipping deploying the preview env—hope that is ok)

[corneliusludmann]

@nandajavarma You need to run leeway run components:update-license-header to add the missing license header. Otherwise, it looks like a really cool first step which I'm looking forward to merge! 🛹