Henry Wilkinson ae8804d87f

Improves user documentation intro (#1376 )

Closes #1369 

### Changes
- Adds improved getting started steps and intro contact information to
the User Guide homepage
- Adds a small section about the execution minutes graph for orgs with a
quota set
- Moves existing signup content to a dedicated signup page
- Changes admonitions from using em dashes to using colons.
- Em dashes are great and I love em.... But sometimes I love them a
little _too_ much and they were a bad fit here.
- Fixes user guide homepage link
- Fixes `ReplayWeb.page` and `ArchiveWeb.page` names
- Fixes broken links (would be good to have a CI system for this I
think)

---------
Co-authored-by: Emma Segal-Grossman <hi@emma.cafe>
Co-authored-by: Tessa Walsh <tessa@bitarchivist.net>
Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>

2023-11-15 17:55:47 -08:00

1.7 KiB

Raw Blame History

Archived Items

Archived Items consist of one or more WACZ files created by a Crawl Workflow, or uploaded to Browsertrix. They can be individually replayed, or combined with other Archived Items in a a Collection. The Archived Items page lists all items in the organization.

Uploading Web Archives

WACZ files can be given metadata and uploaded to Browsertrix by pressing the Upload WACZ button on the Archived Items list page. Only one WACZ file can be uploaded at a time.

Archived Item Details

The Archived Item details page is composed of five sections, though the Crawl Settings tab is only available for Crawls and not Uploads.

Overview

The Overview tab displays the item's metadata and statistics associated with its creation process.

Metadata can be edited by pressing the pencil icon at the top right of the metadata section to edit the item's description, tags, and collections it is associated with.

Replay

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.

Files

The Files tab lists the individually downloadable WACZ files that make up the Archived Item as well as their file sizes.

Error Logs

The Error Logs tab displays a list of errors encountered during crawling. Clicking an errors in the list will reveal additional information.

All log entries with that were recorded in the creation of the Archived Item can be downloaded in JSONL format by pressing the Download Logs button.

Crawl Settings

The Crawl Settings tab displays the Crawl Workflow configuration options that were used to generate the resulting Archived Item.

1.7 KiB Raw Blame History