browsertrix/docs/user-guide/index.md
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.9 KiB

Browsertrix User Guide

Welcome to the Browsertrix User Guide. This page covers the basics of using Browsertrix, Webrecorder's high-fidelity web archiving system.

Getting Started

To get started crawling with Browsertrix:

  1. Create an account and join an Organization as described here.
  2. After being redirected to the organization's Overview page, click the Create New button in the top right and select Crawl Workflow to begin configuring your first crawl!
  3. For a simple crawl, choose the Seeded Crawl option, and enter a page url in the Crawl Start URL field. By default, the crawler will archive all pages under the starting path.
  4. Next, click Review & Save, and ensure the Run on Save option is selected. Then click Save Workflow.
  5. Wait a moment for the crawler to start and watch as it archives the website!

After running your first crawl, check out the following to learn more about Browsertrix's features:

Have more questions?

While our aim is to create intuitive interfaces, sometimes the complexities of web archiving require a little more explanation. If there's something that you found especially confusing or frustrating please get in touch!