Skip to content

Commit 029c1a5

Browse files
voetbergvoetberg
committed
Rename from review suggestions
1 parent dccef8c commit 029c1a5

File tree

3 files changed

+53
-80
lines changed

3 files changed

+53
-80
lines changed

‎docs/user/migrating_from_35_client.md‎ renamed to ‎docs/user/migrate_to_36_cli.md‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,26 @@
22
title: Migrating from pre-36.0.0 Clients
33
---
44

5-
In Rucio 36.0.0, a new rucio client was released.
6-
This new client redos the entire structure of both `rucio` and `rucio-admin`.
7-
`rucio-admin` is made redundant by the update, their commands are included in the `rucio >=36.0` client.
5+
In Rucio 36.0.0, a new Rucio client was released, with breaking changes to the structure of both `rucio` and `rucio-admin`.
6+
`rucio-admin` is made redundant by the update, and its commands are included in the `rucio >=36.0` client.
87

98
Note:
10-
Please report any issues you have with the new client [on this github issue](https://github.com/rucio/rucio/issues/7224)
9+
Please report any issues you have with the new client please [contact us](contact_us)
1110

1211
# Legacy Mapping
1312

1413
* Using `rucio-admin` or `rucio --legacy` automatically uses the old version. Old help menus are still visible with this method.
1514
* Old commands still work - they display a warning.
16-
* Not all commands are included in the 36 Client Release. Not all are one-to-one mapped.
17-
* A warning it printed (not logged) to consoles to encourage migration, along with the closest mapped command.
15+
* Not all commands are migrated to the new client structure. Not all included commands are one-to-one mapped.
16+
* A warning is printed (not logged) to consoles to encourage migration, along with the closest mapped command.
1817

1918

2019
# Remapping Existing Commands
2120

2221
|`rucio <36.0`| `rucio >=36.0`|
2322
| ------------- | ------------- |
24-
| rucio list-file-replicas | rucio replica list |
25-
| rucio list-dataset-replicas | rucio replica dataset |
23+
| rucio list-file-replicas | rucio replica list file |
24+
| rucio list-dataset-replicas | rucio replica list dataset |
2625
| rucio add-dataset | rucio did add --type dataset |
2726
| rucio add-container | rucio did add --type container |
2827
| rucio attach | rucio did content add |
@@ -48,7 +47,7 @@ Note:
4847
| rucio list-account-limits | rucio account limit list |
4948
| rucio add-rule | rucio rule add |
5049
| rucio delete-rule | rucio rule remove |
51-
| rucio rule-info | rucio rule info |
50+
| rucio rule-info | rucio rule show |
5251
| rucio list-rules | rucio rule list |
5352
| rucio list-rules-history | rucio rule history |
5453
| rucio update-rule | rucio rule update |

‎docs/user/using_the_client.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,9 @@ sidebar_position: 3
77
Rucio provides several commands for the end-user. See [executables](bin/rucio.md).
88
The command line client is called ``rucio``.
99

10-
Please note that these commands are not meant to be included in python scripts.
11-
For such applications, we encourage using the [python client](pathname:///html/site/client.html).
10+
Note: for Python scripts, we encourage using the [Python client](pathname:///html/site/client.html) instead of the commands listed here.
1211

13-
If you are using a version of the client prior to ~36.0, please view the [migration guide](user/migrating_from_35_client.md).
12+
If you are using a version of the client prior to ~36.0, please view the [migration guide](user/migrate_to_36_cli.md).
1413

1514
# Basic Commands
1615

@@ -443,7 +442,7 @@ You can set attributes to the users:
443442
And list these attributes:
444443
445444
```bash
446-
$ rucio-admin account attribute list --account jdoe
445+
$ rucio account attribute list --account jdoe
447446
+---------+-------+
448447
| Key | Value |
449448
|---------+-------|

‎website/sidebars.json‎

Lines changed: 42 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -7,78 +7,53 @@
77
"items": [
88
{"type": "autogenerated", "dirName": "started"},
99
"release-notes"
10-
],
11-
"User": [
12-
"user/setting_up_the_rucio_client",
13-
"user/configuring_the_client",
14-
"user/using_the_client",
15-
"user/using_the_admin_client",
16-
{
17-
"Python Client API": [
18-
{
19-
"type": "autogenerated",
20-
"dirName": "client_api"
21-
}
22-
]
23-
},
24-
"user/developing_with_rucio",
25-
"user/migrating_from_35_client"
26-
],
27-
"Operator": [
28-
"operator/setting_up_demo",
29-
"operator/kubernetes",
30-
"operator/installing_server",
31-
"operator/installing_daemons",
32-
"operator/configuration",
33-
"operator/k8s_guide",
34-
"operator/multi_vo_rucio",
35-
"operator/monitoring",
36-
"operator/database",
37-
"operator/administration",
38-
"operator/configuration_parameters",
39-
{
40-
"Transfers": [
41-
"operator/transfers/transfers-overview",
42-
"operator/transfers/transfers-preparer",
43-
"operator/transfers/transfers-throttler",
44-
"operator/transfers/transfers-submitter",
45-
"operator/transfers/configure-rucio-globus",
46-
"operator/transfers/configure-rucio-fts3-plugins"
47-
]
48-
},
49-
"operator/did_meta",
50-
"operator/policy_packages",
51-
"operator/s3_rse_config",
52-
"operator/qos_rse_config",
53-
"operator/notifications",
10+
]
11+
},
12+
{
13+
"label": "User",
14+
"type": "category",
15+
"items": [{"type": "autogenerated", "dirName": "user"}]
16+
},
17+
{
18+
"label": "Operator",
19+
"type": "category",
20+
"items": [
21+
{"type": "autogenerated", "dirName": "operator"},
5422
{
55-
"Executables": [
56-
{
57-
"type": "autogenerated",
58-
"dirName": "bin"
23+
"type": "category",
24+
"label": "Transfers",
25+
"items": [
26+
{"type": "autogenerated", "dirName": "operator_transfers"},
27+
{"type": "autogenerated", "dirName": "operator_policy_packages"},
28+
{
29+
"type": "link",
30+
"label": "TransferTools API",
31+
"href": "pathname:///html/transfer_tools/fts3.html"
32+
},
33+
{
34+
"type": "link",
35+
"label": "Transfer Protocols API",
36+
"href": "pathname:///html/transfer_protocols/posix.html"
5937
}
6038
]
61-
}
62-
],
63-
"Developer": [
64-
"developer/setting_up_mac_apple_silicon",
65-
"developer/setting_up_intellij_dev_env",
66-
"developer/setting_up_vscode_dev_env",
67-
"contributing",
68-
"developer/dependency_management",
69-
"developer/project_structure",
70-
"developer/rest_api_doc",
71-
"developer/type_annotation_guide",
72-
"developer/dev_style_guide",
39+
},
7340
{
74-
"WebUI": [
75-
"developer/webui/webui_frontend_vscode_dev_env",
76-
"developer/webui/streamedtables",
77-
"developer/webui/webui_frontend"
78-
]
41+
"type": "category",
42+
"label": "Executables",
43+
"items": [{"type": "autogenerated", "dirName": "bin"}]
7944
}
80-
],
81-
"About Us": [
45+
46+
]
47+
},
48+
{
49+
"label": "Developer",
50+
"type": "category",
51+
"items": [{"type": "autogenerated", "dirName": "developer"}]
52+
},
53+
{
54+
"label": "About Us",
55+
"type": "category",
56+
"items": [
8257
"project_organisation",
8358
"rucio_advisory_board",
8459
"component_leads",

0 commit comments

Comments
 (0)