docs: Add Documentation for Sharing Collections (#2368)

- Merges existing collection content into one page
- Updates ArchiveWeb.page link
- Adds redirect from /collections → /collection
- Moves content relevant to presentation & sharing out of the intro
- Adds new content about sharing collections!

---------

Co-authored-by: Emma Segal-Grossman <hi@emma.cafe>
Co-authored-by: sua yoo <sua@webrecorder.org>
This commit is contained in:
Henry Wilkinson 2025-02-12 14:05:52 -05:00 committed by GitHub
parent f7b9b73a68
commit edf1edbbd1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 44 additions and 30 deletions

View File

@ -1,6 +1,6 @@
# Intro to 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](collections.md). The **Archived Items** page lists all items in the organization.
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](collection.md). The **Archived Items** page lists all items in the organization.
## Uploading Web Archives
@ -62,7 +62,7 @@ The **WACZ Files** tab lists the individually downloadable WACZ files that make
To download an entire archived item as a single WACZ file, click the _Download Item_ button at the top of the **WACZ Files** tab or the _Download Item_ entry in the crawl's _Actions_ menu.
To combine multiple archived items and download them all as a single WACZ file, add them to a collection and [download the collection](collections.md#downloading-collections).
To combine multiple archived items and download them all as a single WACZ file, add them to a collection and [download the collection](collection.md#downloading-collections).
### Error Logs

View File

@ -4,15 +4,19 @@
You can create a collection from the Collections page, or the _Create New ..._ shortcut from the org overview.
## Collection Description
### Adding Collection Content
The description can be formatted with basic [Markdown](https://github.github.com/gfm/#what-is-markdown-) syntax to include headings, bolded and italicized text, lists, and links. The editor is powered by [ink-mde](https://github.com/davidmyersdev/ink-mde), an open source Markdown editor.
Collections are the primary way of organizing and combining archived items into groups for presentation. Collections also allow you to view a combined replay of any archived items they contain; if a link is present when viewing a collection but the actual page is missing, and another item with that captured page is added to the collection, the link will now work as expected.
## Sharing Collections
!!! tip "Tip: Patching a crawl with interactive archiving"
If the crawler has not captured every resource or interaction on a webpage, our [ArchiveWeb.page browser extension](https://webrecorder.net/archivewebpage) can be used to interactively capture missing content using your web browser and upload it directly to your org.
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 adding crawls and uploads to a collection, content from both will become available in the replay viewer.
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.
Crawls and uploads can be added to a collection after creation by selecting _Select Archived Items_ from the collection's actions menu.
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).
A crawl workflow can also be set to [automatically add any completed crawls to a collection](workflow-setup.md#collection-auto-add) in the workflow's settings.
## Downloading Collections
Downloading a collection will export every archived item in it as a single WACZ file. To download a collection, use the _Download Collection_ option under the collection's _Actions_ dropdown.

View File

@ -1,19 +0,0 @@
# Add to Collection
Collections are the primary way of organizing and combining archived items into groups for presentation.
!!! tip "Tip: Combining items from multiple sources"
If the crawler has not captured every resource or interaction on a webpage, the [ArchiveWeb.page browser extension](https://archiveweb.page/) can be used to manually capture missing content and upload it directly to your org.
After adding the crawl and the upload to a collection, the content from both will become available in the replay viewer.
## Adding Archived Items to Collections
Crawls and uploads can be added to a collection after creation by selecting _Select Archived Items_ from the collection's actions menu.
A crawl workflow can also be set to [automatically add any completed archived items to a collection](workflow-setup.md#collection-auto-add) in the workflow's settings.
## 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.

View File

@ -31,5 +31,5 @@ After running your first crawl, check out the following to learn more about Brow
- Adding [exclusions](workflow-setup.md#exclude-pages) to limit your crawl's scope and evading crawler traps by [editing exclusion rules while crawling](running-crawl.md#live-exclusion-editing).
- Best practices for crawling with [browser profiles](browser-profiles.md) to capture content only available when logged in to a website.
- Managing archived items, including [uploading previously archived content](archived-items.md#uploading-web-archives).
- Organizing and combining archived items with [collections](collections.md) for sharing and export.
- Organizing and combining archived items with [collections](collection.md) for sharing and export.
- [Invite collaborators](org-members.md) to your org.

View File

@ -0,0 +1,26 @@
# Collection Presentation & Sharing
## Sharing Collections
Collections are private by default, but can be made sharable either with an unlisted link, or displayed in your org's public gallery for everyone to discover. Sharing settings can be found within the **Sharing** tab of the Collection Settings dialog. Public collections will not be visible unless your org has enabled its [public collections gallery](org-settings.md#public-collections-gallery).
Public collections can also be embedded into other websites using the provided embed code. Making a collection private after it is public or unlisted will break any previously shared links and remove it from your gallery.
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).
## Initial View
Set the **Initial View** to control what visitors see first when viewing a collection. The initial view can either be a list of pages (ReplayWeb.page's default), or a single page from your collection such as a crawl start URL or index page.
## Thumbnails
Choose a thumbnail image to represent the collection in your org's public collections gallery and org dashboard. This thumbnail can be edited from the **Presentation** tab of the Collection Settings dialog. Thumbnails can either be a screenshot of a page from the collection, or a placeholder image designed by Webrecorder.
??? question "Why isn't there a thumbnail preview for my page?"
If you have uploaded archived items captured with tools other than Browsertrix, some of the pages in your collection may not have screenshots available to use as thumbnails. To fix this, either re-crawl a page you wish to use as a thumbnail with Browsertrix and add it to the collection, or choose a placeholder thumbnail.
## Description
Share additional context and details of your collection with your org team members or the public by writing a description. Whereas **Summary** is used to summarize the collection and caption collection thumbnails, the **About** section offers a space to write out a longer, more detailed description of the collection. The description supports basic text formatting like headings, bold and italicized text, lists, and links.
The editor is powered by [ink-mde](https://github.com/davidmyersdev/ink-mde), an open source [Markdown](https://github.github.com/gfm/#what-is-markdown-) editor.

View File

@ -277,4 +277,4 @@ Apply tags to the workflow. Tags applied to the workflow will propagate to every
### Collection Auto-Add
Search for and specify [collections](collections.md) that this crawl workflow should automatically add archived items to as soon as crawling finishes. Canceled and Failed crawls will not be added to collections.
Search for and specify [collections](collection.md) that this crawl workflow should automatically add archived items to as soon as crawling finishes. Canceled and Failed crawls will not be added to collections.

View File

@ -61,9 +61,9 @@ nav:
- Archived Items:
- user-guide/archived-items.md
- user-guide/review.md
- user-guide/collections.md
- Collections:
- user-guide/collection.md
- user-guide/presentation-sharing.md
- Browser Profiles:
- user-guide/browser-profiles.md
- Org Settings:
@ -134,3 +134,6 @@ copyright: "Creative Commons Attribution 4.0 International (CC BY 4.0)"
plugins:
- search
- redirects:
redirect_maps:
"user-guide/collections.md": "user-guide/collection.md"