05c5e09d25
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>
30 lines
1.9 KiB
Markdown
30 lines
1.9 KiB
Markdown
# 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](signup).
|
|
2. After being redirected to the organization's [overview page](overview), click the _Create New_ button in the top right and select _[Crawl Workflow](crawl-workflows)_ 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:
|
|
|
|
- A detailed list of [crawl workflow setup](workflow-setup) options.
|
|
- Adding [exclusions](workflow-setup/#exclusions) to limit your crawl's scope and evading crawler traps by [editing exclusion rules while crawling](crawl-workflows/#live-exclusion-editing).
|
|
- Best practices for crawling with [browser profiles](browser-profiles) to capture content only available when logged in to a website.
|
|
- Managing archived items, including [uploading previously archived content](archived-items/#uploading-web-archives).
|
|
- Organizing and combining archived items with [collections](collections) for sharing and export.
|
|
- If you're an admin: [Inviting collaborators to your org](org-settings/#members).
|
|
|
|
|
|
### 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](mailto:docs-feedback@webrecorder.net)!
|