From b918f8b7305690f464af07e4ed08384d1fc7911a Mon Sep 17 00:00:00 2001 From: Andrii Bodnar Date: Mon, 5 Feb 2024 16:26:19 +0200 Subject: [PATCH] docs: update the Files Management article --- website/docs/tutorials/files-management.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/website/docs/tutorials/files-management.md b/website/docs/tutorials/files-management.md index 294e8d8f..2ad6dd75 100644 --- a/website/docs/tutorials/files-management.md +++ b/website/docs/tutorials/files-management.md @@ -12,7 +12,7 @@ There are several commands you can use to manage your files. The CLI provides hi The high level commands are [`crowdin upload`](/commands/crowdin-upload) and [`crowdin download`](/commands/crowdin-download). These commands are easy to use and they rely mostly on the configuration file. -The low-level commands include [`crowdin file upload`](/commands/crowdin-file-upload), [`crowdin file download`](/commands/crowdin-file-download), and [`crowdin file delete`](/commands/crowdin-file-delete). These commands are more like a lightweight wrapper over the [Crowdin API](https://developer.crowdin.com/api/v2/). They give you more flexibility and control over the file management process. These commands are also supported by string-based projects. +The low-level commands include [`crowdin file upload`](/commands/crowdin-file-upload), [`crowdin file download`](/commands/crowdin-file-download), and [`crowdin file delete`](/commands/crowdin-file-delete). These commands are more like a lightweight wrapper over the [Crowdin API](https://developer.crowdin.com/api/v2/). They give you more flexibility and control over the file management process. ## The `upload` and `download` commands @@ -103,10 +103,6 @@ To download the source files from Crowdin, run the following command: crowdin download sources ``` -:::caution -This way of managing files is not supported for string-based projects. Use the `files` command instead. -::: - ## The `file` command The [`file`](/commands/crowdin-file) command is a low-level command that allows you to manage your files with more flexibility and control. @@ -123,13 +119,13 @@ crowdin file upload locales/en/messages.xml -d messages.xml The command above will take the file `locales/en/messages.xml` and upload it to Crowdin as `messages.xml` in the root directory. The `-d`/`--dest` option stands for `destination` and allows you to specify the path to the file in Crowdin. If you omit the `-d` option, the file will be uploaded to the root directory with the same path as the source file. -You can also upload strings to string-based projects as well: +You can upload strings to string-based projects as well: ```bash crowdin file upload locales/en/messages.xml --branch main --cleanup-mode --update-strings ``` -The `--branch` option is required for string-based projects. The `--cleanup-mode` and `--update-strings` options are not required. +The `--branch` option is required for string-based projects. The `--cleanup-mode` and `--update-strings` options are optional. Use the `--update-strings` option to update strings with the same identifiers and the `--cleanup-mode` option to remove strings that are not present in the uploaded file. To **upload translations** you need to specify the `-l`/`--language` option: