Skip to content

Commit 49019d4

Browse files
authored
docs: size-related labels in Files screen (ipfs#2295)
* docs: clarify mfs total size caveat * refactor: rename to localDatastoreDescription reducing confusion + forcing fresh translation without historical ones * refactor: rename to currentLocation similar, make it more clear the value applies to currently displayed directory * docs: add preloadNote * docs: clarify size value sources
1 parent 40c512b commit 49019d4

File tree

3 files changed

+12
-5
lines changed

3 files changed

+12
-5
lines changed

public/locales/en/files.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@
5454
"addByPathModal": {
5555
"title": "Import from IPFS",
5656
"description": "Insert an IPFS path (CID) to import.",
57+
"preloadNote": "NOTE: Imported path is lazy-loaded by default, and will be retrieved on-demand as you browse it. To proactively prefetch imported path to the local Datastore, choose ”Download” from the context menu.",
5758
"importPathPlaceholder": "Path or CID (required)",
5859
"namePlaceholder": "Name (optional)",
5960
"examples": "Examples:"
@@ -114,9 +115,11 @@
114115
"clickToDismiss": "Click to dismiss",
115116
"clickToCancel": "Click to cancel",
116117
"blocks": "Blocks",
117-
"allBlocks": "All blocks",
118-
"allBlocksDescription": "Total size of blocks on your entire IPFS node; this includes everything in Files, plus all locally pinned items and any temporary cached data",
119-
"filesDescription": "Total size of data in the current directory (if a subdirectory, the size of all data in Files is also displayed)",
118+
"localDatastore": "Local Datastore",
119+
"localDatastoreDescription": "Total size of all blocks currently stored in the Datastore of your IPFS node (“RepoSize” from “ipfs repo stat”). This includes everything in the Files view (MFS), low-level pins, and any recently removed or temporary cached blocks that were not garbage-collected yet.",
120+
"currentLocationRoot": "My Files",
121+
"currentLocation": "Current Location",
122+
"currentLocationDescription": "Total size of the DAG behind the current directory (“CumulativeSize” from “ipfs files stat”). This value includes both local and remote blocks, and could be bigger than the size of your local datastore.",
120123
"pinningQueue": "Pinning queue",
121124
"more": "More",
122125
"files": "Files",

src/files/header/Header.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ class Header extends React.Component {
7272
className='fill-teal PendingAnimation' />
7373
</a> }
7474

75-
<BarOption title={t('filesDescription')} text={t('app:terms:files')}>
75+
<BarOption title={t('currentLocationDescription')} text={hasUpperDirectory ? t('currentLocation') : t('currentLocationRoot')}>
7676
{ hasUpperDirectory
7777
? (
7878
<span>
@@ -82,7 +82,7 @@ class Header extends React.Component {
8282
: size(filesSize) }
8383
</BarOption>
8484

85-
<BarOption title={t('allBlocksDescription')} text={t('allBlocks')}>
85+
<BarOption title={t('localDatastoreDescription')} text={t('localDatastore')}>
8686
{ size(repoSize) }
8787
</BarOption>
8888

src/files/modals/add-by-path-modal/AddByPathModal.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,10 @@ class AddByPathModal extends React.Component {
106106
name='name'
107107
className='input-reset charcoal ba b--black-20 br1 pa2 mb2 db w-90 center focus-outline'
108108
type='text' />
109+
110+
<div className='mt3 mb3 flex flex-column items-center'>
111+
<p className='mt0 charcoal tl w-90'>{t('addByPathModal.preloadNote')}</p>
112+
</div>
109113
</ModalBody>
110114

111115
<ModalActions>

0 commit comments

Comments
 (0)