From 0aa09be8c3d7da8a20331ac27df3f77b82e2aebc Mon Sep 17 00:00:00 2001 From: Ilya Kreymer Date: Tue, 6 Dec 2022 12:27:27 -0800 Subject: [PATCH] README + CHANGES + doc tweaks for 1.1.0 release (#402) - update README + docs with deprecation of non-k8s deployment - add CHANGES.md - bump version to 1.1.0 --- CHANGES.md | 19 +++++++++++++++++++ README.md | 35 ++++++++++++++++++++--------------- backend/btrixcloud/version.py | 2 +- docs/deploy/index.md | 9 ++++++++- frontend/package.json | 2 +- version.txt | 2 +- 6 files changed, 50 insertions(+), 19 deletions(-) create mode 100644 CHANGES.md diff --git a/CHANGES.md b/CHANGES.md new file mode 100644 index 00000000..79c17543 --- /dev/null +++ b/CHANGES.md @@ -0,0 +1,19 @@ +### v1.1.0 + +New Features: +- Viewing crawl queue and dynamically adding exclusions to crawl queue while crawl is running. +- Adding exclusions to crawl config screen. +- Setting initial browser language on crawl config. + +Mkdocs based documentation added + +Docker swarm / compose / podman-based deployments not deprecated in favor of Kubernetes + +Various UI improvements and tweaks + + +### v1.0.0 + +Initial release + + diff --git a/README.md b/README.md index cd4d64dc..fd64f988 100644 --- a/README.md +++ b/README.md @@ -10,28 +10,33 @@ and managing all aspects of crawling process. This system provides the orchestra while the actual crawling is performed using [Browsertrix Crawler](https://github.com/webrecorder/browsertrix-crawler) containers, which are launched for each crawl. -The system is designed to run in both Kubernetes and Docker Swarm, as well as locally under Podman. - See [Features](https://browsertrix.cloud/features) for a high-level list of planned features. - -## Development Status - -Browsertrix Cloud is currently in an early beta stage and not fully ready for production. This is an ambitious project and there's a lot to be done! - -If you would like to help in a particular way, please open an issue or reach out to us in other ways. - ## Documentation -Docs are available at: [https://docs.browsertrix.cloud/](https://docs.browsertrix.cloud/) created from the markdown in the [./docs](./docs) on the main branch. +The full docs for using, deplyoing and developing Browsertrix Cloud are available at: [https://docs.browsertrix.cloud](https://docs.browsertrix.cloud) -To build the documentation locally, install Material for MkDocs with pip: +## Deployment -```shell -pip install mkdocs-material -``` +The latest deployment documentation is available at: [https://docs.browsertrix.cloud/deploy](https://docs.browsertrix.cloud/deploy) + +The docs cover deploying Browsertrix Cloud in different environments using Kubernetes, from a single-node setup to scalable clusters in the cloud. + +Previously, Browsertrix Cloud 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. + +Making deployment of Browsertrix Cloud as easy as possible remains a key goal, and we welcome suggestions for how we can further improve our Kubernetes deployment options. + +If you are looking to just try running a single crawl, you may want to try [Browsertrix Crawler](https://github.com/webrecorder/browsertrix-crawler) first to test out the crawling capabilities. + +## Development Status + +Browsertrix Cloud is currently in a beta, though the system and backend API is fairly stable, we are working on many additional features. + +Additional developer documentation is available at [https://docs.browsertrix.cloud/dev](https://docs.browsertrix.cloud/dev) + +Please see the GitHub issues and [this GitHub Project](https://github.com/orgs/webrecorder/projects/9) for our current project plan and tasks. -In the project root directory run `mkdocs serve` to run a local version of the documentation site. ## License diff --git a/backend/btrixcloud/version.py b/backend/btrixcloud/version.py index 29bc776c..48d81547 100644 --- a/backend/btrixcloud/version.py +++ b/backend/btrixcloud/version.py @@ -1,2 +1,2 @@ """ current version """ -__version__ = "1.1.0-beta.3" +__version__ = "1.1.0" diff --git a/docs/deploy/index.md b/docs/deploy/index.md index 2d860155..ea41370d 100644 --- a/docs/deploy/index.md +++ b/docs/deploy/index.md @@ -7,8 +7,15 @@ However, despite the name, it is perfectly reasonable (and easy!) to deploy Brow The main requirements for Browsertrix Cloud are: - A Kubernetes Cluster -- Helm (package manager for Kubernetes) +- Helm 3 (package manager for Kubernetes) We have prepared a [Local Deployment](./local) and [Production (Self-Hosted and Cloud) Deployment](./production) guides to help with setting up Browsertrix Cloud for different scenarios. +### Non Kubernetes Deployments + +Previously, Browsertrix Cloud 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. + +Making deployment of Browsertrix Cloud as easy as possible remains a key goal, and we welcome suggestions for how we can further improve our Kubernetes deployment options. + diff --git a/frontend/package.json b/frontend/package.json index bca04576..e27018f8 100644 --- a/frontend/package.json +++ b/frontend/package.json @@ -1,6 +1,6 @@ { "name": "browsertrix-frontend", - "version": "1.1.0-beta.3", + "version": "1.1.0", "main": "index.ts", "license": "AGPL-3.0-or-later", "dependencies": { diff --git a/version.txt b/version.txt index a7ad9b52..9084fa2f 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -1.1.0-beta.3 +1.1.0