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

Add docs for VSchema DDL #1575

Merged
merged 4 commits into from
Sep 21, 2023
Merged

Conversation

davidpiegza
Copy link
Contributor

Add docs for VSchema DDL.

A new page has been added to User Guides -> VSchema and Query Serving -> VSchema DDL. The content is taken from https://github.com/vitessio/vitess/blob/6d26dad29110566ded746f5013bd1115d9f200b4/examples/demo/vschema_ddls.sql.

Please note, this is a first version and probably not complete. I added it for V17.0 only and would copy it to other versions after first reviews.

@mattlord
Copy link
Collaborator

mattlord commented Sep 5, 2023

/cc @vitessio/query-serving

@netlify
Copy link

netlify bot commented Sep 5, 2023

Deploy Preview for vitess ready!

Name Link
🔨 Latest commit 115f040
🔍 Latest deploy log https://app.netlify.com/sites/vitess/deploys/65030e3a32a1dc0008bb0ee4
😎 Deploy Preview https://deploy-preview-1575--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.

@deepthi
Copy link
Member

deepthi commented Sep 5, 2023

@davidpiegza thank you for the contribution. Do you mind fixing the DCO by amending your commit with a --signoff?

Signed-off-by: David Piegza <davidpiegza@github.com>
@davidpiegza davidpiegza force-pushed the add-docs-for-vschema-ddl branch from bcf0ffa to 282d3c0 Compare September 6, 2023 12:12
davidpiegza and others added 2 commits September 6, 2023 14:13
Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>
Signed-off-by: David Piegza <697113+davidpiegza@users.noreply.github.com>
Signed-off-by: David Piegza <davidpiegza@github.com>
@davidpiegza
Copy link
Contributor Author

@deepthi I applied the suggestions and referenced the new page in a vtgate doc. If this looks good I can add the documentation to the other versions.

Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unless we backport vitessio/vitess#13882 to release-17.0, let's move all of this documentation to content/en/docs/18.0/... please

Signed-off-by: David Piegza <davidpiegza@github.com>
@davidpiegza davidpiegza force-pushed the add-docs-for-vschema-ddl branch from d939ae8 to 115f040 Compare September 14, 2023 13:44
@davidpiegza
Copy link
Contributor Author

@frouioui @deepthi I moved it to v18.0 docs and also decided with @arthurschreiber to change the page to actually describe each query on it's own (and not use the examples from the vitess repo).

Here is a readable version.

@frouioui
Copy link
Member

Waiting for vitessio/vitess#13882 to be merged before merging this PR.

@frouioui frouioui added the do-not-merge PR contains issues or is dependent on another task label Sep 15, 2023
@frouioui frouioui merged commit cc4ec07 into vitessio:prod Sep 21, 2023
@frouioui frouioui removed the do-not-merge PR contains issues or is dependent on another task label Sep 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants