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

DOCSP-39633 fixes mongostat table format #163

Merged
merged 2 commits into from
Jun 26, 2024

Conversation

jwilson-mdb
Copy link
Collaborator

@jwilson-mdb jwilson-mdb commented Jun 25, 2024

DESCRIPTION

Currently, mongostat docs use a table that has incorrect formatting.
This PR migrates that table content to a .. list-table:: directive

STAGING

The updated table is just above this anchor link, in the repl field description.
https://preview-mongodbjwilsonmdb.gatsbyjs.io/database-tools/DOCSP-39633/mongostat/#additional-information

JIRA

https://jira.mongodb.org/browse/DOCSP-39633

BUILD LOG

https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=667b398cebce19f31413949c

Self-Review Checklist

  • Is this free of any warnings or errors in the RST?
  • Is this free of spelling errors?
  • Is this free of grammatical errors?
  • Is this free of staging / rendering issues?
  • Are all the links working?

External Review Requirements

What's expected of an external reviewer?

@jwilson-mdb jwilson-mdb marked this pull request as ready for review June 25, 2024 20:15
Copy link
Collaborator

@sarah-olson-mongodb sarah-olson-mongodb left a comment

Choose a reason for hiding this comment

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

Thanks @jwilson-mdb! LGTM with one minor nit.
This is subjective. The dividing line between the header row and the regular rows extends substantially past the text and looks a little "weird". I wonder if you modified widths, you could reduce the length of that dividing line?

@jwilson-mdb
Copy link
Collaborator Author

@sarah-olson-mongodb I'll see if I can tweak the widths to make that happen before requesting a merge. It will be a good opportunity to get a bit more comfortable with tables in rst - thanks!

@jwilson-mdb
Copy link
Collaborator Author

@sarah-olson-mongodb I tried to modify the widths but did not see any change in rendering. I checked with some of the other writers and they believe it is the default behavior for .. list-table:: to extend the horizontal line to max width. I also checked other areas of the docs that use .. list-table:: and it seems to confirm that max width is indeed the default behavior.

It may be possible to use an RST simple table/grid table to ditch the horizontal line, but internal docs say the .. list-table:: directive is the "right way" so I will leave it as-is for now.

@jmd-mongo jmd-mongo merged commit 6e23c51 into mongodb:master Jun 26, 2024
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.

3 participants