vitessio / website

vitess.io website and other project management related content
https://vitess.io
Apache License 2.0
54 stars 204 forks source link

more graceful docgen #1588

Closed ajm188 closed 1 year ago

ajm188 commented 1 year ago

skip programs who either don't have a target directory (in content/en/.../) for that version, or don't have a docgen directory (go/cmd//docgen) in vitessio/vitess for that gitref

this allows us to freely bulk-generate docs for all programs/versions without having to get fussy about it

Example Output

(note i have upstream/main checked out as vmain so i tweaked the makefile locally)

``` ➜ vtwebsite git:(andrew/docgen-graceful) ✗ VITESS_DIR=~/dev/vitess make generated-docs go run ./tools/cobradocs/ --vitess-dir "/Users/andrew/dev/vitess" --version-pairs ""vmain:18.0,v17.0.2:17.0,v16.0.4:16.0,v15.0.4:15.0"" vtctld 2023/09/18 06:27:41 [warning] cannot find directory for doc version v17.0.2:17.0 (index=1): stat /Users/andrew/dev/vtwebsite/content/en/docs/17.0/reference/programs/vtctld: no such file or directory 2023/09/18 06:27:41 [warning] cannot find directory for doc version v16.0.4:16.0 (index=2): stat /Users/andrew/dev/vtwebsite/content/en/docs/16.0/reference/programs/vtctld: no such file or directory 2023/09/18 06:27:41 [warning] cannot find directory for doc version v15.0.4:15.0 (index=3): stat /Users/andrew/dev/vtwebsite/content/en/docs/15.0/reference/programs/vtctld: no such file or directory go run ./tools/cobradocs/ --vitess-dir "/Users/andrew/dev/vitess" --version-pairs ""vmain:18.0,v17.0.2:17.0,v16.0.4:16.0,v15.0.4:15.0"" vtctldclient go run ./tools/cobradocs/ --vitess-dir "/Users/andrew/dev/vitess" --version-pairs ""vmain:18.0,v17.0.2:17.0,v16.0.4:16.0,v15.0.4:15.0"" vtgate 2023/09/18 06:28:01 [warning] cannot find directory for doc version v17.0.2:17.0 (index=1): stat /Users/andrew/dev/vtwebsite/content/en/docs/17.0/reference/programs/vtgate: no such file or directory 2023/09/18 06:28:01 [warning] cannot find directory for doc version v16.0.4:16.0 (index=2): stat /Users/andrew/dev/vtwebsite/content/en/docs/16.0/reference/programs/vtgate: no such file or directory 2023/09/18 06:28:01 [warning] cannot find directory for doc version v15.0.4:15.0 (index=3): stat /Users/andrew/dev/vtwebsite/content/en/docs/15.0/reference/programs/vtgate: no such file or directory go run ./tools/cobradocs/ --vitess-dir "/Users/andrew/dev/vitess" --version-pairs ""vmain:18.0,v17.0.2:17.0,v16.0.4:16.0,v15.0.4:15.0"" vtorc 2023/09/18 06:28:04 [warning] cannot find directory for doc version v17.0.2:17.0 (index=1): stat /Users/andrew/dev/vtwebsite/content/en/docs/17.0/reference/programs/vtorc: no such file or directory 2023/09/18 06:28:04 [warning] cannot find directory for doc version v16.0.4:16.0 (index=2): stat /Users/andrew/dev/vtwebsite/content/en/docs/16.0/reference/programs/vtorc: no such file or directory 2023/09/18 06:28:04 [warning] cannot find directory for doc version v15.0.4:15.0 (index=3): stat /Users/andrew/dev/vtwebsite/content/en/docs/15.0/reference/programs/vtorc: no such file or directory go run ./tools/cobradocs/ --vitess-dir "/Users/andrew/dev/vitess" --version-pairs ""vmain:18.0,v17.0.2:17.0,v16.0.4:16.0,v15.0.4:15.0"" vttablet 2023/09/18 06:28:05 [warning] cannot find directory for doc version v17.0.2:17.0 (index=1): stat /Users/andrew/dev/vtwebsite/content/en/docs/17.0/reference/programs/vttablet: no such file or directory 2023/09/18 06:28:05 [warning] cannot find directory for doc version v16.0.4:16.0 (index=2): stat /Users/andrew/dev/vtwebsite/content/en/docs/16.0/reference/programs/vttablet: no such file or directory 2023/09/18 06:28:05 [warning] cannot find directory for doc version v15.0.4:15.0 (index=3): stat /Users/andrew/dev/vtwebsite/content/en/docs/15.0/reference/programs/vttablet: no such file or directory ➜ vtwebsite git:(andrew/docgen-graceful) ✗ echo $? 0 ```
netlify[bot] commented 1 year ago

Deploy Preview for vitess ready!

Name Link
Latest commit 9a30356018fc371ce1d08b1054de1ca861d17c7d
Latest deploy log https://app.netlify.com/sites/vitess/deploys/6508271ed7cc5900082705bb
Deploy Preview https://deploy-preview-1588--vitess.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

ajm188 commented 1 year ago

tl;dr all the casing changes were made in the main codebase but never regenerated back to the website docs. this is just correcting that

i’ll defer to @rohit-nayak-ps for what consistency he wants there (i.e. i’d like to get the main change in and follow up for the consistentcy)