b2d526f09a
Fixes #1463 ### Changes - Explains execution time - Adds style guide section about adding a badge for paid features - Updates config for mkdocs-material 9.5, materialx emoji support is being removed. - Adds better tooltips, a cool feature that also got released with mkdocs-material 9.5 - Adds search suggestions ### Caveats - [mkdocs 1.5 has improved the way they handle link validation](https://www.mkdocs.org/about/release-notes/#expanded-validation-of-links). Looks like way I've gone about linking things could be improved, and it will give a bunch of warnings as a result. The site still builds fine, but I'm going to fix this in a different PR so this one doesn't take as much effort to review :) EDIT: Here's that PR https://github.com/webrecorder/browsertrix-cloud/pull/1476 ### Testing - Make sure you are up to date with `pip install --upgrade mkdocs-material` ### Screenshot **Badge!** <img width="884" alt="Screenshot 2024-01-17 at 11 59 00 PM" src="https://github.com/webrecorder/browsertrix-cloud/assets/5672810/62a51cf6-24bd-49f1-a6d0-d335f730bfbe"> ### Future - Should mkdocs-material be versioned in our deployment script? We risk things breaking if I don't get to them fast enough! 🙃 --------- Co-authored-by: Tessa Walsh <tessa@bitarchivist.net>
29 lines
1.8 KiB
Markdown
29 lines
1.8 KiB
Markdown
# Org Overview
|
||
|
||
The overview page delivers key statistics about the organization's resource usage. It also lets users create crawl workflows, uploaded archived items, collections, and browser profiles through the _Create New ..._ button.
|
||
|
||
## Storage
|
||
|
||
For organizations with a set storage quota, the storage panel displays a visual breakdown of how much space the organization has left and how much has been taken up by all types of archived items and browser profiles. To view additional information about each item, hover over its section in the graph.
|
||
|
||
For organizations with no storage limits the storage panel displays the total size and count of all types of archived items and browser profiles.
|
||
|
||
For all organizations the storage panel displays the total number of archived items.
|
||
|
||
## Crawling
|
||
|
||
The crawling panel lists the number of currently running and waiting crawls, as well as the total number of pages captured.
|
||
|
||
### Execution Time
|
||
|
||
`Paid Feature`{.badge-green}
|
||
|
||
For organizations with a set execution minute limit, the crawling panel displays a graph of how much execution time has been used and how much is currently remaining. Monthly execution time limits reset on the first of each month at 12:00 AM GMT.
|
||
|
||
??? Question "How is execution time calculated?"
|
||
Execution time is the total runtime of all [_Crawler Instances_](../workflow-setup/#crawler-instances) during a crawl. For instance, if _Crawler Instances_ scale is set to 2× and each crawler instance uses 2 minutes of active crawling time, execution time for the crawl will be 4 minutes. Like elapsed time, this is tracked as the crawl runs so changing the _Crawler Instances_ scale while a crawl is running may change the amount of execution time used in a given time period.
|
||
|
||
## Collections
|
||
|
||
The collections panel displays the number of total collections and collections marked as sharable.
|