From 1585a83d0b7725b58454c7b3dc71eb9161b8ea54 Mon Sep 17 00:00:00 2001 From: Francesco Paolo Severino <96546612+fpseverino@users.noreply.github.com> Date: Tue, 18 Mar 2025 19:26:23 +0100 Subject: [PATCH] Toolbox v19 update (#1072) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This PR updates the documentation to the latest version of Vapor Toolbox, which added Linux distribution via Homebrew and removed some deprecated commands --------- Co-authored-by: Tim Condon <0xTim@users.noreply.github.com> --- docs/getting-started/xcode.de.md | 6 +----- docs/getting-started/xcode.es.md | 6 +----- docs/getting-started/xcode.it.md | 6 +----- docs/getting-started/xcode.ja.md | 6 +----- docs/getting-started/xcode.ko.md | 6 +----- docs/getting-started/xcode.md | 6 +----- docs/getting-started/xcode.nl.md | 6 +----- docs/getting-started/xcode.pl.md | 4 ---- docs/getting-started/xcode.zh.md | 6 +----- docs/install/linux.it.md | 24 +++++++++++++++++++++--- docs/install/linux.md | 24 +++++++++++++++++++++--- docs/install/macos.it.md | 27 ++++++++++++++++++++++++--- docs/install/macos.md | 25 +++++++++++++++++++++++-- 13 files changed, 97 insertions(+), 55 deletions(-) diff --git a/docs/getting-started/xcode.de.md b/docs/getting-started/xcode.de.md index d458ebc0..79d02216 100644 --- a/docs/getting-started/xcode.de.md +++ b/docs/getting-started/xcode.de.md @@ -18,15 +18,11 @@ Für den Fall, dass du den Pfad zu deinem Projekt nicht kennst, kannst du mit Hilfe des Terminal-Befehls 'pwd' den Pfad ganz einfach herausfinden. - ``` - # verify we are in vapor project folder - vapor --version + ```sh # get path to this folder pwd ``` ``` - framework: 4.x.x - toolbox: 18.x.x /path/to/project ``` \ No newline at end of file diff --git a/docs/getting-started/xcode.es.md b/docs/getting-started/xcode.es.md index 2ecc519d..9b73a506 100644 --- a/docs/getting-started/xcode.es.md +++ b/docs/getting-started/xcode.es.md @@ -28,9 +28,7 @@ En el editor de esquemas, elige la acción _App_ y la pestaña _Options_. Selecc Puedes obtener la dirección completa a la raíz de tu proyecto ejecutando `pwd` en una ventana de terminal ubicada en el proyecto. -```fish -# verificar que estamos en la carpeta del proyecto de vapor -vapor --version +```sh # obtener la dirección de la carpeta pwd ``` @@ -38,7 +36,5 @@ pwd Deberías obtener una salida similar a la que se muestra a continuación. ``` -framework: 4.x.x -toolbox: 18.x.x /path/to/project ``` diff --git a/docs/getting-started/xcode.it.md b/docs/getting-started/xcode.it.md index 0b3dc8db..21a27890 100644 --- a/docs/getting-started/xcode.it.md +++ b/docs/getting-started/xcode.it.md @@ -28,9 +28,7 @@ Nell'editor dello schema, scegliere l'azione _App_ e la scheda _Options_. Selezi Si può ottenere il percorso completo alla cartella principale del progetto eseguendo `pwd` da una finestra del terminale aperta lì. -```fish -# verificare di essere nella cartella del progetto vapor -vapor --version +```sh # ottenere il percorso di questa cartella pwd ``` @@ -38,7 +36,5 @@ pwd Si dovrebbe vedere un output simile al seguente. ``` -framework: 4.x.x -toolbox: 18.x.x /percorso/al/progetto ``` diff --git a/docs/getting-started/xcode.ja.md b/docs/getting-started/xcode.ja.md index c8df08d9..15bc547b 100644 --- a/docs/getting-started/xcode.ja.md +++ b/docs/getting-started/xcode.ja.md @@ -28,9 +28,7 @@ プロジェクトのルートへのフルパスは、その場所で開いたターミナルウィンドウから `pwd` を実行することで取得できます。 -```fish -# verify we are in vapor project folder -vapor --version +```sh # get path to this folder pwd ``` @@ -38,7 +36,5 @@ pwd 以下のような出力が表示されるはずです。 ``` -framework: 4.x.x -toolbox: 18.x.x /path/to/project ``` diff --git a/docs/getting-started/xcode.ko.md b/docs/getting-started/xcode.ko.md index 9c9a5f97..e43fd4a2 100644 --- a/docs/getting-started/xcode.ko.md +++ b/docs/getting-started/xcode.ko.md @@ -28,9 +28,7 @@ scheme editor에서 Options탭을 선택한 후 Use custom working directory를 프로젝트의 루트 폴더의 전체 경로를 얻으려면 해당 위치에서 터미널 창을 열고 `pwd`를 실행하세요. -```fish -# verify we are in vapor project folder -vapor --version +```sh # get path to this folder pwd ``` @@ -38,7 +36,5 @@ pwd 다음과 유사한 출력이 나타날 것입니다. ``` -framework: 4.x.x -toolbox: 18.x.x /path/to/project ``` diff --git a/docs/getting-started/xcode.md b/docs/getting-started/xcode.md index dccd74b0..5d7e0e7e 100644 --- a/docs/getting-started/xcode.md +++ b/docs/getting-started/xcode.md @@ -28,9 +28,7 @@ In the scheme editor, choose the _App_ action and the _Options_ tab. Check _Use You can get the full path to your project's root by running `pwd` from a terminal window open there. -```fish -# verify we are in vapor project folder -vapor --version +```sh # get path to this folder pwd ``` @@ -38,7 +36,5 @@ pwd You should see output similar to the following. ``` -framework: 4.x.x -toolbox: 18.x.x /path/to/project ``` diff --git a/docs/getting-started/xcode.nl.md b/docs/getting-started/xcode.nl.md index af98cbac..c1d1b9d6 100644 --- a/docs/getting-started/xcode.nl.md +++ b/docs/getting-started/xcode.nl.md @@ -28,9 +28,7 @@ Kies in de schema editor de actie _App_ en het tabblad _Options_. Vink _Use cust U kunt het volledige pad naar de root van uw project krijgen door `pwd` uit te voeren vanuit een terminal venster dat daar geopend is. -```fish -# controleer of we in de Vapor project map zijn -vapor --version +```sh # haal het pad naar deze map op pwd ``` @@ -38,7 +36,5 @@ pwd U zou uitvoer moeten zien zoals hieronder. ``` -framework: 4.x.x -toolbox: 18.x.x /path/to/project ``` diff --git a/docs/getting-started/xcode.pl.md b/docs/getting-started/xcode.pl.md index f1944f9c..756b2a2e 100644 --- a/docs/getting-started/xcode.pl.md +++ b/docs/getting-started/xcode.pl.md @@ -29,8 +29,6 @@ W edytorze schematów wybierz akcję _App_ i zakładkę _Options_. Zaznacz opcj Możesz uzyskać pełną ścieżkę do katalogu głównego projektu, uruchamiając `pwd` z otwartego tam okna terminala. ```sh -# Sprawdź, czy jesteśmy w folderze projektu vapor -vapor --version # Uzyskaj ścieżkę do tego folderu pwd ``` @@ -38,7 +36,5 @@ pwd Powinieneś zobaczyć dane wyjściowe podobne do poniższych. ``` -framework: 4.x.x -toolbox: 18.x.x /path/to/project ``` \ No newline at end of file diff --git a/docs/getting-started/xcode.zh.md b/docs/getting-started/xcode.zh.md index 16e6c414..5bdf9be8 100644 --- a/docs/getting-started/xcode.zh.md +++ b/docs/getting-started/xcode.zh.md @@ -28,9 +28,7 @@ Xcode 将默认在 _DerivedData_ 目录运行项目。这与项目的根目录 你可以在终端中运行 `pwd` 来获取你项目根目录的绝对目录。 -```fish -# 确认我们在 vapor 项目目录 -vapor --version +```sh # 获取当前目录的路径 pwd ``` @@ -38,7 +36,5 @@ pwd 你应该能看见类似下面的输出。 ``` -framework: 4.x.x -toolbox: 18.x.x /path/to/project ``` diff --git a/docs/install/linux.it.md b/docs/install/linux.it.md index b07ea252..b8eed363 100644 --- a/docs/install/linux.it.md +++ b/docs/install/linux.it.md @@ -51,9 +51,27 @@ Puoi anche usare le immagini Docker ufficiali di Swift che includono il compilat ## Installare la Toolbox -Ora che hai installato Swift, puoi installare la [Toolbox di Vapor](https://github.com/vapor/toolbox). Questo strumento CLI non è necessario per usare Vapor, ma include degli strumenti utili. +Ora che hai installato Swift, puoi installare la [Vapor Toolbox](https://github.com/vapor/toolbox). Questo strumento da linea di comando non è necessario per usare Vapor, ma aiuta nella creazione dei progetti Vapor. -Su Linux, dovrai compilare la toolbox dal codice sorgente. Guarda le release della toolbox su GitHub per trovare l'ultima versione. +### Homebrew + +La Toolbox è distribuita tramite Homebrew. Se non hai ancora Homebrew, visita brew.sh per le istruzioni di installazione. + +```sh +brew install vapor +``` + +Controlla che l'installazione sia andata a buon fine stampando l'aiuto. + +```sh +vapor --help +``` + +Dovresti vedere una lista di comandi disponibili. + +### Makefile + +Se vuoi, puoi compilare la Toolbox dal codice sorgente. Guarda le release della Toolbox su GitHub per trovare l'ultima versione. ```sh git clone https://github.com/vapor/toolbox.git @@ -72,4 +90,4 @@ Dovresti vedere una lista di comandi disponibili. ## Come continuare -Dopo aver installato Swift, puoi iniziare a creare il tuo primo progetto usando [Inizio → Ciao, mondo](../getting-started/hello-world.it.md). +Dopo aver installato Swift e la Vapor Toolbox, puoi iniziare a creare il tuo primo progetto usando [Inizio → Ciao, mondo](../getting-started/hello-world.it.md). diff --git a/docs/install/linux.md b/docs/install/linux.md index 9b74ee04..0c423f7e 100644 --- a/docs/install/linux.md +++ b/docs/install/linux.md @@ -51,9 +51,27 @@ You can also use Swift's official Docker images which come with the compiler pre ## Install Toolbox -Now that you have Swift installed, let's install the [Vapor Toolbox](https://github.com/vapor/toolbox). This CLI tool is not required to use Vapor, but it includes helpful utilities. +Now that you have Swift installed, let's install the [Vapor Toolbox](https://github.com/vapor/toolbox). This CLI tool is not required to use Vapor, but it helps to create new Vapor projects. -On Linux, you will need to build the toolbox from source. View the toolbox's releases on GitHub to find the latest version. +### Homebrew + +The Toolbox is distributed via Homebrew. If you do not have Homebrew yet, visit brew.sh for install instructions. + +```sh +brew install vapor +``` + +Double check to ensure that the installation was successful by printing help. + +```sh +vapor --help +``` + +You should see a list of available commands. + +### Makefile + +If you want, you can also build the Toolbox from source. View the Toolbox's releases on GitHub to find the latest version. ```sh git clone https://github.com/vapor/toolbox.git @@ -72,4 +90,4 @@ You should see a list of available commands. ## Next -After you have installed Swift, create your first app in [Getting Started → Hello, world](../getting-started/hello-world.md). +Now that you have installed Swift and the Vapor Toolbox, create your first app in [Getting Started → Hello, world](../getting-started/hello-world.md). diff --git a/docs/install/macos.it.md b/docs/install/macos.it.md index fe14b551..f476686c 100644 --- a/docs/install/macos.it.md +++ b/docs/install/macos.it.md @@ -27,9 +27,11 @@ Vapor 4 richiede Swift 5.9 o superiore. ## Installare la Toolbox -Ora che hai installato Swift, puoi installare la [Vapor Toolbox](https://github.com/vapor/toolbox). Questo strumento da linea di comando non è necessario per usare Vapor, ma include strumenti utili come il creatore di nuovi progetti. +Ora che hai installato Swift, puoi installare la [Vapor Toolbox](https://github.com/vapor/toolbox). Questo strumento da linea di comando non è necessario per usare Vapor, ma aiuta nella creazione dei progetti Vapor. -La toolbox è distribuita tramite Homebrew. Se non hai ancora Homebrew, visita brew.sh per le istruzioni di installazione. +### Homebrew + +La Toolbox è distribuita tramite Homebrew. Se non hai ancora Homebrew, visita brew.sh per le istruzioni di installazione. ```sh brew install vapor @@ -43,6 +45,25 @@ vapor --help Dovresti vedere una lista di comandi disponibili. +### Makefile + +Se vuoi, puoi compilare la Toolbox dal codice sorgente. Guarda le release della Toolbox su GitHub per trovare l'ultima versione. + +```sh +git clone https://github.com/vapor/toolbox.git +cd toolbox +git checkout +make install +``` + +Controlla che l'installazione sia andata a buon fine stampando l'aiuto. + +```sh +vapor --help +``` + +Dovresti vedere una lista di comandi disponibili. + ## Come continuare -Dopo aver installato Vapor, puoi iniziare a creare il tuo primo progetto usando [Inizio → Ciao, mondo](../getting-started/hello-world.it.md). +Dopo aver installato Swift e la Vapor Toolbox, puoi iniziare a creare il tuo primo progetto usando [Inizio → Ciao, mondo](../getting-started/hello-world.it.md). diff --git a/docs/install/macos.md b/docs/install/macos.md index f4e78250..ae2d8af7 100644 --- a/docs/install/macos.md +++ b/docs/install/macos.md @@ -27,9 +27,11 @@ Vapor 4 requires Swift 5.9 or greater. ## Install Toolbox -Now that you have Swift installed, let us install the [Vapor Toolbox](https://github.com/vapor/toolbox). This CLI tool is not required to use Vapor but it includes helpful utilities like a new project creator. +Now that you have Swift installed, let's install the [Vapor Toolbox](https://github.com/vapor/toolbox). This CLI tool is not required to use Vapor, but it helps to create new Vapor projects. -Toolbox is distributed via Homebrew. If you do not have Homebrew yet, visit brew.sh for install instructions. +### Homebrew + +The Toolbox is distributed via Homebrew. If you do not have Homebrew yet, visit brew.sh for install instructions. ```sh brew install vapor @@ -43,6 +45,25 @@ vapor --help You should see a list of available commands. +### Makefile + +If you want, you can also build the Toolbox from source. View the Toolbox's releases on GitHub to find the latest version. + +```sh +git clone https://github.com/vapor/toolbox.git +cd toolbox +git checkout +make install +``` + +Double check the installation was successful by printing help. + +```sh +vapor --help +``` + +You should see a list of available commands. + ## Next Now that you have installed Swift and Vapor Toolbox, create your first app in [Getting Started → Hello, world](../getting-started/hello-world.md).