From b2097b6fbd1ebb7701b7e2bb40615365e6bf3a98 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ot=C3=A1vio=20Jacobi?= Date: Sun, 27 Aug 2023 16:08:33 -0300 Subject: [PATCH] Use fleet slug instead of fleet name for examples Change-type: patch --- .cspell/balena-words.txt | 1 + pages/learn/getting-started.md | 13 +++++++------ pages/learn/welcome/primer.md | 2 +- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/.cspell/balena-words.txt b/.cspell/balena-words.txt index 444c1efae4..1f77ae8362 100644 --- a/.cspell/balena-words.txt +++ b/.cspell/balena-words.txt @@ -28,3 +28,4 @@ versionbot Versionist volume-pricing undiscounted +myuser diff --git a/pages/learn/getting-started.md b/pages/learn/getting-started.md index 9f3008d9c0..b7f1219acb 100644 --- a/pages/learn/getting-started.md +++ b/pages/learn/getting-started.md @@ -112,23 +112,24 @@ successful message appears. ## Create a release -After login, test the {{ $names.cli.lower }} by running the `{{ $names.company.lower }} fleets` command, which should return information about the fleet you created in the previous step. Take a note of the `FLEET NAME` as you'll need this in the next step to push the code to your device(s) in that fleet. +After login, test the {{ $names.cli.lower }} by running the `{{ $names.company.lower }} fleets` command, which should return information about the fleet you created in the previous step. Take a note of the `FLEET SLUG` as you'll need this in the next step to push the code to your device(s) in that fleet. ```shell $ {{ $names.company.lower }} fleets -ID FLEET NAME DEVICE TYPE ONLINE DEVICES DEVICE COUNT -98264 First-Fleet {{ $device.name }} 0 0 + Id App name Slug Device type ... + ─────── ────────────── ───────────────────────── ───────────────── ... + 98264 First-Fleet myuser/first-fleet {{ $device.name }} ``` A nice project to try is the [balena-{{ $language.id }}-hello-world][balena-{{ $language.id }}-hello-world] project. It's a {{ $language.name }} web server that serves a static page on port 80. To get started, [download the project][github-download-{{ $language.id }}] as a zipped file from GitHub, unzip it and open a terminal in the root of the extracted project directory. -To create a release, use the `{{ $names.company.lower }} push First-Fleet` command replacing -`First-Fleet` with the name of your fleet. Ensure you are working from the root of the extracted project directory. +To create a release, use the `{{ $names.company.lower }} push myuser/first-fleet` command replacing +`myuser/first-fleet` with the slug of your fleet. Ensure you are working from the root of the extracted project directory. ```shell -$ {{ $names.company.lower }} push First-Fleet +$ {{ $names.company.lower }} push myuser/first-fleet ``` This command pushes the code to the {{ $names.company.lower }} builders, where it will be compiled, built, turned into a release, and applied to every device in the fleet. diff --git a/pages/learn/welcome/primer.md b/pages/learn/welcome/primer.md index e00af40c36..c2e747e7de 100644 --- a/pages/learn/welcome/primer.md +++ b/pages/learn/welcome/primer.md @@ -37,7 +37,7 @@ First, the device connects to the network and performs its early provisioning, w ### Building containers -When you run the `{{ $names.company.lower }} push ` command from your development machine it will essentially take your project (or repository) folder, compress it and send it to the [{{ $names.cloud.lower }} build server](/learn/deploy/deployment/#the-balenacloud-build-server) where it will be built. Your code is built in an environment that matches the devices in your fleet. So if you’re pushing an app for BeagleBone Black devices, we’ll build your code in an ARMv7 environment. For Raspberry Pi 1, it's ARMv6. In fact, we provide native ARM builders for ARM images, just as we use x86 servers to build images for x86 devices. +When you run the `{{ $names.company.lower }} push ` command from your development machine it will essentially take your project (or repository) folder, compress it and send it to the [{{ $names.cloud.lower }} build server](/learn/deploy/deployment/#the-balenacloud-build-server) where it will be built. Your code is built in an environment that matches the devices in your fleet. So if you’re pushing an app for BeagleBone Black devices, we’ll build your code in an ARMv7 environment. For Raspberry Pi 1, it's ARMv6. In fact, we provide native ARM builders for ARM images, just as we use x86 servers to build images for x86 devices. For releases with [multiple containers][multicontainer], a `docker-compose.yml` file will need to be included at the root of your project. This configuration file specifies the services that make up your release, as well as the system resources each service has access to. Releases with a single container will have a default `docker-compose.yml` file generated if none is included.