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-43304-DBTools-ToC-update #172

Merged
merged 1 commit into from
Sep 6, 2024
Merged

Conversation

ltran-mdb2
Copy link
Collaborator

@ltran-mdb2 ltran-mdb2 commented Sep 5, 2024

DESCRIPTION

Shorten and edit the DB Tools ToC labels with the following guidelines: https://wiki.corp.mongodb.com/pages/viewpage.action?spaceKey=DE&title=FAQ%3A+Table+of+Contents+Labels

Official style guidelines for the ToC: Official Style Guidelines for the ToC: https://www.mongodb.com/docs/meta/style-guide/style/toc-labels/

STAGING

https://deploy-preview-172--docs-commandline-tools.netlify.app

JIRA

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

BUILD LOG

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

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?

Copy link

netlify bot commented Sep 5, 2024

Deploy Preview for docs-commandline-tools ready!

Name Link
🔨 Latest commit 774a4f1
🔍 Latest deploy log https://app.netlify.com/sites/docs-commandline-tools/deploys/66d9fe4dfc8f8900084ebd8d
😎 Deploy Preview https://deploy-preview-172--docs-commandline-tools.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.

Copy link
Collaborator

@mmaville-mdb mmaville-mdb left a comment

Choose a reason for hiding this comment

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

LGTM! One note on the new ToC heading for RN and what we might be able to consider in the future.

/release-notes/database-tools-changelog
Installation </installation/installation>
Logs </logs>
100.10.0 Changelogs </release-notes/database-tools-changelog>
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is likely out of scope, but one thing I noticed is that we will have to manually update this ToC entry in index.txt when adding new release notes. It looks like we already manually move the contents of this page to a standalone file with the version number, so I don't see it being a big issue.

I wonder if there's a way to apply some kind of variable and replace functionality to this entry from the actual /release-notes/database-tools-changelog file. LMK if you have any thoughts, but maybe this could be a future improvement unrelated to this task.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks for this consideration - I'll bring this to @sarahemlin 's attention when she gets back!

Copy link
Collaborator

@mdb-ashley mdb-ashley left a comment

Choose a reason for hiding this comment

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

LGTM, thanks Lauren!

@mdb-ashley mdb-ashley merged commit 6e0bd52 into mongodb:master Sep 6, 2024
4 checks passed
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