Skip to content

Commit a15b5b5

Browse files
author
ajosh0504
committed
Updating to Instruqt
1 parent 873b79b commit a15b5b5

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

docs/20-dev-env/2-dev-env-setup.mdx

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import Tabs from '@theme/Tabs';
2+
import TabItem from '@theme/TabItem';
13
import Screenshot from "@site/src/components/Screenshot";
24

35
# 👐 Setup dev environment
@@ -6,9 +8,20 @@ import Screenshot from "@site/src/components/Screenshot";
68
In this lab, we will be using Jupyter Notebooks, which is an interactive Python environment. If you are new to Jupyter Notebooks, use <a href="./jupyter-notebooks">this</a> guide to familiarize yourself with the environment.
79
:::
810

9-
## Option 1: GitHub Codespaces
11+
You have a few different options to run this lab. **Our preferred platform is Instruqt**.
1012

11-
You will be working in GitHub Codespaces throughout this lab. A codespace is a cloud-hosted, containerized development environment that comes pre-configured with all the tools you need to run this lab.
13+
If for some reason, you are unable to access the lab through Instruqt, try GitHub Codespaces. If neither of these work, or if you really, really, really want a local installation, only then run the lab locally.
14+
15+
<Tabs groupId="setup options">
16+
<TabItem value="Instruqt" label="Instruqt">
17+
18+
Instruqt
19+
20+
</TabItem>
21+
22+
<TabItem value="GitHub Codespaces" label="GitHub Codespaces">
23+
24+
A codespace, much like Instruqt, is a cloud-hosted development environment from GitHub, that comes pre-configured with all the tools you need to run this lab.
1225

1326
Navigate to [this](https://github.com/codespaces/new/mongodb-developer/genai-devday-notebooks?quickstart=1) link. You will be prompted to sign into GitHub if you haven't already. Once signed in, click the **Create new codespace** button to create a new codespace.
1427

@@ -18,9 +31,9 @@ Let it run for a few seconds as it prepares a Docker container with all the requ
1831

1932
### Connect to the MongoDB cluster
2033

21-
Once the environment is built, you will be prompted to connect to the MongoDB cluster via MongoDB's VSCode extension. This will allow you to visualize the data that we will import into the cluster later in the lab, directly from the VSCode IDE.
34+
Later in the lab, we will import data into the MongoDB cluster that you can view directly from the VSCode IDE. But first, you will need to connect to the cluster.
2235

23-
To connect to the cluster, click the leaf icon in the left navigation bar of the IDE.
36+
To do this, click the leaf icon in the left navigation bar of the IDE.
2437

2538
<Screenshot url="https://github.com/codespaces" src="img/screenshots/20-dev-env/2-dev-env-setup/2-click-leaf.png" alt="Click leaf icon" />
2639

@@ -54,11 +67,9 @@ In the modal that appears, click **Python environments...** and select the inter
5467

5568
That's it! You're ready for the lab!
5669

57-
## Option 2: Run locally
70+
</TabItem>
5871

59-
:::caution
60-
During the lab, we will use GitHub Codespaces. These instructions are here just in case you can't use Codespaces or if you really, really, really want a local installation.
61-
:::
72+
<TabItem value="Run locally" label="Run locally">
6273

6374
To run the lab locally, follow the steps below:
6475

@@ -96,4 +107,8 @@ jupyter notebook
96107

97108
* In the browser tab that pops up, open the file named `vector-search-lab.ipynb`.
98109

99-
<Screenshot url="localhost:8888/tree" src="img/screenshots/20-dev-env/2-dev-env-setup/9-jupyter-notebook.png" alt="Jupyter Notebook" />
110+
<Screenshot url="localhost:8888/tree" src="img/screenshots/20-dev-env/2-dev-env-setup/1-jupyter-notebook.png" alt="Jupyter Notebook" />
111+
112+
</TabItem>
113+
114+
</Tabs>

0 commit comments

Comments
 (0)