Skip to content

Commit

Permalink
Merge pull request #2093 from dfinity/update-wording-dev-journey
Browse files Browse the repository at this point in the history
Dev Journey: Update wording to remove 'we'
  • Loading branch information
jessiemongeon1 authored Oct 30, 2023
2 parents a801e9b + 35471a9 commit 2391b0f
Show file tree
Hide file tree
Showing 35 changed files with 339 additions and 339 deletions.
2 changes: 1 addition & 1 deletion docs/tutorials/developer-journey/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The developer journey is designed to give both new and existing developers a cle

:::info

In this developer journey, we focus on developing canisters and applications using Motoko. In the future, there will be additional variations of the developer journey that focus on different developer paths, such as:
This developer journey will focus on developing canisters and applications using Motoko. In the future, there will be additional variations of the developer journey that focus on different developer paths, such as:

- Rust development.
- ckBTC-focused development.
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/developer-journey/level-0/01-ic-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The **Internet Computer (IC)** is a secure and transparent blockchain-based netw

Dapps are created by the development and deployment of **smart contracts**, which are known as **canisters** on the IC. Each canister is hosted on an independent blockchain network running on **nodes** called a **subnet**.

We'll dive into these terms a bit further in the next section, [Internet Computer terminology](02-ic-terms.md).
These terms will be explained a bit further in the next section, [Internet Computer terminology](02-ic-terms.md).

In order to understand how to develop dapps on the IC, first let's take a look at the architecture of the IC and how it functions.

Expand Down
16 changes: 8 additions & 8 deletions docs/tutorials/developer-journey/level-0/03-dev-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

Before we can begin our developer journey, we need to set up our developer environment. A developer environment consists of tools and packages that are required to develop code projects. Usually, developer environments are stored and hosted on your local computer, but there are some situations where a virtual, web-based development environment exists.
Before you can begin our developer journey, you need to set up our developer environment. A developer environment consists of tools and packages that are required to develop code projects. Usually, developer environments are stored and hosted on your local computer, but there are some situations where a virtual, web-based development environment exists.

