Skip to content

Commit 79edf25

Browse files
Clarify codespaces in readme
1 parent 9f20194 commit 79edf25

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

.devcontainer/CODESPACES-QUICKSTART.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ environment, `.env` file, Azure CLI, and Python are all present. Look for the
1919
first terminal tab titled **“APIM Samples Codespace Starting”** (or re-open the
2020
first terminal in VS Code); it shows the output from `.devcontainer/post-start-setup.sh`.
2121

22-
If you ever want to rerun the verification manually, open a terminal and execute:
22+
For more visibility, you can also run the command in the terminal yourself:
2323

2424
```bash
2525
bash .devcontainer/post-start-setup.sh

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,11 +106,13 @@ APIM Samples supports two setup options:
106106

107107
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/Azure-Samples/Apim-Samples?devcontainer_path=.devcontainer%2Fpython314%2Fdevcontainer.json)
108108

109-
**The fastest way to get started is using our pre-configured development environment.** Everything is pre-installed and configured—just sign in to Azure and you're ready to go.
109+
**The fastest way to get started is using our pre-configured development environment. Just click the *Open in GitHub Codespaces* button above!** Everything is pre-installed and configured—just sign in to Azure and you're ready to go.
110110

111-
This is especially helpful if you're new to APIM, unfamiliar with Python environments, or want to avoid local setup complexity. The entire setup takes 2-3 minutes.
111+
This is especially helpful if you're new to APIM, unfamiliar with Python environments, or want to avoid local setup complexity. **The entire setup typically takes 2-3 minutes.**
112112

113-
**GitHub Codespaces**: Click the green "Code" button → "Codespaces" → "..." → "New with options..." → "Dev container configuration" (select Python version but ignore *Default project configuration*) → "Create codespace"
113+
**GitHub Codespaces**: You can also go through the menu by clicking the green "Code" button → "Codespaces" → "..." → "New with options..." → "Dev container configuration" (select Python version but ignore *Default project configuration*) → "Create codespace"
114+
115+
📖 **For detailed setup information, troubleshooting, and optimization details, see [Codespaces Quickstart](.devcontainer/CODESPACES-QUICKSTART.md) and [Dev Container Documentation](.devcontainer/README.md)**
114116

115117
<img src="./assets/codespaces-python-configurations.png" alt="Codespaces configuration selector for various supposed Python versions" title="Codespaces configuration selector" />
116118

@@ -130,7 +132,6 @@ This is especially helpful if you're new to APIM, unfamiliar with Python environ
130132

131133
All prerequisites are automatically installed and configured.
132134

133-
📖 **For detailed setup information, troubleshooting, and optimization details, see [Dev Container Documentation](.devcontainer/README.md)**
134135
</details>
135136

136137
### Option 2: Full Local Setup

0 commit comments

Comments
 (0)