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-43303-Compass-ToC-refactor #666

Merged
merged 8 commits 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 Compass 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-666--docs-compass.netlify.app
(all ToC labels can be seen using the drop down menus)

JIRA

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

BUILD LOG

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

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-compass ready!

Name Link
🔨 Latest commit 4b64bb7
🔍 Latest deploy log https://app.netlify.com/sites/docs-compass/deploys/66db4a5cc4f0a40009c4369a
😎 Deploy Preview https://deploy-preview-666--docs-compass.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.

@ltran-mdb2 ltran-mdb2 changed the title DOCSP-43303-ToC-refactor DOCSP-43303-Compass-ToC-refactor Sep 5, 2024
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! Looks clean!

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, just left a couple comments for your consideration.

/agg-pipeline-builder/maxtime-ms-pipeline
/agg-pipeline-builder/export-pipeline-results
/agg-pipeline-builder/aggregation-pipeline-builder-settings
Save Pipeline </agg-pipeline-builder/save-agg-pipeline>
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we should leave "Save a Pipeline" and "Open a Pipeline" as-is if we can within the guidelines.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done!

Save Pipeline </agg-pipeline-builder/save-agg-pipeline>
Open Pipeline </agg-pipeline-builder/open-saved-pipeline>
View Explain Plans </agg-pipeline-builder/view-pipeline-explain-plan>
Export to Specific Language </agg-pipeline-builder/export-pipeline-to-language>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Perhaps, "Export to a Language"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done!

Skip Documents </query/skip>
Limit Results </query/limit>
View Query Performance </query-plan>
Export to Language </export-query-to-language>
Copy link
Collaborator

Choose a reason for hiding this comment

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

As above, perhaps "Export to a Language"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done!

@mdb-ashley mdb-ashley merged commit 883995d into mongodb:master Sep 6, 2024
5 checks passed
@docs-builder-bot
Copy link

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.

4 participants