website icon indicating copy to clipboard operation
website copied to clipboard

Generate parts of the documentation

Open GuptaManan100 opened this issue 2 years ago • 3 comments

Description

We should generate parts of the docs which can be generated from the code in vitess.io website. For example, we have a list of all the reserved connections we support, that entire list is just a copy of list of variables from sysvars.go file.

GuptaManan100 avatar Dec 21 '22 04:12 GuptaManan100

See #1318 for a possible way to go about doing this (that does the generation of vtctldclient docs for multiple versions at once). We can extract some of the common stuff (managing vitess dir's, git operations, etc) to some shared util package as well).

ajm188 avatar Dec 23 '22 11:12 ajm188

The links to specific files and line numbers should also be generated, so that if the files change, the links still point to the correct line.

GuptaManan100 avatar Jan 03 '23 05:01 GuptaManan100