Skip to content

Commit

Permalink
Adds documentation for exporting files (#1643)
Browse files Browse the repository at this point in the history
Closes #1642 

### Changes
- Adds section to the collections page on downloading collections
- Changes the Files section on the archived items page to be more
explicit about downloading files because that's the only action you can
do there!

---------

Co-authored-by: Tessa Walsh <tessa@bitarchivist.net>
  • Loading branch information
Shrinks99 and tw4l authored Apr 3, 2024
1 parent ffc4b5b commit 6e8867c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
6 changes: 4 additions & 2 deletions docs/user-guide/archived-items.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,11 @@ The Replay tab displays the web content contained within the archived item.

For more details on navigating web archives within ReplayWeb.page, see the [ReplayWeb.page user documentation.](https://replayweb.page/docs/exploring)

### Files
### Exporting Files

The Files tab lists the individually downloadable WACZ files that make up the archived item as well as their file sizes.
While crawling, Browsertrix will output one or more WACZ files — the crawler aims to output files in consistently sized chunks, and each [crawler instance](workflow-setup.md#crawler-instances) will output separate WACZ files.

The Files tab lists the individually downloadable WACZ files that make up the archived item as well as their file sizes and backup status. To combine one or more archived items and download them all as a single WACZ file, add them to a collection and [download the collection](collections.md#downloading-collections).

### Error Logs

Expand Down
6 changes: 5 additions & 1 deletion docs/user-guide/collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ A crawl workflow can also be set to [automatically add any completed archived it

Collections are private by default, but can be made public by marking them as sharable in the Metadata step of collection creation, or by toggling the _Collection is Shareable_ switch in the share collection dialogue.

After a collection has been made public, it can be shared with others using the public URL available in the share collection dialogue. The collection can also be embedded into other websites using the provided embed code. Unsharing the collection will break any previously shared links.
After a collection has been made public, it can be shared with others using the public URL available in the share collection dialogue. The collection can also be embedded into other websites using the provided embed code. Un-sharing the collection will break any previously shared links.

For further resources on embedding archived web content into your own website, see the [ReplayWeb.page docs page on embedding](https://replayweb.page/docs/embedding).

## Downloading Collections

Downloading a collection will export every archived item within it as a single WACZ file. To download a collection, use the _Download Collection_ option under the collection's _Actions_ dropdown.

0 comments on commit 6e8867c

Please sign in to comment.