diff --git a/README.md b/README.md index 4bdc19f2..4debb745 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,27 @@ -# Browsertrix +
+ Browsertrix Logo +
-

+  Browsertrix is an open-source cloud-native high-fidelity browser-based crawling service designed to make web archiving easier and more accessible for everyone. -The service provides an API and UI for scheduling crawls and viewing results, -and managing all aspects of crawling process. This system provides the orchestration and management around crawling, -while the actual crawling is performed using -[Browsertrix Crawler](https://github.com/webrecorder/browsertrix-crawler) containers, which are launched for each crawl. +The service provides an API and UI for scheduling crawls and viewing results, and managing all aspects of crawling process. This system provides the orchestration and management around crawling, while the actual crawling is performed using [Browsertrix Crawler](https://github.com/webrecorder/browsertrix-crawler) containers, which are launched for each crawl. -See [browsertrix.com](https://browsertrix.com) for a feature overview and information about Browsertrix Hosting. +See [browsertrix.com](https://browsertrix.com) for a feature overview and information about Browsertrix hosting. ## Documentation -The full docs for using, deploying and developing Browsertrix are available at: [https://docs.browsertrix.cloud](https://docs.browsertrix.cloud) +The full docs for using, deploying, and developing Browsertrix are available at: [https://docs.browsertrix.cloud](https://docs.browsertrix.cloud) -## Deployment +## Deployment The latest deployment documentation is available at: [https://docs.browsertrix.cloud/deploy](https://docs.browsertrix.cloud/deploy) The docs cover deploying Browsertrix in different environments using Kubernetes, from a single-node setup to scalable clusters in the cloud. -Previously, Browsertrix also supported Docker Compose and podman-based deployment. This is now deprecated due to the complexity -of maintaining feature parity across different setups, and with various Kubernetes deployment options being available and easy to deploy, even on a single machine. +Previously, Browsertrix also supported Docker Compose and podman-based deployment. This has been deprecated due to the complexity of maintaining feature parity across different setups, and with various Kubernetes deployment options being available and easy to deploy, even on a single machine. Making deployment of Browsertrix as easy as possible remains a key goal, and we welcome suggestions for how we can further improve our Kubernetes deployment options. @@ -37,7 +35,6 @@ Additional developer documentation is available at [https://docs.browsertrix.clo Please see the GitHub issues and [this GitHub Project](https://github.com/orgs/webrecorder/projects/9) for our current project plan and tasks. - ## License Browsertrix is made available under the AGPLv3 License. diff --git a/assets/browsertrix-lockup-color-dynamic.svg b/assets/browsertrix-lockup-color-dynamic.svg new file mode 100644 index 00000000..81b7e904 --- /dev/null +++ b/assets/browsertrix-lockup-color-dynamic.svg @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + diff --git a/docs/assets/brand/browsertrix-icon-white.svg b/docs/assets/brand/browsertrix-icon-white.svg new file mode 100644 index 00000000..f393ca21 --- /dev/null +++ b/docs/assets/brand/browsertrix-icon-white.svg @@ -0,0 +1,10 @@ + + + + + + + + + diff --git a/docs/assets/brand/btrix-logo.svg b/docs/assets/brand/btrix-logo.svg deleted file mode 100644 index 3e6d39e8..00000000 --- a/docs/assets/brand/btrix-logo.svg +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/assets/brand/favicon.svg b/docs/assets/brand/favicon.svg new file mode 100644 index 00000000..ddcbae18 --- /dev/null +++ b/docs/assets/brand/favicon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 900cfc5b..0341533d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,4 +14,4 @@ Welcome to the Browsertrix official user guide and developer docs. These docs wi If you are unfamiliar with Browsertrix, please check out [our website](https://browsertrix.cloud), or the main repository at [https://github.com/webrecorder/browsertrix-cloud](https://github.com/webrecorder/browsertrix-cloud) -Our docs are still under construction. If you find something missing, chances are we haven't gotten around to writing that part yet. If you find typos or something isn't clear or seems incorrect, please open an [issue](https://github.com/webrecorder/browsertrix-cloud/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) and we'll try to make sure that your questions get answered here in the future! +If something is missing, unclear, or seems incorrect, please open an [issue](https://github.com/webrecorder/browsertrix-cloud/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) and we'll try to make sure that your questions get answered here in the future! diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 28ac5efb..35a5a51a 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -29,17 +29,17 @@ :root { --md-code-font: "Recursive", monospace; --md-text-font: "Inter", "Helvetica", "Arial", sans-serif; - --wr-blue-primary: #2E7CAB; - --wr-orange-primary: #B85D20; + --wr-blue-primary: #0891B2; + --wr-orange-primary: #C96509; } [data-md-color-scheme="webrecorder"] { - --md-primary-fg-color: #008873; - --md-primary-fg-color--light: #008873; - --md-primary-fg-color--dark: #003c32; + --md-primary-fg-color: #4D7C0F; + --md-primary-fg-color--light: #0782A1; + --md-primary-fg-color--dark: #066B84; --md-typeset-color: black; - --md-accent-fg-color: #01b297; - --md-typeset-a-color: #005447; + --md-accent-fg-color: #0782A1; + --md-typeset-a-color: #066B84; --md-code-bg-color: #F9FAFB; } diff --git a/mkdocs.yml b/mkdocs.yml index 3e780c77..f1605917 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ -site_name: Browsertrix Cloud Docs +site_name: Browsertrix Docs repo_url: https://github.com/webrecorder/browsertrix-cloud/ -repo_name: Browsertrix Cloud +repo_name: Browsertrix edit_uri: edit/main/docs/ extra_css: - stylesheets/extra.css @@ -23,7 +23,8 @@ theme: - search.suggest palette: scheme: webrecorder - logo: assets/brand/btrix-logo.svg + logo: assets/brand/browsertrix-icon-white.svg + favicon: assets/brand/favicon.svg icon: admonition: