Skip to content

Commit 192518d

Browse files
thibaultmolthibaultmol
authored
Fixed some formatting that wasn't displaying correctly in readthedocs
1 parent 51f4e2e commit 192518d

File tree

2 files changed

+62
-68
lines changed

2 files changed

+62
-68
lines changed

‎docs/User_documentation_en.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -105,17 +105,21 @@ It is possible to import from the following sources:
105105

106106
#### Trello JSON
107107

108-
Steps:
109-
* Create the data file
110-
* Access Trello
111-
* go to the board you want to export
112-
* Follow the steps in [Trello documentation](https://help.trello.com/article/747-exporting-data-from-trello-1) and export as JSON
113-
* Create the configuration file
114-
* Execute the import informing the import file path, data file and source as `Trello JSON`
108+
**Limitations:**
109+
* Comments with more than 1000 characters are placed as attached files to the card.
115110

116-
Create the configuration file respecting the [JSON Schema](https://github.com/nextcloud/deck/blob/main/lib/Service/Importer/fixtures/config-trelloJson-schema.json) for import `Trello JSON`
111+
**Steps:**
112+
1. Create the data file:
113+
* Access Trello.
114+
* Go to the board you want to export.
115+
* Follow the steps in [Trello documentation](https://help.trello.com/article/747-exporting-data-from-trello-1) and export as JSON.
116+
2. Create the configuration file.
117+
3. Execute the import, specifying the import file path, data file, and source as `Trello JSON`.
118+
119+
Create the configuration file respecting the [JSON Schema](https://github.com/nextcloud/deck/blob/main/lib/Service/Importer/fixtures/config-trelloJson-schema.json) for importing `Trello JSON`.
117120

118121
Example configuration file:
122+
119123
```json
120124
{
121125
"owner": "admin",
@@ -126,26 +130,22 @@ Example configuration file:
126130
}
127131
```
128132

129-
**Limitations**:
130-
131-
Importing from a JSON file imports up to 1000 actions. To find out how many actions the board to be imported has, identify how many actions the JSON has.
133+
**Additional Limitations**:
134+
* Importing from a JSON file imports up to 1000 actions. To find out how many actions the board to be imported has, check the number of actions in the JSON.
132135

133136
#### Trello API
134137

135-
Import using API is recommended for boards with more than 1000 actions.
136-
137-
Trello makes it possible to attach links to a card. Deck does not have this feature. Attachments and attachment links are added in a markdown table at the end of the description for every imported card that has attachments in Trello.
138+
Importing via API is recommended for boards with more than 1000 actions. Trello allows attaching links to a card, but Deck does not support this feature. Attachment links are instead added in a markdown table at the end of the description for each imported card.
138139

139-
* Get the API Key and API Token [here](https://developer.atlassian.com/cloud/trello/guides/rest-api/api-introduction/#authentication-and-authorization)
140-
* Get the ID of the board you want to import by making a request to:
141-
https://api.trello.com/1/members/me/boards?key={yourKey}&token={yourToken}&fields=id,name
142-
143-
This ID you will use in the configuration file in the `board` property
144-
* Create the configuration file
145-
146-
Create the configuration file respecting the [JSON Schema](https://github.com/nextcloud/deck/blob/main/lib/Service/Importer/fixtures/config-trelloApi-schema.json) for import `Trello JSON`
140+
1. Get the API Key and Token [here](https://developer.atlassian.com/cloud/trello/guides/rest-api/api-introduction/#authentication-and-authorization).
141+
2. Obtain the ID of the board you want to import by making a request to:
142+
```
143+
https://api.trello.com/1/members/me/boards?key={yourKey}&token={yourToken}&fields=id,name
144+
```
145+
3. Create the configuration file, ensuring it follows the [JSON Schema](https://github.com/nextcloud/deck/blob/main/lib/Service/Importer/fixtures/config-trelloApi-schema.json) for `Trello JSON`.
147146

148147
Example configuration file:
148+
149149
```json
150150
{
151151
"owner": "admin",

‎docs/export-import.md‎

Lines changed: 40 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,27 @@
44
-->
55
## Export
66

7-
Deck currently supports exporting all boards a user owns in a single JSON file. The format is based on the database schema that deck uses. It can be used to re-import boards on the same or other instances.
7+
Deck currently supports exporting all boards a user owns in a single JSON file. The format is based on the database schema that Deck uses. It can be used to re-import boards on the same or other instances.
88

9-
The export currently has some kown limitations in terms of specific data not included:
9+
The export currently has some known limitations in terms of specific data not included:
1010
- Activity information
11-
- File attachments to deck cards
11+
- File attachments to Deck cards
1212
- Comments
13-
-
13+
1414
```
1515
occ deck:export userid > userid-deck-export.json
1616
```
17-
(userid = username you see in admin useraccounts page)
17+
*(`userid` = username as seen in the admin user accounts page)*
1818

19-
## Import boards
19+
## Import Boards
2020

2121
Importing can be done using the API or the `occ` `deck:import` command.
2222

2323
It is possible to import from the following sources:
2424

2525
### Deck JSON
2626

27-
A json file that has been obtained from the above described `occ deck:export [userid] > userid-deck-export.json` command can be imported.
27+
A JSON file that has been obtained from the above-described `occ deck:export [userid] > userid-deck-export.json` command can be imported.
2828

2929
```
3030
occ deck:import userid-deck-export.json
@@ -33,50 +33,48 @@ occ deck:import userid-deck-export.json
3333
You will be asked to provide a path to a config file.
3434

3535
To know what to put in there:
36-
- Have a look at your userid-deck-export.json
37-
- fairly at the top you will see "uid" with a username.
38-
- search for some more "uid" till you find all the usernames involved and note them.
39-
- search for "acl"
40-
- in there there are "uid" of groups note them too
36+
- Have a look at your `userid-deck-export.json`
37+
- Near the top, you will see `"uid"` with a username.
38+
- Search for additional `"uid"` entries to find all the usernames involved and note them.
39+
- Search for `"acl"`, where `"uid"`s of groups are also present; note them too.
4140

42-
In case you are importing from a different instance you must provide custom user id mapping in case users have different identifiers.
41+
If you are importing from a different instance, you must provide custom user ID mapping in case users have different identifiers.
4342

44-
create a config file e.g `deck-import-config-file-userid.json` and ajust the content of this example as descibed above.
45-
Userids on new instance can be seen in the admin useraccounts page.
46-
```
43+
Create a config file, e.g., `deck-import-config-file-userid.json`, and adjust the content of this example as described above. User IDs on the new instance can be seen in the admin user accounts page.
44+
45+
```json
4746
{
48-
"owner": "useridofnewownderofallboards",
47+
"owner": "useridofnewownerofallboards",
4948
"uidRelation": {
5049
"userid1onoldinstance": "userid1onnewinstance",
51-
"userid2onoldinstance": "userid2onnewinstance",
52-
"groupid1onoldinstance": "groupid1onnewinstance"
53-
50+
"userid2onoldinstance": "userid2onnewinstance",
51+
"groupid1onoldinstance": "groupid1onnewinstance"
5452
}
5553
}
5654
```
57-
after you hit enter everything will be imported.
5855

56+
After pressing enter, everything will be imported.
5957

6058
Additional info:
61-
- If you export a users boards, all boards that the user has access to will be exported. (also the onws shared to that user)
62-
59+
- If you export a user’s boards, all boards that the user has access to will be exported (including those shared with that user).
6360

6461
#### Trello JSON
6562

66-
Limitations:
63+
**Limitations:**
6764
* Comments with more than 1000 characters are placed as attached files to the card.
6865

69-
Steps:
70-
* Create the data file
71-
* Access Trello
72-
* go to the board you want to export
73-
* Follow the steps in [Trello documentation](https://help.trello.com/article/747-exporting-data-from-trello-1) and export as JSON
74-
* Create the configuration file
75-
* Execute the import informing the import file path, data file and source as `Trello JSON`
66+
**Steps:**
67+
1. Create the data file:
68+
* Access Trello.
69+
* Go to the board you want to export.
70+
* Follow the steps in [Trello documentation](https://help.trello.com/article/747-exporting-data-from-trello-1) and export as JSON.
71+
2. Create the configuration file.
72+
3. Execute the import, specifying the import file path, data file, and source as `Trello JSON`.
7673

77-
Create the configuration file respecting the [JSON Schema](https://github.com/nextcloud/deck/blob/main/lib/Service/Importer/fixtures/config-trelloJson-schema.json) for import `Trello JSON`
74+
Create the configuration file respecting the [JSON Schema](https://github.com/nextcloud/deck/blob/main/lib/Service/Importer/fixtures/config-trelloJson-schema.json) for importing `Trello JSON`.
7875

7976
Example configuration file:
77+
8078
```json
8179
{
8280
"owner": "admin",
@@ -87,26 +85,22 @@ Example configuration file:
8785
}
8886
```
8987

90-
**Limitations**:
91-
92-
Importing from a JSON file imports up to 1000 actions. To find out how many actions the board to be imported has, identify how many actions the JSON has.
88+
**Additional Limitations**:
89+
* Importing from a JSON file imports up to 1000 actions. To find out how many actions the board to be imported has, check the number of actions in the JSON.
9390

9491
#### Trello API
9592

96-
Import using API is recommended for boards with more than 1000 actions.
97-
98-
Trello makes it possible to attach links to a card. Deck does not have this feature. Attachments and attachment links are added in a markdown table at the end of the description for every imported card that has attachments in Trello.
93+
Importing via API is recommended for boards with more than 1000 actions. Trello allows attaching links to a card, but Deck does not support this feature. Attachment links are instead added in a markdown table at the end of the description for each imported card.
9994

100-
* Get the API Key and API Token [here](https://developer.atlassian.com/cloud/trello/guides/rest-api/api-introduction/#authentication-and-authorization)
101-
* Get the ID of the board you want to import by making a request to:
102-
https://api.trello.com/1/members/me/boards?key={yourKey}&token={yourToken}&fields=id,name
103-
104-
This ID you will use in the configuration file in the `board` property
105-
* Create the configuration file
106-
107-
Create the configuration file respecting the [JSON Schema](https://github.com/nextcloud/deck/blob/main/lib/Service/Importer/fixtures/config-trelloApi-schema.json) for import `Trello JSON`
95+
1. Get the API Key and Token [here](https://developer.atlassian.com/cloud/trello/guides/rest-api/api-introduction/#authentication-and-authorization).
96+
2. Obtain the ID of the board you want to import by making a request to:
97+
```
98+
https://api.trello.com/1/members/me/boards?key={yourKey}&token={yourToken}&fields=id,name
99+
```
100+
3. Create the configuration file, ensuring it follows the [JSON Schema](https://github.com/nextcloud/deck/blob/main/lib/Service/Importer/fixtures/config-trelloApi-schema.json) for `Trello JSON`.
108101

109102
Example configuration file:
103+
110104
```json
111105
{
112106
"owner": "admin",

0 commit comments

Comments
 (0)