Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate parts of the documentation #1302

Open
GuptaManan100 opened this issue Dec 21, 2022 · 2 comments
Open

Generate parts of the documentation #1302

GuptaManan100 opened this issue Dec 21, 2022 · 2 comments

Comments

@GuptaManan100
Copy link
Member

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.

@ajm188
Copy link
Contributor

ajm188 commented Dec 23, 2022

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).

@GuptaManan100
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

3 participants