Skip to content

Commit ffacf0b

Browse files
andrii-bodnarandrii-bodnar
authored
docs: website polishing (#807)
1 parent 8716ee4 commit ffacf0b

File tree

5 files changed

+59
-61
lines changed

5 files changed

+59
-61
lines changed

‎README.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,10 @@ Crowdin CLI is a command line tool that allows you to manage and synchronize you
1313
- automate the process of updating your source files in your Crowdin project
1414
- download translations from Crowdin and automatically save them in the correct locations
1515
- upload all your existing translations to Crowdin in minutes
16-
- integrate Crowdin with GIT, SVN, Mercurial, and other software
16+
- manage your localization resources without leaving the terminal
17+
- integrate Crowdin CLI with GitHub, GitLab, Jenkins, CircleCI, and other software
1718

18-
This is a cross-platform and it runs in a terminal on Linux based and macOS operating systems or in Command Prompt on Windows.
19+
It is cross-platform and runs in a terminal on Linux-based and macOS operating systems, or in the command prompt on Windows.
1920

2021
<div align="center">
2122

@@ -45,17 +46,12 @@ This is a cross-platform and it runs in a terminal on Linux based and macOS oper
4546

4647
Visit the [documentation](https://crowdin.github.io/crowdin-cli/) for more details.
4748

48-
## Seeking Assistance
49+
## Seeking Assistance and Contributing
4950

5051
If you find any problems or would like to suggest a feature, please read the [How can I contribute](/CONTRIBUTING.md#how-can-i-contribute) section in our contributing guidelines.
5152

52-
Need help working with Crowdin CLI or have a question? Visit our [Community Forum](https://community.crowdin.com/) or contact [Customer Success Service](https://crowdin.com/contacts).
53-
54-
## Contributing
55-
56-
If you would like to contribute, please read the [Contributing Guidelines](/CONTRIBUTING.md).
57-
5853
## License
54+
5955
<pre>
6056
The Crowdin CLI is licensed under the MIT License.
6157
See the LICENSE file distributed with this work for additional

‎snapcraft.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ description: |
66
- automate the process of updating your source files in your Crowdin project
77
- download translations from Crowdin and automatically save them in the correct locations
88
- upload all your existing translations to Crowdin in minutes
9-
- integrate Crowdin with GIT, SVN, Mercurial, and other software
9+
- manage your localization resources without leaving the terminal
10+
- integrate Crowdin CLI with GitHub, GitLab, Jenkins, CircleCI, and other software
1011
1112
## Usage
1213

‎src/main/resources/messages/messages.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ crowdin.comment.add.type=Defines the comment type. Supported types: comment, iss
365365
crowdin.comment.add.issue-type=Defines the issue type. Supported types: general_question, translation_mistake, context_request, source_mistake
366366

367367
# CROWDIN PRE-TRANSLATE
368-
crowdin.pre-translate.usage.description=Pre-translate files via Machine Translation (MT) or Translation Memory (TM)
368+
crowdin.pre-translate.usage.description=Pre-translate files via Machine Translation (MT), Translation Memory (TM), or AI
369369
crowdin.pre-translate.usage.customSynopsis=@|fg(green) crowdin pre-translate|@ [CONFIG OPTIONS] [OPTIONS]
370370
crowdin.pre-translate.language=Languages to which pre-translation should be applied. Can be specified multiple times. Default: all
371371
crowdin.pre-translate.file=Path to the file in the Crowdin project. Can be specified multiple times

‎website/blog/2024-05-28-cli-v4/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Tip: Use the [`file list`](/commands/crowdin-file-list) command to get the file
5757
* Now <kbd>--identifier</kbd> is used as an option to edit and not to find the needed string.
5858
* The [`string delete`](/commands/crowdin-string-delete) command changes:
5959
* Moved <kbd>id</kbd> to a parameter instead of a command option. Now only 1 string can be removed at a time.
60-
* Removed the <kbd>--text</kbd> and <kbd>--identifier</kbd> options. Only <kbd>id</kbd> is used as a string identifier.
60+
* Removed the <kbd>--text</kbd> and <kbd>--identifier</kbd> options. Only ID is used as a string identifier.
6161
* The `comment` command has been replaced with the [`comment add`](/commands/crowdin-comment-add) command.
6262

6363
```diff

‎website/sidebars.js

Lines changed: 50 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -26,46 +26,47 @@ const sidebars = {
2626
items: [
2727
'commands/crowdin',
2828
'commands/crowdin-init',
29+
'commands/crowdin-pre-translate',
2930
{
3031
type: 'category',
31-
label: 'crowdin project',
32+
label: 'crowdin upload',
3233
link: {
3334
type: 'doc',
34-
id: 'commands/crowdin-project'
35+
id: 'commands/crowdin-upload'
3536
},
3637
collapsible: true,
3738
collapsed: true,
3839
items: [
39-
'commands/crowdin-project-list',
40-
'commands/crowdin-project-browse',
40+
'commands/crowdin-upload-sources',
41+
'commands/crowdin-upload-translations',
4142
]
4243
},
4344
{
4445
type: 'category',
45-
label: 'crowdin upload',
46+
label: 'crowdin download',
4647
link: {
4748
type: 'doc',
48-
id: 'commands/crowdin-upload'
49+
id: 'commands/crowdin-download'
4950
},
5051
collapsible: true,
5152
collapsed: true,
5253
items: [
53-
'commands/crowdin-upload-sources',
54-
'commands/crowdin-upload-translations',
54+
'commands/crowdin-download-translations',
55+
'commands/crowdin-download-sources',
5556
]
5657
},
5758
{
5859
type: 'category',
59-
label: 'crowdin download',
60+
label: 'crowdin status',
6061
link: {
6162
type: 'doc',
62-
id: 'commands/crowdin-download'
63+
id: 'commands/crowdin-status'
6364
},
6465
collapsible: true,
6566
collapsed: true,
6667
items: [
67-
'commands/crowdin-download-translations',
68-
'commands/crowdin-download-sources',
68+
'commands/crowdin-status-translation',
69+
'commands/crowdin-status-proofreading',
6970
]
7071
},
7172
{
@@ -86,92 +87,93 @@ const sidebars = {
8687
},
8788
{
8889
type: 'category',
89-
label: 'crowdin config',
90+
label: 'crowdin branch',
9091
link: {
9192
type: 'doc',
92-
id: 'commands/crowdin-config'
93+
id: 'commands/crowdin-branch'
9394
},
9495
collapsible: true,
9596
collapsed: true,
9697
items: [
97-
'commands/crowdin-config-lint',
98-
'commands/crowdin-config-sources',
99-
'commands/crowdin-config-translations',
98+
'commands/crowdin-branch-list',
99+
'commands/crowdin-branch-add',
100+
'commands/crowdin-branch-clone',
101+
'commands/crowdin-branch-merge',
102+
'commands/crowdin-branch-delete',
100103
]
101104
},
102105
{
103106
type: 'category',
104-
label: 'crowdin branch',
107+
label: 'crowdin string',
105108
link: {
106109
type: 'doc',
107-
id: 'commands/crowdin-branch'
110+
id: 'commands/crowdin-string'
108111
},
109112
collapsible: true,
110113
collapsed: true,
111114
items: [
112-
'commands/crowdin-branch-list',
113-
'commands/crowdin-branch-add',
114-
'commands/crowdin-branch-delete',
115-
'commands/crowdin-branch-clone',
116-
'commands/crowdin-branch-merge',
115+
'commands/crowdin-string-list',
116+
'commands/crowdin-string-add',
117+
'commands/crowdin-string-edit',
118+
'commands/crowdin-string-delete',
117119
]
118120
},
119121
{
120122
type: 'category',
121-
label: 'crowdin language',
123+
label: 'crowdin bundle',
122124
link: {
123125
type: 'doc',
124-
id: 'commands/crowdin-language'
126+
id: 'commands/crowdin-bundle'
125127
},
126128
collapsible: true,
127129
collapsed: true,
128130
items: [
129-
'commands/crowdin-language-list',
131+
'commands/crowdin-bundle-list',
132+
'commands/crowdin-bundle-add',
133+
'commands/crowdin-bundle-download',
130134
]
131135
},
136+
132137
{
133138
type: 'category',
134-
label: 'crowdin status',
139+
label: 'crowdin config',
135140
link: {
136141
type: 'doc',
137-
id: 'commands/crowdin-status'
142+
id: 'commands/crowdin-config'
138143
},
139144
collapsible: true,
140145
collapsed: true,
141146
items: [
142-
'commands/crowdin-status-translation',
143-
'commands/crowdin-status-proofreading',
147+
'commands/crowdin-config-lint',
148+
'commands/crowdin-config-sources',
149+
'commands/crowdin-config-translations',
144150
]
145151
},
146152
{
147153
type: 'category',
148-
label: 'crowdin string',
154+
label: 'crowdin project',
149155
link: {
150156
type: 'doc',
151-
id: 'commands/crowdin-string'
157+
id: 'commands/crowdin-project'
152158
},
153159
collapsible: true,
154160
collapsed: true,
155161
items: [
156-
'commands/crowdin-string-list',
157-
'commands/crowdin-string-add',
158-
'commands/crowdin-string-edit',
159-
'commands/crowdin-string-delete',
162+
'commands/crowdin-project-list',
163+
'commands/crowdin-project-browse',
160164
]
161165
},
162166
{
163167
type: 'category',
164-
label: 'crowdin bundle',
168+
label: 'crowdin language',
165169
link: {
166170
type: 'doc',
167-
id: 'commands/crowdin-bundle'
171+
id: 'commands/crowdin-language'
168172
},
169173
collapsible: true,
170174
collapsed: true,
171175
items: [
172-
'commands/crowdin-bundle-list',
173-
'commands/crowdin-bundle-add',
174-
'commands/crowdin-bundle-download',
176+
'commands/crowdin-language-list',
175177
]
176178
},
177179
{
@@ -215,8 +217,8 @@ const sidebars = {
215217
collapsed: true,
216218
items: [
217219
'commands/crowdin-comment-list',
218-
'commands/crowdin-comment-resolve',
219220
'commands/crowdin-comment-add',
221+
'commands/crowdin-comment-resolve',
220222
]
221223
},
222224
{
@@ -229,8 +231,8 @@ const sidebars = {
229231
collapsible: true,
230232
collapsed: true,
231233
items: [
232-
'commands/crowdin-task-add',
233234
'commands/crowdin-task-list',
235+
'commands/crowdin-task-add',
234236
]
235237
},
236238
{
@@ -243,8 +245,8 @@ const sidebars = {
243245
collapsible: true,
244246
collapsed: true,
245247
items: [
246-
'commands/crowdin-distribution-add',
247248
'commands/crowdin-distribution-list',
249+
'commands/crowdin-distribution-add',
248250
'commands/crowdin-distribution-release',
249251
]
250252
},
@@ -258,8 +260,8 @@ const sidebars = {
258260
collapsible: true,
259261
collapsed: true,
260262
items: [
261-
'commands/crowdin-screenshot-upload',
262263
'commands/crowdin-screenshot-list',
264+
'commands/crowdin-screenshot-upload',
263265
'commands/crowdin-screenshot-delete',
264266
]
265267
},
@@ -273,12 +275,11 @@ const sidebars = {
273275
collapsible: true,
274276
collapsed: true,
275277
items: [
276-
'commands/crowdin-label-add',
277278
'commands/crowdin-label-list',
279+
'commands/crowdin-label-add',
278280
'commands/crowdin-label-delete',
279281
]
280-
},
281-
'commands/crowdin-pre-translate',
282+
}
282283
],
283284
},
284285
'ci-cd',

0 commit comments

Comments
 (0)