From da7b60072d62e864f94d1d56421dfc3edf1b7498 Mon Sep 17 00:00:00 2001 From: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com> Date: Thu, 27 Oct 2022 15:32:47 -0700 Subject: [PATCH] [ENGDOCS-1012] Get started refresh part 1 & 2 (#15965) * get started refresh part 1 and 2 --- _data/toc.yaml | 2 +- get-started/02_our_app.md | 123 +++++++++++++++---------------- get-started/11_what_next.md | 24 ++++++ get-started/index.md | 125 ++++---------------------------- get-started/kube-deploy.md | 2 +- get-started/swarm-deploy.md | 2 +- language/golang/build-images.md | 4 +- language/java/build-images.md | 3 +- language/nodejs/build-images.md | 3 +- language/python/build-images.md | 3 +- 10 files changed, 105 insertions(+), 186 deletions(-) diff --git a/_data/toc.yaml b/_data/toc.yaml index 4106fd4371..a04508ee81 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -29,7 +29,7 @@ guides: path: /get-docker/ - sectiontitle: Get started section: - - title: "Part 1: Orientation and setup" + - title: "Part 1: Overview" path: /get-started/ - title: "Part 2: Containerize an application" path: /get-started/02_our_app/ diff --git a/get-started/02_our_app.md b/get-started/02_our_app.md index 0508f3d6ad..306b60199b 100644 --- a/get-started/02_our_app.md +++ b/get-started/02_our_app.md @@ -6,39 +6,37 @@ redirect_from: description: Containerize and run a simple application to learn Docker --- +For the rest of this guide, you will be working with a simple todo +list manager that's running in Node.js. If you're not familiar with Node.js, +don't worry. This guide doesn't require JavaScript experience. -For the rest of this tutorial, we will be working with a simple todo -list manager that is running in Node.js. If you're not familiar with Node.js, -don't worry. No real JavaScript experience is needed. +To complete this guide, you'll need the following: -At this point, your development team is quite small and you're simply -building an app to prove out your MVP (minimum viable product). You want -to show how it works and what it's capable of doing without needing to -think about how it will work for a large team, multiple developers, etc. - -![Todo List Manager Screenshot](images/todo-list-sample.png){: style="width:50%;" } +- Docker running locally. Follow the instructions to [download and install Docker](../get-docker.md). +- A [Git client](https://git-scm.com/downloads){:target="_blank" rel="noopener" class="_"}. +- An IDE or a text editor to edit files. Docker recommends using [Visual Studio Code](https://code.visualstudio.com/){:target="_blank" rel="noopener" class="_"}. +- A conceptual understanding of [containers and images](../get-started/overview.md/#docker-objects). ## Get the app -Before we can run the application, we need to get the application source code onto -our machine. For real projects, you will typically clone the repo. But, for this tutorial, -we have created a ZIP file containing the application. +Before you can run the application, you need to get the application source code onto your machine. -1. Download the App contents from the [getting-started repository](https://github.com/docker/getting-started/tree/master){:target="_blank" rel="noopener" class="_"}. You can either pull the entire project or [download it as a zip](https://github.com/docker/getting-started/archive/refs/heads/master.zip) and extract the app folder out to get started with. +1. Clone the [getting-started repository](https://github.com/docker/getting-started/tree/master){:target="_blank" rel="noopener" class="_"} using the following command: -2. Once extracted, use your favorite code editor to open the project. If you're in need of - an editor, you can use [Visual Studio Code](https://code.visualstudio.com/){:target="_blank" rel="noopener" class="_"}. You should - see the `package.json` and two subdirectories (`src` and `spec`). + ```console + $ git clone https://github.com/docker/getting-started.git + ``` + +2. View the contents of the cloned repository. Inside the `getting-started/app` directory you should see `package.json` and two subdirectories (`src` and `spec`). ![Screenshot of Visual Studio Code opened with the app loaded](images/ide-screenshot.png){: style="width:650px;margin-top:20px;"} {: .text-center } ## Build the app's container image -In order to build the application, you'll need to use a `Dockerfile`. A -Dockerfile is simply a text-based file with no file extension. A Dockerfile contains a script of instructions that are used to create a container image. +In order to build the [container image](../get-started/overview.md/#docker-objects){:target="_blank" rel="noopener" class="_"}, you'll need to use a `Dockerfile`. A Dockerfile is simply a text-based file with no file extension. A Dockerfile contains a script of instructions that Docker uses to create a container image. -1. In the `app` folder, the same location as the `package.json` file, create a file named `Dockerfile`. You can use the following commands below to create a Dockerfile based on your operating system. +1. In the `app` directory, the same location as the `package.json` file, create a file named `Dockerfile`. You can use the following commands below to create a Dockerfile based on your operating system.