Skip to content

DOCSP-44687 export to playground with Copilot #103

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.

Sign up for GitHub

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

Merged
merged 15 commits into from
Dec 9, 2024
Merged

DOCSP-44687 export to playground with Copilot #103

Changes from 4 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
4f18574
DOCSP-44687 export to playground with Copilot
ltran-mdb2 Dec 4, 2024
422b4d3
DOCSP-44687 export to playground with Copilot
ltran-mdb2 Dec 4, 2024
f0f7758
DOCSP-44687 fixing spacing
ltran-mdb2 Dec 4, 2024
e0ac6ad
DOCSP-44687 fixing spacing
ltran-mdb2 Dec 4, 2024
54aac61
DOCSP-44687 copy edits
ltran-mdb2 Dec 5, 2024
6f4891b
DOCSP-44687 moving feature to new page
ltran-mdb2 Dec 6, 2024
eaa9840
DOCSP-44687 moving feature to new page
ltran-mdb2 Dec 6, 2024
1235acc
DOCSP-44687 moving feature to new page
ltran-mdb2 Dec 6, 2024
dd324ed
DOCSP-44687 moving feature to new page
ltran-mdb2 Dec 6, 2024
235ea3a
DOCSP-44687 moving feature to new page
ltran-mdb2 Dec 6, 2024
b1cf4c2
DOCSP-44687 tech edits
ltran-mdb2 Dec 6, 2024
4edadd0
DOCSP-44687 tech edits
ltran-mdb2 Dec 6, 2024
c363216
DOCSP-44687 tech edits
ltran-mdb2 Dec 6, 2024
2368cd1
DOCSP-44687 tech edits
ltran-mdb2 Dec 6, 2024
1c48330
DOCSP-44687 tech edits
ltran-mdb2 Dec 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion source/playgrounds.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,8 @@ Create a New Playground
~~~~~~~~~~~~~~~~~~~~~~~

You can create a new playground from the :guilabel:`Playgrounds`
panel, the |vsce| *Overview* page, or the |vscode| Command Pallette.
panel, the |vsce| *Overview* page, the |vscode| Command Pallette, or
your project file.

.. tabs::

Expand Down Expand Up @@ -121,6 +122,25 @@ panel, the |vsce| *Overview* page, or the |vscode| Command Pallette.

.. include:: /includes/steps/open-new-playground.rst

.. tab:: Your Project File
Copy link

Choose a reason for hiding this comment

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

@ltran-mdb2 I think this might best for this to live in it's own nav as it is a complimentary feature to "Export to Language". We could call it "Test Application Query" in the nav and make the title "Export and Test Application Query in Playgrounds".

Lastly, on both of them (i.e. Export to Language) - could we call out that these features are currently only available for users who have Github Copilot & MongoDB's Copilot extension enabled?

:tabid: project-file

1. Open a project file.
Copy link

Choose a reason for hiding this comment

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

Needs to be more specific, something like:
"Open your application project file that has the MongoDB query you want to export"


To open a file in |vscode-short|, click on the file name in the
Copy link
Collaborator

Choose a reason for hiding this comment

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

(nit -- click)
You can usually drop on. There are a couple instances. I'll just mark this one.

Suggested change
To open a file in |vscode-short|, click on the file name in the
To open a file in |vscode-short|, click the file name in the

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!

file explorer.

#. Highlight the code that you want to open in a playground.
Copy link

Choose a reason for hiding this comment

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

Here we should be specific about "highlighting the code of the query you want to test"


#. Right click to select :guilabel:`Export Code to Playground`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

(nit -- right-click)
Always hyphenate. There are a couple instances. I'll just mark this one.

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!


Right click on your selected code to open the options menu.
Click on :guilabel:`MongoDB Copilot Participant` >
:guilabel:`Export Code to Playground`.

When you click :guilabel:`Export Code to Playground`, |vscode-short|
opens a new playground with your selected code.
Copy link

Choose a reason for hiding this comment

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

Let's specify that this opens a new MongoDB playground file with your query exported to MongoDB Shell syntax. You can then hit the run button in the top left corner to test this query with the cluster you are currently connected to in your MongoDB extension. You can iterate on your query in the playgrounds until you are happy with your query. Once the query looks good to you, you can export it back to your application code by using the Export to Language feature (link to Export to Language page).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I will add the note about exporting to language with the Export to Language PR (since this one will be merged first)


Open a Saved Playground
~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
Loading