search

vitessio / website

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

Docs: OnlineDDL cut-over backoff and force-cut-over #1641

Closed shlomi-noach closed 6 months ago

shlomi-noach commented 7 months ago

Documenting the changes in https://github.com/vitessio/vitess/pull/14546:

netlify[bot] commented 7 months ago

Deploy Preview for vitess ready!

Name Link
Latest commit 547f2741902c38737998c0938a7e95773f7dab92
Latest deploy log https://app.netlify.com/sites/vitess/deploys/65795b65d10a990008ea598d
Deploy Preview https://deploy-preview-1641--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.

shlomi-noach commented 7 months ago

can you generate the vtctldclient docs for the new command as well?

Completely forgot how to do that 😬

ajm188 commented 7 months ago

in your particular case (I think):

COBRA_DOC_VERSION_PAIRS=onlineddl-cutover-backoff:19.0 make vtctldclient-docs

edit: also you'll need to point it at your local vitess checkout https://github.com/vitessio/website/blob/prod/Makefile#L104

shlomi-noach commented 7 months ago

OK did that. That updated plenty CLI flags, but nothing related to the new command.

I feel like we've been in this situation before. I did run make build on my local path. I did point to the correct path:

COBRA_DOC_VERSION_PAIRS=onlineddl-cutover-backoff:19.0 VITESS_DIR=/Users/my-redacted-path make vttablet-docs
ajm188 commented 7 months ago

OK did that. That updated plenty CLI flags, but nothing related to the new command.

I feel like we've been in this situation before. I did run make build on my local path. I did point to the correct path:

COBRA_DOC_VERSION_PAIRS=onlineddl-cutover-backoff:19.0 VITESS_DIR=/Users/my-redacted-path make vttablet-docs

you need to make vtctldclient-docs as that's where the command is: https://github.com/vitessio/vitess/pull/14546/files#diff-13c32ab29d8892d009025725f22f4c9bdf7433141be13cd0ef8fe0615ccefb36

shlomi-noach commented 7 months ago

you need to make vtctldclient-docs

Absolutely right! My mistake. Alas: did that, now over 450 new files changes -- none of which depicts the new command.

shlomi-noach commented 6 months ago

@ajm188 having merged https://github.com/vitessio/vitess/pull/14546, I tried again using COBRA_DOC_VERSION_PAIRS=main:19.0 and that worked. It looks to me like a non-main branch name just doesn't work?

shlomi-noach commented 6 months ago

The newly added file is content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_force-cutover.md

I still have some extra ~465 files changed, but I guess that's fine as it's just the commit SHA?

Looking for your final approval before merging.

shlomi-noach commented 6 months ago

Not sure why versions 16.0, 17.0, 18.0 were at all affected here. Again, I think the script just doesn't work correctly with a non-main branch name. Please advise.

ajm188 commented 6 months ago

two things:

  1. the script definitely works with non-main branches last i used it (before i went on leave). you do need to make sure the branches (including those for the other versions you're generating) are up-to-date locally (git fetch --all should be enough)

  2. i think the extra noise is because the bot seems to have not been auto-generating docs, which i had working before i left. i am looking into why that is currently

shlomi-noach commented 6 months ago

@ajm188 Thank you for the inspection and clarification!