Henry Wilkinson 05c5e09d25

Adds status information to user documentation (#1459 )

Closes #1434 

### Changes
#### Developer
- Adds the K3S playbook guide to the navigation
- Adds note about restarting MKDocs when adding new icons
- Adds note about concise language to the styleguide ([see previous
discussion](https://github.com/webrecorder/browsertrix-cloud/pull/1394#discussion_r1402666872))
- Adds a note about noun usage to the styleguide
#### User guide
- Adds tables for archived item and workflow statuses
- Adds custom styles for displaying statuses with their icons like we do
in the app
- Fixes capitalization issues
---------

Co-authored-by: Tessa Walsh <tessa@bitarchivist.net>
Co-authored-by: sua yoo <sua@webrecorder.org>

2024-01-14 16:44:51 -08:00

3.0 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 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.

Status

The status of an archived item depends on its type. Uploads will always have the status :bootstrap-upload: Uploaded, crawls have four possible states:

Status	Description
:bootstrap-check-circle: Complete	The crawl completed according to the workflow's settings. Workflows with limits set may stop running before they capture every queued page, but the resulting archived item will still be marked as "Complete".
:bootstrap-dash-circle: Stopped	The crawl workflow was stopped gracefully by a user and data is saved.
:bootstrap-x-octagon: Canceled	The crawl workflow was canceled by a user, no data is saved.
:bootstrap-exclamation-triangle: Failed	A serious error occurred while crawling, no data is saved.

Because :bootstrap-x-octagon: Canceled and :bootstrap-exclamation-triangle: Failed crawls do not contain data, they are omitted from the archived items list page and cannot be added to a collection.

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.

3.0 KiB Raw Blame History