diff --git a/frontend/docs/docs/overrides/.icons/bootstrap/three-dots-vertical.svg b/frontend/docs/docs/overrides/.icons/bootstrap/three-dots-vertical.svg new file mode 100644 index 0000000000..f5ef7d4754 --- /dev/null +++ b/frontend/docs/docs/overrides/.icons/bootstrap/three-dots-vertical.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/frontend/docs/docs/user-guide/collection.md b/frontend/docs/docs/user-guide/collection.md index 84fe400ea2..75f0f9bea1 100644 --- a/frontend/docs/docs/user-guide/collection.md +++ b/frontend/docs/docs/user-guide/collection.md @@ -1,10 +1,12 @@ # Intro to Collections +A collection is a specific, user-directed grouping of archived items from either crawls or WACZ files. You can create a collection, add content to your collection, include a description to your collection, download your collection, and share your collection whichever way you need to others in your community. + ## Create a Collection -You can create a collection from the Collections page, or the _Create New ..._ shortcut from the org overview. +You can create a collection from the Collections page directly, or the _Create New..._ shortcut from the org dashboard. -### Adding Collection Content +### Add Collection Content 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. @@ -17,7 +19,17 @@ Crawls and uploads can be added to a collection after creation by selecting _Sel 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 +### Customize a Collection + +The [Presentation and Sharing](../presentation-sharing) page provides further details for options on how to present and share Collections. You can customize how your Collection appears to the public by clicking the edit button :bootstrap-pencil: in each collection to: + +- **Name** it and add a **description** β€” include emojis if that’s your style πŸ˜‰ + +- Select a **thumbnail** to represent it: Choose between a page screenshot and a placeholder + +- Choose the **initial view** for your Collection + +## Download a Collection 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. @@ -27,8 +39,7 @@ Collections can be set to one of the one following access modes. - Private β€” Collections only accessible to logged in users - Unlisted β€” Collections can be shared with others, given the link to the collection. -- Public β€” Collections can be shared with others, and also listed in the [public collections gallery](org-settings.md#public-collections-gallery), if enabled. - -If the public collections gallery page is not enabled, any existing public collections are treated the same as unlisted collections. +- Public β€” Collections can be shared with others, and when enabled, collections can also be listed in the [public collections gallery](org-settings.md#public-collections-gallery). -Check out [enabling public collection gallery](../public-collections-gallery) for a guide on how to enable this page. +!!! tip "Note: About Public Collections Gallery" + If the public collections gallery page is not enabled, any existing public collections are treated the same as unlisted collections. Check out [enabling public collection gallery](../public-collections-gallery) for a guide on how to enable this page. \ No newline at end of file diff --git a/frontend/docs/docs/user-guide/presentation-sharing.md b/frontend/docs/docs/user-guide/presentation-sharing.md index a527a180c6..6cd6b108f9 100644 --- a/frontend/docs/docs/user-guide/presentation-sharing.md +++ b/frontend/docs/docs/user-guide/presentation-sharing.md @@ -1,26 +1,71 @@ -# Collection Presentation & Sharing +# 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). +## Share a Collection -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. +A Collection is 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. -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). +1. Click the edit button :bootstrap-pencil: on the specific Collection you want to share -## Initial View +2. In that Collection's **Sharing** tab, change its visibility from the default **Private** to **Public** and save -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. +3. Click on the edit button :bootstrap-pencil: again, and now in the Collection's **Sharing** tab, there will be a new section, **Link to Share**, with a URL for this specific Collection that you can share and circulate to your community -## Thumbnails +4. Optional: If you want to allow other viewers to download the Collection, confirm that the **Show download button** is enabled. If not, toggle it so that others would not be able to download it and only view. -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. +## Customize a Collection + +You can customize how your Collection appears to the public by making edits within the **Presentation** tab of Collection. + +You can access this tab via the edit button :bootstrap-pencil: of a Collection from the Public Collection Gallery or via the kebab icon of a Collection from your account's Collections tab. + +From the Collections tab: + +1. Click the Collections tab from your account + +2. Click the kebab icon :bootstrap-three-dots-vertical: for options + +3. Click Edit Collection Settings + +4. Edit any of the following information from the **Presentation** tab: Name, Summary, Thumbnail, and set Initial View + +From the Public Collection Gallery. When Public Collection Gallery is enabled, you can view Collections from your dashboard. To customize the Collection: + +1. Click on the edit button :bootstrap-pencil: of the Collection you want to edit + +2. Edit any of the following information from the **Presentation** tab: Name, Summary, Thumbnail, and set Initial View + +### Name + +A **Name** is always required, so by default, your Collection's name is determined by the Metadata section from your crawl workflow β€” either a custom name you had set or the first Crawl URL from your workflow. + +You can edit the **Name** as long as its within 50 characters, which is roughly between 7 words and 13 words with spaces included in the character count. + +### Summary + +A **Summary** describing your Collection is not required, but it is useful information to others to summarize the Collection and caption collection thumbnails. + +You can edit the **Summary** as long as its within 150 characters, which is roughly between 90 words and 150 words with spaces included in the character count. + +### Thumbnail + +Choose a thumbnail image to represent this collection in your org's dashboard and public collections gallery page. Thumbnails can either be a placeholder image designed by Webrecorder, or a screenshot of a page from the collection. + +To choose a screenshot: + +1. Click the _Enter a Page URL to preview it_ for a Page URL dropdown to appear + +2. Select one of the URLs or search for a specific URL from the Collection + +3. Optional: You can choose a specific captured URL based on its Page Timestamp. ??? 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. +### Initial View -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. +The **Initial View** is the first view visitors see first when viewing a Collection. The initial view can either be a list of pages, which is the default when replaying using ReplayWeb.page, or a single page from your collection such as a crawl start URL or index page. diff --git a/frontend/docs/docs/user-guide/public-collections-gallery.md b/frontend/docs/docs/user-guide/public-collections-gallery.md index 4d53a66b48..c1e9ffc0a1 100644 --- a/frontend/docs/docs/user-guide/public-collections-gallery.md +++ b/frontend/docs/docs/user-guide/public-collections-gallery.md @@ -1,45 +1,77 @@ -# Enabling Public Collections Gallery +# Public Collections Gallery -The public collections gallery provides a page that lists all public collections in one place. +Collections provide a way to dynamically combine and group multiple individual crawls and uploads into a contextual, unified archive replay experience. -You can take the following steps to enable the Public Collections Gallery for your organization. (This feature is available in Browsertrix 1.14 and later). - -1. Log in to your Browsertrix account - -2. In your **org settings**, enable **public collections gallery** and save - -3. Back on your **dashboard**, scroll down to find the **Public Collections** section - - If you don’t have any public collections yet, click the asterisk icon :bootstrap-asterisk: on the right side to see all your collections - - 1. Click the edit button :bootstrap-pencil: on a collection, then in the **Sharing** tab change its visibility to **Public** and save - - 2. Repeat as needed - - 3. Press the globe icon :bootstrap-globe2: on the right side to see all your public collections - -4. Click on β€œ**Visit Public Collections Gallery**”, and now you can share your gallery with the world! +With Public Collections Gallery, you can create a dedicated page that showcases all public Collections in one place, allowing you to personalize, curate, and share your web archives with the world! -## Make It Your Own +## Enable Public Collections Gallery -You can customize and curate how your public collections appear directly in your dashboard, and personalize your Public Collections Gallery URL in org settings. Click the edit button in each collection to: +The _enable public collections gallery_ toggle is located in the org's **Settings** tab within your account. Follow these steps to activate the Public Collections Gallery. -- **Name** it and add a **description** β€” include emojis if that’s your style πŸ˜‰ +1. Log in to your Browsertrix account -- Select a **thumbnail** to represent it: either a page screenshot or a placeholder +2. In your org's **settings**, click **enable public collections gallery** and save -- Choose the **initial view** for your collection +3. You can share the link to your Public Collections Page from either copying from the org's **settings**, or by clicking on the copy button next to "**Visit public collections gallery**" from your dashboard. - +Note: If you choose to hide the gallery later, you can go back to the setting and set the toggle to off at any time. +The gallery will still be available for logged in users to preview, but the public page will be hidden. +Public Collections will be treated the same as *Unlisted* when the public gallery is turned off. + +### Customizing the Gallery + +The Public Collection Gallery page will automatically have the title of your Org. You can customize this page by including a **Description** and your org's **Website** by adding them from your org's **Settings** of your account. The Gallery URL is always based on the Org URL, if you change one, the other changes as well. + +For example, if your org URL ends with `/my-org`, than the Public Collections Gallery will be made available at `/explore/my-org`. + +### Add Collections + +If you don’t have any public Collections yet, on the right side of the section you'll see three different icons. + +1. Click the asterisk icon :bootstrap-asterisk: in order to see all your Collections. + +2. Click the edit button :bootstrap-pencil: on the specific Collection you want to share + +3. In that Collection's **Sharing** tab, change its visibility from the default **Private** to **Public** and save + +4. Repeat Steps 2 and 3 as needed to share all the Collections you want + +5. When you're done, click the globe icon :bootstrap-globe2: in order to see all your public Collections + +6. Click on β€œ**Visit Public Collections Gallery**”, and now you can share your gallery with the world! + +### Remove Collections + +You'll take similar steps from [Add Collections](../public-collections-gallery/#add-collections) to also remove Collections from the Public Collections Gallery + +1. Within the Public Collections Gallery, click the edit button :bootstrap-pencil: on the specific Collection you want to remove + +2. In that Collection's **Sharing** tab, change its visibility from the default **Public** to **Private**, save, and that Collection should be removed from the Public Collections Gallery! + + +### Customize Collections + +The [Presentation and Sharing](../presentation-sharing) page provides further details for options on how to present and share Collections in your Public Collections Gallery. Your Public Collection Gallery page will automatically have the title of your org. You can customize this page by including a **Description** and your org's **Website** by adding them from your org's **Settings** of your account. + +### Description + +A **Description** about your Collection is not required, but it is useful information to share additional context and details of your collection with your org team members or the public by writing a description. + +You can edit the **Description** as long as its within 150 characters, which is roughly between 90 words and 150 words with spaces included in the character count. The **Description** supports basic text formatting like headings, bold and italicized text, lists, and links. + +### Website + +Link to your org's (or your personal) website so viewers can visit from your Public Collections Gallery page. + +how your Collection appears to the public by clicking the edit button :bootstrap-pencil: in each collection to: + +- **Name** it and add a **description** β€” include emojis if that’s your style πŸ˜‰ -Public Collections are live and ready for you to explore on Browsertrix now β€” dive in and create your own gallery! +- Select a **thumbnail** to represent it: Choose between a page screenshot and a placeholder -The [Presentation and Sharing](../presentation-sharing) page provides further details for options on sharing collections. +- Choose the **initial view** for your collection. diff --git a/yarn.lock b/yarn.lock new file mode 100644 index 0000000000..fb57ccd13a --- /dev/null +++ b/yarn.lock @@ -0,0 +1,4 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + +