From 3512ad7397a6ab755b5ccc3dbc18f43f63329564 Mon Sep 17 00:00:00 2001 From: Sam Bishop Date: Thu, 1 Jun 2023 04:12:42 -0600 Subject: [PATCH] Misc docs improvements (#806) * Fix leaf typo, update version numbers, add warning about Command Lines Tools, add tip about vapor github templates * Change to arm Co-authored-by: Gwynne Raskind * Remove xcode CLI tools warning * Update versions in doc translations --------- Co-authored-by: Gwynne Raskind --- docs/getting-started/hello-world.md | 5 ++++- docs/install/macos.de.md | 6 +++--- docs/install/macos.md | 10 +++++----- docs/install/macos.nl.md | 10 +++++----- docs/install/macos.zh.md | 12 ++++++------ docs/leaf/overview.md | 2 +- 6 files changed, 24 insertions(+), 21 deletions(-) diff --git a/docs/getting-started/hello-world.md b/docs/getting-started/hello-world.md index c7c66145..7cf0d6bf 100644 --- a/docs/getting-started/hello-world.md +++ b/docs/getting-started/hello-world.md @@ -18,6 +18,9 @@ vapor new hello -n !!! tip The `-n` flag gives you a bare bones template by automatically answering no to all questions. +!!! tip + You can also get the latest template from GitHub without Vapor Toolbox by cloning the [template respository](https://github.com/vapor/template-bare) + !!! tip Vapor and the template now uses `async`/`await` by default. If you cannot update to macOS 12 and/or need to continue to use `EventLoopFuture`s, @@ -28,7 +31,7 @@ Once the command finishes, change into the newly created folder: ```sh cd hello -``` +``` ## Build & Run diff --git a/docs/install/macos.de.md b/docs/install/macos.de.md index 825546f1..35c77e6b 100644 --- a/docs/install/macos.de.md +++ b/docs/install/macos.de.md @@ -1,6 +1,6 @@ # Installation unter macOS -Die Mindestvoraussetzung für Vapor unter macOS ist Swift 5.2 (oder aktueller). +Die Mindestvoraussetzung für Vapor unter macOS ist Swift 5.6 (oder aktueller). ## Xcode @@ -13,8 +13,8 @@ Sobald du die App heruntergeladen hast, führe die Installation aus. Starte nach ```sh swift --version -Apple Swift version 5.2 (swiftlang-1100.0.270.13 clang-1100.0.33.7) -Target: x86_64-apple-darwin19.0.0 +swift-driver version: 1.75.2 Apple Swift version 5.8 (swiftlang-5.8.0.124.2 clang-1403.0.22.11.100) +Target: arm64-apple-macosx13.0 ``` ## Toolbox diff --git a/docs/install/macos.md b/docs/install/macos.md index dc49a3c4..f1f589aa 100644 --- a/docs/install/macos.md +++ b/docs/install/macos.md @@ -1,10 +1,10 @@ # Install on macOS -To use Vapor on macOS, you will need Swift 5.2 or greater. Swift and all of its dependencies come bundled with Xcode. +To use Vapor on macOS, you will need Swift 5.6 or greater. Swift and all of its dependencies come bundled with Xcode. ## Install Xcode -Install [Xcode 11.4 or greater](https://itunes.apple.com/us/app/xcode/id497799835?mt=12) from the Mac App Store. +Install [Xcode](https://itunes.apple.com/us/app/xcode/id497799835?mt=12) from the Mac App Store. ![Xcode in Mac App Store](../images/xcode-mac-app-store.png) @@ -19,11 +19,11 @@ swift --version You should see Swift's version information printed. ```sh -Apple Swift version 5.2 (swiftlang-1100.0.270.13 clang-1100.0.33.7) -Target: x86_64-apple-darwin19.0.0 +swift-driver version: 1.75.2 Apple Swift version 5.8 (swiftlang-5.8.0.124.2 clang-1403.0.22.11.100) +Target: arm64-apple-macosx13.0 ``` -Vapor 4 requires Swift 5.2 or greater. +Vapor 4 requires Swift 5.6 or greater. ## Install Toolbox diff --git a/docs/install/macos.nl.md b/docs/install/macos.nl.md index e3e2cb88..20351243 100644 --- a/docs/install/macos.nl.md +++ b/docs/install/macos.nl.md @@ -1,10 +1,10 @@ # Installeren op macOS -Om Vapor te gebruiken op macOS, zal je Swift 5.2 of hoger nodig hebben. Swift en al zijn afhankelijkheden komen gebundeld met Xcode. +Om Vapor te gebruiken op macOS, zal je Swift 5.6 of hoger nodig hebben. Swift en al zijn afhankelijkheden komen gebundeld met Xcode. ## Installeer Xcode -Installeer [Xcode 11.4 of hoger](https://itunes.apple.com/us/app/xcode/id497799835?mt=12) van de Mac App Store. +Installeer [Xcode](https://itunes.apple.com/us/app/xcode/id497799835?mt=12) van de Mac App Store. ![Xcode in Mac App Store](../images/xcode-mac-app-store.png) @@ -19,11 +19,11 @@ swift --version Je zou de Swift versie informatie afgedrukt moeten zien. ```sh -Apple Swift version 5.2 (swiftlang-1100.0.270.13 clang-1100.0.33.7) -Target: x86_64-apple-darwin19.0.0 +swift-driver version: 1.75.2 Apple Swift version 5.8 (swiftlang-5.8.0.124.2 clang-1403.0.22.11.100) +Target: arm64-apple-macosx13.0 ``` -Vapor 4 vereist Swift 5.2 of hoger. +Vapor 4 vereist Swift 5.6 of hoger. ## Installeer de Toolbox diff --git a/docs/install/macos.zh.md b/docs/install/macos.zh.md index 3a48dfc8..f2b55aed 100644 --- a/docs/install/macos.zh.md +++ b/docs/install/macos.zh.md @@ -1,12 +1,12 @@ # 在 macOS 上安装 -要在 macOS 上使用 Vapor，你将需要 Swift 5.2 或更高版本。 Swift 及其所有依赖项都与 Xcode 捆绑。 +要在 macOS 上使用 Vapor，你将需要 Swift 5.6 或更高版本。 Swift 及其所有依赖项都与 Xcode 捆绑。 ## 安装 Xcode -从 [Mac App Store](https://itunes.apple.com/us/app/xcode/id497799835?mt=12) 安装 Xcode 11.4 或更高版本。 +从 [Mac App Store](https://itunes.apple.com/us/app/xcode/id497799835?mt=12) 安装 Xcode 或更高版本。 -![Xcode 11](https://user-images.githubusercontent.com/1342803/66688324-2396bc80-ec54-11e9-8b96-bd8b29d0ce7c.jpg) +![Xcode](https://user-images.githubusercontent.com/1342803/66688324-2396bc80-ec54-11e9-8b96-bd8b29d0ce7c.jpg) 下载 Xcode 之后，必须将其打开以完成安装。可能还需要耐心等待一会儿。 @@ -19,11 +19,11 @@ swift --version 你应该能够看到 Swift 的版本信息已打印。 ```sh -Apple Swift version 5.2 (swiftlang-1100.0.270.13 clang-1100.0.33.7) -Target: x86_64-apple-darwin19.0.0 +swift-driver version: 1.75.2 Apple Swift version 5.8 (swiftlang-5.8.0.124.2 clang-1403.0.22.11.100) +Target: arm64-apple-macosx13.0 ``` -Vapor 4 需要 Swift 5.2 或更高版本。 +Vapor 4 需要 Swift 5.6 或更高版本。 ## 安装工具箱(Install Toolbox) diff --git a/docs/leaf/overview.md b/docs/leaf/overview.md index 4f4b1b57..5b582e95 100644 --- a/docs/leaf/overview.md +++ b/docs/leaf/overview.md @@ -17,7 +17,7 @@ Leaf tags are made up of four elements: - Token `#`: This signals the leaf parser to begin looking for a tag. - Name `count`: that identifies the tag. - Parameter List `(users)`: May accept zero or more arguments. -- Body: An optional body can be supplied to some tags using a semicolon and a closing tag +- Body: An optional body can be supplied to some tags using a colon and a closing tag There can be many different usages of these four elements depending on the tag's implementation. Let's look at a few examples of how Leaf's built-in tags might be used: