Skip to content

Update flag related syntax in Reference section#1046

Merged
deepthi merged 6 commits intoprodfrom
flags_reference
Jun 9, 2022
Merged

Update flag related syntax in Reference section#1046
deepthi merged 6 commits intoprodfrom
flags_reference

Conversation

@mattlord
Copy link
Copy Markdown
Member

@mattlord mattlord commented Jun 7, 2022

This audits the website pages underneath the main Reference left-hand nav section to apply the new CLI flag and parameter rules for v14.

Fixes: #1042

After this PR there's just the Contribute, Design Docs, Trouble Shoot, and FAQ sections left in the main left-hand nav.

And it looks like the Design Docs section is the only one of them that requires changes.

Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord mattlord requested review from ajm188 and deepthi June 7, 2022 04:39
@netlify
Copy link
Copy Markdown

netlify bot commented Jun 7, 2022

Deploy Preview for vitess ready!

Name Link
🔨 Latest commit 923a681
🔍 Latest deploy log https://app.netlify.com/sites/vitess/deploys/62a224be4f4e650008b77105
😎 Deploy Preview https://deploy-preview-1046--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 settings.

Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord mattlord marked this pull request as ready for review June 7, 2022 05:53
@mattlord mattlord requested a review from frouioui June 7, 2022 05:53
@mattlord
Copy link
Copy Markdown
Member Author

mattlord commented Jun 7, 2022

After this PR there's just the Contribute, Design Docs, Trouble Shoot, and FAQ sections left in the main left-hand nav.

And it looks like the Design Docs section is the only one of them that requires changes.

Signed-off-by: Matt Lord <mattalord@gmail.com>
Copy link
Copy Markdown
Collaborator

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

mysqlctl and vtadmin need to be changed as well to be consistent. The mysqlctl page lists flags without the prefix.
vtadmin also lists flags without a prefix and one of the flags it lists is v which would become -v
I actually like the way the vtadmin reference page is laid out. One glaring omission on the other pages is that default values are not listed. Reworking all the reference pages to be similar is going to be another big task.
@ajm188 thoughts on the vtadmin flag reference?

@ajm188
Copy link
Copy Markdown
Contributor

ajm188 commented Jun 8, 2022

mysqlctl and vtadmin need to be changed as well to be consistent. The mysqlctl page lists flags without the prefix.
vtadmin also lists flags without a prefix and one of the flags it lists is v which would become -v
I actually like the way the vtadmin reference page is laid out. One glaring omission on the other pages is that default values are not listed. Reworking all the reference pages to be similar is going to be another big task.
@ajm188 thoughts on the vtadmin flag reference?

i'm not sure what the question is, exactly. i agree with what you've laid out here

@mattlord
Copy link
Copy Markdown
Member Author

mattlord commented Jun 9, 2022

@deepthi I updated the mysqlctl page and also copied all of the changed files to the new 15.0 docs. I'm personally fine with vtadmin being different here as it's all new and will be a different way of interfacing with Vitess. We can IMO use that as a way to slowly establish new ways of doing/documenting things and then transition everything else over time.

@mattlord mattlord requested a review from deepthi June 9, 2022 16:38
Signed-off-by: Matt Lord <mattalord@gmail.com>
@deepthi deepthi merged commit 31640fa into prod Jun 9, 2022
@deepthi deepthi deleted the flags_reference branch June 9, 2022 16:57
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.

Flag syntax needs to be changed in reference docs

3 participants