DOCSP-43495-schema-command #97
Conversation
✅ Deploy Preview for docs-mongodb-vscode ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
source/copilot-schema.txt
Outdated
| :depth: 1 | ||
|
|
||
| The ``/schema`` command provides information about your collection | ||
| schema. The |copilot| accesses your connected MongoDB deployment to |
There was a problem hiding this comment.
Consider rewrite in form "To XXX, the YYY."
There was a problem hiding this comment.
Updated this section to simplify!
source/copilot-schema.txt
Outdated
| -------- | ||
|
|
||
| Provide a Sample Document | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
Consider rewrite to not use just one nested heading.
Also, we typically require the use of numbered steps for examples now.
There was a problem hiding this comment.
Done! Because this is a UI example instead of a code example, there is only 1 step (asking the copilot chat) so I left out numbers
source/copilot-schema.txt
Outdated
| Provide a Sample Document | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Consider the ``users`` collection in the `Mflix Sample Database |
There was a problem hiding this comment.
I'd rewrite this to not use "Consider" because what is reader being asked to consider?
source/copilot-schema.txt
Outdated
|
|
||
| Consider the ``users`` collection in the `Mflix Sample Database | ||
| <https://www.mongodb.com/docs/atlas/sample-data/sample-mflix/#sample_mflix.users>`__. | ||
| If you are connected to a MongoDB deployment that contains this |
There was a problem hiding this comment.
Question: What about readers who don't have that sample? I checked that page, and it doesn't have an actual command to create the collection if they don't have it.
There was a problem hiding this comment.
I added a sample document to illustrate the collection schema. Because this is a UI example as opposed to a code example, I would recommend using the sample database to ensure consistency over having the user be able to replicate the exact example environment
source/copilot-schema.txt
Outdated
| Sure, here is a sample document from the sample_mflix.users | ||
| collection: | ||
|
|
||
| { |
There was a problem hiding this comment.
I checked the Atlas samples page, and it shows the sample doc as:
{
"_id": {
"$oid": "59b99db4cfa9a34dcd7885b6"
},
"name": "Ned Stark",
"email": "[email protected]",
"password": "$2b$12$UREFwsRUoyF0CRqGNK0LzO0HM/jLhgUCNNIJ9RJAqMUQ74crlJ1Vu"
}
There was a problem hiding this comment.
I used this document to illustrate the collection schema!
source/copilot-schema.txt
Outdated
| "preferences": {} | ||
| } | ||
|
|
||
| Once Copilot generates the response, you can open the JSON output to see |
There was a problem hiding this comment.
Consider "After", not "Once".
|
Thanks for your feedback @jason-price-mongodb ! Could you take another look when you get a chance? |
DESCRIPTION
Adds a page on the /schema GitHub Copilot command
STAGING
https://deploy-preview-97--docs-mongodb-vscode.netlify.app/copilot-schema/
https://deploy-preview-97--docs-mongodb-vscode.netlify.app/copilot/
JIRA
https://jira.mongodb.org/browse/DOCSP-43495
Self-Review Checklist
External Review Requirements
What's expected of an external reviewer?