An example of this is the [Motoko Playground](https://m7sm4-2iaaa-aaaab-qabra-cai.ic0.app/), which is a web-based, virtual developer environment that can be used by developers without having to set up a local environment. The Motoko Playground has several restrictions, however, and it isn't recommended to be used for workflows other than simple, small-scale testing.

Expand All @@ -22,7 +22,7 @@ Open a command line interface (CLI) window. This may be referred to as 'Terminal

#### Why does this matter?

We will primarily be using CLI-based tools, such as `dfx` and `git`, in this developer journey.
You will primarily be using CLI-based tools, such as `dfx` and `git`, in this developer journey.

#### Options for Windows users

Expand Down Expand Up @@ -62,7 +62,7 @@ The IC SDK is composed of several components that are required for developing on

To write and edit code, you will need a code editor. macOS and Linux systems come with some basic editors, such as `vi` or `nano`, but these have very limited functionality and can be hard to use.

We recommend you use [Visual Studio Code](https://code.visualstudio.com/download), as it is a popular choice and there is a [Motoko extension](https://github.com/dfinity/vscode-motoko) that provides additional tools for Motoko development.
It is recommended that you use [Visual Studio Code](https://code.visualstudio.com/download), as it is a popular choice and there is a [Motoko extension](https://github.com/dfinity/vscode-motoko) that provides additional tools for Motoko development.

#### Why does this matter?

Expand All @@ -74,15 +74,15 @@ Download and install [git](https://git-scm.com/downloads).

#### Why does this matter?

Many of the DFINITY public repositories are hosted on Github, such as our `examples` repository. We will be using code from this repository later in the developer journey, so it is important to install `git` to assure that you can download the sample code pieces and follow along with the later tutorials.
Many of the DFINITY public repositories are hosted on Github, such as our `examples` repository. You will be using code from this repository later in the developer journey, so it is important to install `git` to assure that you can download the sample code pieces and follow along with the later tutorials.

### Download and install Node.js

Download and install [node.js](https://nodejs.org/en).

#### Why does this matter?

Node.js is used by `dfx` to generate frontend code and dependencies. It is not required for dapps that do not contain a frontend interface, though it is required for you to follow along with this developer journey series, since we will explore frontend canisters in a later tutorial.
Node.js is used by `dfx` to generate frontend code and dependencies. It is not required for dapps that do not contain a frontend interface, though it is required for you to follow along with this developer journey series, since you will explore frontend canisters in a later tutorial.

### Assure all packages and tools are updated to the latest release versions

Expand All @@ -95,17 +95,17 @@ Having the latest release version assures that you have all of the newest featur

### Create a working directory

The last step in setting up our developer environment is to create a new directory for us to build in. You can create a new directory with the command:
The last step in setting up our developer environment is to create a new directory for you to build in. You can create a new directory with the command:

```
mkdir developer_journey
```

In future modules, we'll refer to this directory as the **working directory**. Each project that we create will be a *sub-directory* of this working directory.
In future modules, you'll refer to this directory as the **working directory**. Each project that you create will be a *sub-directory* of this working directory.

#### Why does this matter?

We'll use this working directory to contain the projects that we build throughout our developer journey. This will help keep things organized in our local file structure.
You'll use this working directory to contain the projects that you build throughout your developer journey. This will help keep things organized in our local file structure.

## Need help?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ A canister differs from a container, however, in the fact that a canister also s

Canisters can be developed in a variety of languages, such as Rust, JavaScript, Python, and TypeScript, though the primary language for canister development is **Motoko**, since Motoko has been developed specifically for canister development on the IC.

We'll dive further into Motoko and other languages in the next section, [introduction to languages](05-intro-languages.md).
You'll dive further into Motoko and other languages in the next section, [introduction to languages](05-intro-languages.md).

### Actors

Expand Down
14 changes: 7 additions & 7 deletions docs/tutorials/developer-journey/level-0/06-intro-dfx.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

`dfx` is a command line utility that is used to interact with the IC SDK. It is the primary tool that is used for creating, managing, and deploying dapps onto the Internet Computer.

The `dfx` parent command has several flags and subcommands that can be used to perform a wide array of operations. First, we'll take a look at basic usage of the command, then we'll get started creating our first project using dfx.
The `dfx` parent command has several flags and subcommands that can be used to perform a wide array of operations. First, you'll take a look at basic usage of the command, then you'll get started creating your first project using dfx.

## Basic usage

Expand All @@ -16,7 +16,7 @@ dfx [subcommand] [flag]

### Subcommands

The following is a list of the essential `dfx` subcommands that we'll be using throughout the developer journey series. For the full list of all possible subcommands, check out the [dfx reference documentation](/docs/references/cli-reference/dfx-parent.md).
The following is a list of the essential `dfx` subcommands that you'll be using throughout the developer journey series. For the full list of all possible subcommands, check out the [dfx reference documentation](/docs/references/cli-reference/dfx-parent.md).

- `build`: Used to build the canister output from the project's source code.
- `canister`: Used to manage deployed canisters.
Expand All @@ -42,7 +42,7 @@ The following is a list of the essential `dfx` subcommands that we'll be using t

### Options

Below are the essential options that we'll be referencing throughout the developer journey. For the full list of options, see the [reference documentation](/docs/references/cli-reference/dfx-parent.md).
Below are the essential options that you'll be referencing throughout the developer journey. For the full list of options, see the [reference documentation](/docs/references/cli-reference/dfx-parent.md).

- `--identity <identity>`: Used to specify the user identity to be used with the command.
- `--logfile <logfile>`: Used to write the command's output logs to a specific file.
Expand All @@ -67,7 +67,7 @@ DFX_VERSION=0.14.1 sh -ci "$(curl -sSL https://internetcomputer.org/install.sh)"

All dapps on the IC start off as **projects**. Projects are created using the `dfx` command and subcommands.

To get started, we'll use the default sample app to demonstrate how to create a project and explore the default project structure that is generated when a new project is created.
To get started, you'll use the default sample app to demonstrate how to create a project and explore the default project structure that is generated when a new project is created.

### Step 1: Open a terminal window on your local computer.

Expand All @@ -81,7 +81,7 @@ dfx new hello_world

When no flags are used, the `dfx new` command will create a new project using the default Motoko template. To create a project using the Rust project template, the flag `--type=rust` should be included in the command.

In this developer journey, we will be using Motoko for our development language, so we do not need to pass any additional flags with this command.
In this developer journey, you will be using Motoko for our development language, so you do not need to pass any additional flags with this command.

:::info
When creating new projects with `dfx`, only alphanumeric characters and underscores should be used. This is to assure that project names are valid within Motoko, JavaScript, and other contexts.
Expand Down Expand Up @@ -179,7 +179,7 @@ Let's explore these settings a bit further:

## Reviewing the default program code

Now that we've explored the default project structure, let's take a look at the default program code located in the `main.mo` file. This is located in the `src/hello_world_backend` directory. We will cover frontend development and the default files located in the frontend canister directory in a later tutorial.
Now that you've explored the default project structure, let's take a look at the default program code located in the `main.mo` file. This is located in the `src/hello_world_backend` directory. The developer journey will cover frontend development and the default files located in the frontend canister directory in a later tutorial.

New Motoko projects will always include a default, template `main.mo` file. To take a look at the file's default contents, open the `src/hello_world_backend/main.mo` file in a code or text editor. The code will resemble the following:

Expand All @@ -198,7 +198,7 @@ In this simple 'Hello, world' program, there are a few key elements:
- Then, the program uses an async keyword to indicate that the program will return an async message that consists of text string that is constructed using "Hello, ", the # operator, the name argument, and "!".


We'll explore actor objects, classes, and asynchronous messages in a future tutorial. For now, this will wrap up our introduction to `dfx`.
You'll explore actor objects, classes, and asynchronous messages in a future tutorial. For now, this will wrap up our introduction to `dfx`.

## Need help?

Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/developer-journey/level-0/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
- Ledger.
- Motoko.

- [0.3 Developer environment setup](03-dev-env.md): Before we can begin our developer journey, we need to set up our developer environment. A developer environment is comprised of tools and packages that are required to develop code projects. This module covers:
- [0.3 Developer environment setup](03-dev-env.md): Before you can begin our developer journey, you need to set up our developer environment. A developer environment is comprised of tools and packages that are required to develop code projects. This module covers:
- Setting up a developer environment:
- Confirming an internet connection.
- Confirming access to a CLI.
Expand All @@ -78,7 +78,7 @@
- Canister controllers.
- Cycles and resource charges.

- [0.5 Introduction to languages](05-intro-languages.md): In this page, we discuss the different languages that can be used to develop dapps, and provide a base-level introduction to the two primarily supported languages: Motoko and Rust. This module covers:
- [0.5 Introduction to languages](05-intro-languages.md): This page discusses the different languages that can be used to develop dapps, and provide a base-level introduction to the two primarily supported languages: Motoko and Rust. This module covers:
- Motoko.
- Motoko's attributes.
- Rust.
Expand Down
20 changes: 10 additions & 10 deletions docs/tutorials/developer-journey/level-1/1.1-live-demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

## Overview

In the previous segment of our developer journey, introduction to `dfx`, we created a new `dfx` project using the default 'Hello, world' template and looked into the project's structure and code. However, we didn't build or deploy the canister.
In the previous segment of our developer journey, introduction to `dfx`, you created a new `dfx` project using the default 'Hello, world' template and looked into the project's structure and code. However, you didn't build or deploy the canister.

In this tutorial, we'll deploy the `hello_world_backend` canister from [0.6: Introduction to dfx](../level-0/06-intro-dfx.md) to the Motoko playground.
In this tutorial, you'll deploy the `hello_world_backend` canister from [0.6: Introduction to dfx](../level-0/06-intro-dfx.md) to the Motoko playground.

## What is the Motoko playground?

Expand All @@ -29,13 +29,13 @@ Since the playground is designed for testing purposes, there are several restric

Using the `dfx` command `dfx deploy --playground`, canisters can be deployed directly from the CLI to the Motoko playground.

First, let's take a look at how to use this command to deploy our canister. Then we'll explore how we can interact with that canister once it has been deployed. This will act as a live demo for us to explore and use to gain an understanding of the deployment and interaction process.
First, let's take a look at how to use this command to deploy our canister. Then you'll explore how you can interact with that canister once it has been deployed. This will act as a live demo for you to explore and use to gain an understanding of the deployment and interaction process.

### Prerequisites

Before you start, verify that you have set up your developer environment according to the instructions in [0.3: Developer environment setup](../level-0/03-dev-env.md).

This example works with the canister previously created in the [0.6: Introduction to dfx](../level-0/06-intro-dfx.md) module. We recommend completing that module before beginning the steps outlined here.
This example works with the canister previously created in the [0.6: Introduction to dfx](../level-0/06-intro-dfx.md) module. It is recommended to complete that module before beginning the steps outlined here.

### Deploying to the playground using `dfx`

Expand All @@ -45,7 +45,7 @@ This example works with the canister previously created in the [0.6: Introductio

To deploy a canister to the playground network, first open a terminal window if you do not already have one open.

Then, navigate into the project that we created in the [0.6: Introduction to dfx](../level-0/06-intro-dfx.md) module. You can use a command such as:
Then, navigate into the project that you created in the [0.6: Introduction to dfx](../level-0/06-intro-dfx.md) module. You can use a command such as:

```sh
cd developer_journey
Expand All @@ -55,7 +55,7 @@ For more information on file system navigation using the CLI, check out the docu

For a review on the project's structure and our `main.mo` source code file, you can review the [0.6: Introduction to dfx](../level-0/06-intro-dfx.md) module.

Before we can deploy the canister, we need to start the local execution environment. To do this, run the command:
Before you can deploy the canister, you need to start the local execution environment. To do this, run the command:

```sh
dfx start --clean --background
Expand All @@ -72,7 +72,7 @@ dfx deploy developer_journey_backend --playground
```

:::info
This command deploys just the backend canister, since that will be the canister we're focused on. To deploy all canisters listed in the `dfx.json` file, which by default includes a frontend canister in addition to the backend canister, you can use the `dfx deploy --playground` command without specifying the canister's name.
This command deploys just the backend canister, since that will be the canister you're focused on. To deploy all canisters listed in the `dfx.json` file, which by default includes a frontend canister in addition to the backend canister, you can use the `dfx deploy --playground` command without specifying the canister's name.
:::

The output of this command will resemble the following:
Expand All @@ -88,7 +88,7 @@ URLs:

Once deployed, the canister can be interacted with from the command line, or from the URL shown in the output above that refers to the backend canister's Candid interface. First, let's look at using the command line.

If you recall from the [0.6: Introduction to dfx](../level-0/06-intro-dfx.md) module, our canister has a single method called `greet`, which we can call using a command such as:
If you recall from the [0.6: Introduction to dfx](../level-0/06-intro-dfx.md) module, our canister has a single method called `greet`, which you can call using a command such as:

```sh
dfx canister --network playground call developer_journey_backend greet '("everyone")'
Expand All @@ -102,7 +102,7 @@ As a result, the canister should return the following reply:
("Hello, everyone!")
```

You can change the text portion to anything you'd like to test the method further. For example, instead of 'everyone', we can pass 'developers' into the method, such as:
You can change the text portion to anything you'd like to test the method further. For example, instead of 'everyone', you can pass 'developers' into the method, such as:

```sh
dfx canister --network playground call developer_journey_backend greet '("developers")'
Expand Down Expand Up @@ -164,6 +164,6 @@ Did you get stuck somewhere in this tutorial, or feel like you need additional h

## Next steps

Now that we've explored a live canister deployed on the Motoko playground, we'll move onto developing our own dapp rather than using the default template files. But first, let's go over the basics of Motoko in Motoko level 1.
Now that you've explored a live canister deployed on the Motoko playground, you'll move onto developing your own dapp rather than using the default template files. But first, let's go over the basics of Motoko in Motoko level 1.

- [1.2 Motoko level 1](1.2-motoko-lvl1.md).
Loading

0 comments on commit 2391b0f

Please sign in to comment.