DOCSP-27149 guided quick start #586
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ccho-mongodb
force-pushed
the
DOCSP-27149-guided-quick-start
branch
from
ae06ed6 to
6b12a5f
Compare
wip small fixes add titles consolidate install, add buttons updates button format test hlist test cta alternate format fix button fix button convert to admonition change format troubleshooting reformat test wip edit text, add source constant capitalization restructure as quick start, separate connection string step fix toc edits edits remove cssclass add ref anchors and incorporate overview into quick start landing page add quick start to landing pages fix button link targets move driver install add title remove add an app wip WIP WIP WIP edits edits edits update figure reduce png size Revert "reduce png size" This reverts commit e89aed0. Revert "update figure" This reverts commit fe05da9. replace images fix images
ccho-mongodb
force-pushed
the
DOCSP-27149-guided-quick-start
branch
from
4976a9c to
9f908d8
Compare
jordan-smith721
approved these changes
Feb 24, 2023
|
|
||
| Learn how to establish a connection to MongoDB Atlas and begin | ||
| working with data in the :doc:`Quick Start </quick-start>` section. | ||
| working with data in the step-by-step :doc:`Quick Start </quick-start>`. |
There was a problem hiding this comment.
Not a blocker, but can we make this into a :ref: tag instead of a :doc: while we're making changes in here?
There was a problem hiding this comment.
Thanks for pointing that out! Since this PR isn't initially going to be backported, I think it might be better to leave alone and address somewhere else.
|
|
||
| You can connect to your MongoDB deployment by providing a | ||
| **connection URI**, also called a *connection string*, which | ||
| instructs the driver how to connect to a MongoDB deployment |
There was a problem hiding this comment.
Suggested change
| instructs the driver how to connect to a MongoDB deployment | |
| instructs the driver on how to connect to a MongoDB deployment |
| when applicable, and connection options. | ||
|
|
||
| To connect to an instance or deployment not hosted on Atlas, see | ||
| :ref:`Other Ways to Connect to MongoDB <node-other-ways-to-connect>`. |
There was a problem hiding this comment.
Suggestion:
Clicking on this link takes the user out of the tutorial completely, which also collapses it in the sidebar. I think this could be confusing to some and they may struggle to find their way back, or to find where they left off when they clicked it. Could we make this a link that opens in a new tab instead to mitigate those potential issues?
There was a problem hiding this comment.
Great suggestion! I think it might be ok this way for a couple reasons:
- The quick start is designed to achieve the goal of connecting via Atlas and requires the sample data sets to be loaded. If they are connecting to a deployment not hosted on Atlas, the rest of the directions won't really work without a fair amount of sleuthing.
- I'm not sure there's a way to specify a new tab with a
:ref:or:doc:directive; the external links will be styled differently, and could be confusing since they're generally used for external links only. Not sure if there's any written guidance, but I'm guessing they're treated as two different entities in the UX design based on the appended icon that follows external links.
ccho-mongodb
pushed a commit
that referenced
this pull request
Feb 27, 2023
* Guided Quick Start (cherry picked from commit 69c2e08)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-27149
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/node/docsworker-xlarge/DOCSP-27149-guided-quick-start/quick-start/
Self-Review Checklist