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

Reference Restructuring #446

Merged
merged 6 commits into from
Jun 11, 2020
Merged

Conversation

morgo
Copy link
Contributor

@morgo morgo commented May 4, 2020

Fixes #331

This splits the reference section of the manual into "programs" and "features". The programs section is a little bare for vtctl, but includes examples for other programs (we can add to it later).

The Vitess API reference is replaced by the vtctl reference - since it was out of date and referred to v3 as alpha. Most users are now encouraged to use the mysql client API instead of grpc.

Includes workaround for #342

Signed-off-by: Morgan Tocker tocker@gmail.com

@morgo morgo changed the title WIP program refrence WIP program reference May 4, 2020
@morgo morgo force-pushed the morgo-reference-programs branch 4 times, most recently from d73d820 to eb3e68e Compare May 7, 2020 14:37
Signed-off-by: Morgan Tocker <tocker@gmail.com>
@morgo morgo force-pushed the morgo-reference-programs branch from eb3e68e to ed31220 Compare May 11, 2020 14:32
morgo added 2 commits May 28, 2020 07:32
…grams

Signed-off-by: Morgan Tocker <tocker@gmail.com>
Signed-off-by: Morgan Tocker <tocker@gmail.com>
@morgo morgo marked this pull request as ready for review June 1, 2020 14:32
@morgo morgo changed the title WIP program reference Reference Restructuring Jun 1, 2020
@morgo morgo requested review from sougou, deepthi and bnlandry June 1, 2020 14:37
@morgo morgo marked this pull request as draft June 1, 2020 14:40
@morgo
Copy link
Contributor Author

morgo commented Jun 1, 2020

(Sorry, converting back to draft - I need to add aliases to redirect old pages to new locations).

Aliases are now in place.

…grams

Signed-off-by: Morgan Tocker <tocker@gmail.com>
@morgo morgo force-pushed the morgo-reference-programs branch from 82e6f2c to 628f92b Compare June 1, 2020 16:27
@morgo morgo marked this pull request as ready for review June 1, 2020 16:31

### reinit_config

Regenerate new configuration files for an existing `mysqld` instance. This could be helpful to revert configuration changes, or to pick up changes made to the bundled config in newer Vitess versions:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Regenerate new configuration files for an existing `mysqld` instance. This could be helpful to revert configuration changes, or to pick up changes made to the bundled config in newer Vitess versions:
Regenerate new configuration files for an existing `mysqld` instance. This could be helpful to revert configuration changes, or to pick up changes made to the bundled config in newer Vitess versions. For example:

Copy link
Contributor

Choose a reason for hiding this comment

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

I think it's best to keep this consistent throughout.

@deepthi
Copy link
Member

deepthi commented Jun 3, 2020

@morgo I made the changes recommended by @bnlandry to the help text in the code.
vitessio/vitess#6261

We can use that PR to add more changes as the docs change and merge both at the same time.

morgo added 2 commits June 11, 2020 07:22
…grams

Signed-off-by: Morgan Tocker <tocker@gmail.com>
Signed-off-by: Morgan Tocker <tocker@gmail.com>
Copy link
Member

@deepthi deepthi left a comment

Choose a reason for hiding this comment

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

Nice work!
cc @dkhenry

@deepthi deepthi merged commit ae0282d into vitessio:prod Jun 11, 2020
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.

Reference Restructuring
3 participants