Skip to content

Commit

Permalink
docs: v4 preparements
Browse files Browse the repository at this point in the history
  • Loading branch information
andrii-bodnar committed May 14, 2024
1 parent f624515 commit 8acc9c7
Show file tree
Hide file tree
Showing 6 changed files with 98 additions and 10 deletions.
2 changes: 1 addition & 1 deletion src/main/resources/messages/messages.properties
Original file line number Diff line number Diff line change
Expand Up @@ -657,7 +657,7 @@ message.branch_already_exists=Branch '%s' already exists in the project
message.branch_does_not_exist=Branch '%s' doesn't exist in the project
message.directory=Directory '%s'
message.translation=Translated:
message.approval=Approved:
message.approval=Proofread:
message.language=@|yellow %s|@(@|yellow %s|@):
message.translation_progress=\tTranslated: %d%% (Words: %d/%d, Phrases: %d/%d)
message.approval_progress=\tApproved: %d%% (Words: %d/%d, Phrases: %d/%d)
Expand Down
2 changes: 1 addition & 1 deletion website/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Some commands have their own config options.

## Requirements

Check that you have Java 8 or newer installed. Type `java -version` command in the terminal (Command Prompt on Windows) to check Java version. For example, java version "1.8.0_212" means that you have Java 8 Update 212 installed.
Check that you have **Java 17** or newer installed. Type `java -version` command in the terminal (Command Prompt on Windows) to check Java version.

If you don’t have Java installed, download it from [Oracle’s website](https://www.java.com/en/).

Expand Down
25 changes: 17 additions & 8 deletions website/docs/releases/migration-4.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,19 @@ This guide is intended to highlight the most important changes in Crowdin CLI v4
Need help or have questions? [Let's discuss it](https://github.com/crowdin/crowdin-cli/discussions/781)!
:::

## Requirements

As part of this release, Java has also been updated to the version 17 LTS.

## New commands

- [`crowdin config`](/commands/crowdin-config)
- [`crowdin project`](/commands/crowdin-project)
- [`crowdin language`](/commands/crowdin-language)
- [`crowdin branch clone`](/commands/crowdin-branch-clone)
- [`crowdin branch merge`](/commands/crowdin-branch-merge)
- [`crowdin completion`](/autocompletion)

## Command updates

### Pre-translate
Expand Down Expand Up @@ -124,6 +137,10 @@ The `lint` command has been replaced with the [`config lint`](/commands/crowdin-
+ crowdin config lint
```

## Exit codes

This release also includes more exit codes (previously we only had `0` for success and `1` for failure). See the [official documentation](/exit-codes) for more details.

## Deprecations and backward compatibility

### Download targets
Expand All @@ -142,11 +159,3 @@ Removed backward compatibility for file numeric id in the [`task add`](/commands
## Command output updates

In this release, we've also reviewed and improved the output of many commands to make them more informative and user-friendly. Changes include `list`, `add`, `upload`, `download`, `delete`, and other commands for various resources.

## Java version upgrade

Within this release Java was also upgraded to latest LTS version 17.

## Exit codes updates

This release also includes more exit codes (previously we had only `0` for success and `1` for failure) for failures. Please refer to official documentation page to find more details.
38 changes: 38 additions & 0 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,44 @@ const config = {
darkTheme: darkCodeTheme,
},
}),

plugins: [
[
'@docusaurus/plugin-client-redirects',
{
redirects: [
{
from: '/crowdin-cli/commands/crowdin-generate',
to: '/crowdin-cli/commands/crowdin-init',
},
{
from: '/crowdin-cli/commands/crowdin-list-branches',
to: '/crowdin-cli/commands/crowdin-branch-list',
},
{
from: '/crowdin-cli/commands/crowdin-list-languages',
to: '/crowdin-cli/commands/crowdin-language-list',
},
{
from: '/crowdin-cli/commands/crowdin-list-sources',
to: '/crowdin-cli/commands/crowdin-config-sources',
},
{
from: '/crowdin-cli/commands/crowdin-list-translations',
to: '/crowdin-cli/commands/crowdin-config-translations',
},
{
from: '/crowdin-cli/commands/crowdin-list-project',
to: '/crowdin-cli/commands/crowdin-file-list',
},
{
from: '/crowdin-cli/commands/crowdin-lint',
to: '/crowdin-cli/commands/crowdin-config-lint',
}
],
},
]
],
};

module.exports = config;
40 changes: 40 additions & 0 deletions website/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
},
"dependencies": {
"@docusaurus/core": "2.4.0",
"@docusaurus/plugin-client-redirects": "2.4.0",
"@docusaurus/preset-classic": "2.4.0",
"@easyops-cn/docusaurus-search-local": "^0.35.0",
"@mdx-js/react": "^1.6.22",
Expand Down

0 comments on commit 8acc9c7

Please sign in to comment.