-
Notifications
You must be signed in to change notification settings - Fork 52
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
Conversation
✅ Deploy Preview for docs-commandline-tools ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this 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> |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks Lauren!
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
External Review Requirements
What's expected of an external reviewer?