Skip to content

Conversation

gmiller-mdb
Copy link
Contributor

@gmiller-mdb gmiller-mdb commented Sep 13, 2024

DESCRIPTION

Fixed admonitions in tables and examples in tables for VScode. Removed one important admonition.

STAGING

https://deploy-preview-93--docs-mongodb-vscode.netlify.app/commands/

https://deploy-preview-93--docs-mongodb-vscode.netlify.app/connect/

https://deploy-preview-93--docs-mongodb-vscode.netlify.app/settings/

JIRA

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

BUILD LOG

https://app.netlify.com/sites/docs-mongodb-vscode/deploys/66e89b35f8c50c00081d9922

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 13, 2024

Deploy Preview for docs-mongodb-vscode ready!

Name Link
🔨 Latest commit 0a2ccd2
🔍 Latest deploy log https://app.netlify.com/sites/docs-mongodb-vscode/deploys/66e89b35f8c50c00081d9922
😎 Deploy Preview https://deploy-preview-93--docs-mongodb-vscode.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 43 (🟢 up 8 from production)
Accessibility: 91 (no change from production)
Best Practices: 75 (no change from production)
SEO: 69 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@kennethdyer kennethdyer self-requested a review September 13, 2024 18:12
Copy link
Collaborator

@kennethdyer kennethdyer left a comment

Choose a reason for hiding this comment

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

Thanks @gmiller-mdb, This LGTM!

@gmiller-mdb
Copy link
Contributor Author

@jmd-mongo would you mind taking a look at this PR? Thanks!

Copy link
Contributor

@jmd-mongo jmd-mongo left a comment

Choose a reason for hiding this comment

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

Thanks for this updated, @gmiller-mdb! I've left a suggestion for your consideration.

Thanks,
Joe

You can only use SRV connection strings to connect to
deployments running MongoDB 3.6 and later.
You can only use SRV connection strings to connect to
Copy link
Contributor

Choose a reason for hiding this comment

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

[suggestion]

I think we can consider removing this line entirely since this covers all supported versions.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jmd-mongo this look good?

Copy link
Contributor

@jmd-mongo jmd-mongo left a comment

Choose a reason for hiding this comment

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

Thank you for these updates, @gmiller-mdb! This one LGTM at this point.

Thanks,
Joe

.. example::
For example:
If the following is your SRV connection string for
Copy link
Collaborator

Choose a reason for hiding this comment

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

I believe the indents here are also causing build errors!

@@ -1,4 +1,3 @@
.. important::

To launch your selected MongoDB shell, you must:
Copy link
Collaborator

Choose a reason for hiding this comment

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

[nit] The indent(s) here are causing a build error!

connection.
Removing your current active connection also closes that
connection.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I can't comment on the applicable lines, but on this file and on settings.txt, build errors are being caused by the |vsce-short| substitution. Can you check to make sure this variable exists in snooty.toml? If not, replace the variable with |vsce| !

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ajhuh-mdb Tried to fix the build errors seems like the new command is 'vscode-short'. Hopefully that works!

.. important::

To launch your selected MongoDB shell, you must:
To launch your selected MongoDB shell, you must:
Copy link
Collaborator

Choose a reason for hiding this comment

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

[nit] since we removed the important:: admonition, we want to make sure the the text here has no indentations & is flushed to the margin of the page!

Suggested change
To launch your selected MongoDB shell, you must:
To launch your selected MongoDB shell, you must:

=====================
|vsce-short| Commands
|vscode-short| Commands
=====================
Copy link
Collaborator

Choose a reason for hiding this comment

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

[nit] since we changed the variable here, we want to make sure the header syntax has enough =s to cover the text. a new build error is popping up bc of this!

@ajhuh-mdb ajhuh-mdb merged commit 7736a4a into mongodb:master Sep 16, 2024
4 of 5 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.

4 participants