Skip to content

Codex/clarify edit location #24395

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

Open
admin-space wants to merge 3 commits into
base: main
Choose a base branch
from
+16 −13
Open

Codex/clarify edit location #24395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b0e739d
Clarify cache backend image-manifest default
Mar 16, 2026
59dd215
Clarify where to edit code in develop with containers guide
Mar 17, 2026
7241041
Document apply_patch usage to avoid shell errors
Mar 17, 2026
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
1 change: 1 addition & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,3 +73,4 @@ you don't make that mistake again."
- Don't bold product names or for emphasis — only bold UI elements
- Don't use time-relative language: "currently", "new", "recently", "now"
- Don't edit vendored content in `_vendor/` or `data/cli/`
- Don't try to run apply_patch through a shell pipeline; call the apply_patch tool directly to avoid Powershell errors
26 changes: 14 additions & 12 deletions content/get-started/introduction/develop-with-containers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
description: This concept page will teach you how to develop with containers
summary: |
Learn how to run your first container, gaining hands-on experience with
Docker's powerful features. We'll cover making real-time changes to both
backend and frontend code within the containerized environment, ensuring
seamless integration and testing.
Docker's powerful features. This guide covers making real-time changes to both
backend and frontend code within the containerized environment, keeping
integration and testing aligned.
weight: 2
aliases:
- /guides/getting-started/develop-with-containers/
Expand All @@ -16,7 +16,7 @@

## Explanation

Now that you have Docker Desktop installed, you are ready to do some application development. Specifically, you will do the following:
After installing Docker Desktop, you are ready to do some application development. Specifically, you will do the following:

1. Clone and start a development project
2. Make changes to the backend and frontend
Expand Down Expand Up @@ -60,24 +60,26 @@

### What's in the environment?

Now that the environment is up and running, what's actually in it? At a high-level, there are several containers (or processes) that each serve a specific need for the application:
With the environment up and running, what's actually in it? At a high-level, there are several containers (or processes) that each serve a specific need for the application:

- React frontend - a Node container that's running the React dev server, using [Vite](https://vitejs.dev/).
- Node backend - the backend provides an API that provides the ability to retrieve, create, and delete to-do items.
- MySQL database - a database to store the list of the items.
- phpMyAdmin - a web-based interface to interact with the database that is accessible at [http://db.localhost](http://db.localhost).
- Traefik proxy - [Traefik](https://traefik.io/traefik/) is an application proxy that routes requests to the right service. It sends all requests for `localhost/api/*` to the backend, requests for `localhost/*` to the frontend, and then requests for `db.localhost` to phpMyAdmin. This provides the ability to access all applications using port 80 (instead of different ports for each service).

With this environment, you as the developer don’t need to install or configure any services, populate a database schema, configure database credentials, or anything. You only need Docker Desktop. The rest just works.
With this environment, you as the developer don't need to install or configure any services, populate a database schema, configure database credentials, or anything. You only need Docker Desktop. Docker handles the rest.


## Make changes to the app

With this environment up and running, you’re ready to make a few changes to the application and see how Docker helps provide a fast feedback loop.
With this environment up and running, you're ready to make a few changes to the application and see how Docker helps provide a fast feedback loop.

All of the code lives on your machine in the `getting-started-todo-app` folder you cloned. Docker Compose mounts that folder into the running containers and watches for changes, so open and edit the files locally with your editor. You don't need to exec into a container to change the code. The paths in the steps below are relative to `getting-started-todo-app`.

Check warning on line 78 in content/get-started/introduction/develop-with-containers.md

View workflow job for this annotation

GitHub Actions / validate (vale) 

[vale] reported by reviewdog 🐶
[Docker.RecommendedWords] Consider using 'following' instead of 'below'

Raw Output:
{"message": "[Docker.RecommendedWords] Consider using 'following' instead of 'below'", "location": {"path": "content/get-started/introduction/develop-with-containers.md", "range": {"start": {"line": 78, "column": 315}}}, "severity": "INFO"}

### Change the greeting

The greeting at the top of the page is populated by an API call at `/api/greeting`. Currently, it always returns "Hello world!". You’ll now modify it to return one of three randomized messages (that you'll get to choose).
The greeting at the top of the page is populated by an API call at `/api/greeting`. Currently, it always returns "Hello world!". You'll now modify it to return one of three randomized messages (that you'll get to choose).

1. Open the `backend/src/routes/getGreeting.js` file in a text editor. This file provides the handler for the API endpoint.

Expand All @@ -104,7 +106,7 @@

### Change the placeholder text

When you look at the app, you'll see the placeholder text is simply "New Item". You’ll now make that a little more descriptive and fun. You’ll also make a few changes to the styling of the app too.
When you look at the app, you'll see the placeholder text reads "New Item". You'll now make that a little more descriptive and fun. You'll also make a few changes to the styling of the app too.

1. Open the `client/src/components/AddNewItemForm.jsx` file. This provides the component to add a new item to the to-do list.

Expand All @@ -120,7 +122,7 @@
/>
```

3. Save the file and go back to your browser. You should see the change already hot-reloaded into your browser. If you don't like it, feel free to tweak it until it looks just right.
3. Save the file and go back to your browser. You should see the change already hot-reloaded into your browser. If you don't like it, feel free to tweak it until it looks the way you want.

![Screenshot of the to-do app with an updated placeholder in the add item text field"](images/develop-app-with-updated-placeholder.webp)

Expand Down Expand Up @@ -159,11 +161,11 @@

- Make changes and see them immediately. This was made possible because 1) the processes running in each container are watching and responding to file changes and 2) the files are shared with the containerized environment.

Docker Desktop enables all of this and so much more. Once you start thinking with containers, you can create almost any environment and easily share it with your team.
Docker Desktop makes this possible and more. Once you start thinking with containers, you can create almost any environment and share it with your team.

## Next steps

Now that the application has been updated, you’re ready to learn about packaging it as a container image and pushing it to a registry, specifically Docker Hub.
After updating the application, you're ready to learn about packaging it as a container image and pushing it to a registry, specifically Docker Hub.

{{< button text="Build and push your first image" url="build-and-push-first-image" >}}

2 changes: 1 addition & 1 deletion content/manuals/build/cache/backends/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,4 +181,4 @@ $ docker buildx build --push -t <registry>/<image> \
```

> [!NOTE]
> Since BuildKit v0.21, `image-manifest` is enabled by default.
> The `image-manifest` parameter is enabled by default. For BuildKit versions earlier than v0.21, set this parameter explicitly.
Loading