README + CHANGES + doc tweaks for 1.1.0 release (webrecorder#402)

- update README + docs with deprecation of non-k8s deployment - add CHANGES.md - bump version to 1.1.0
urbanlab · Dec 6, 2022 · 0aa09be · 0aa09be
1 parent ba3e7d0
commit 0aa09be
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 16 deletions.
diff --git a/CHANGES.md 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
@@ -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.
 
+## Documentation
 
-## Development Status
+The full docs for using, deplyoing and developing Browsertrix Cloud are available at: [https://docs.browsertrix.cloud](https://docs.browsertrix.cloud)
 
-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!
+## Deployment 
 
-If you would like to help in a particular way, please open an issue or reach out to us in other ways.
+The latest deployment documentation is available at: [https://docs.browsertrix.cloud/deploy](https://docs.browsertrix.cloud/deploy)
 
-## Documentation
+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
 
-Docs are available at: [https://docs.browsertrix.cloud/](https://docs.browsertrix.cloud/) created from the markdown in the [./docs](./docs) on the main branch.
+Browsertrix Cloud is currently in a beta, though the system and backend API is fairly stable, we are working on many additional features.
 
-To build the documentation locally, install Material for MkDocs with pip:
+Additional developer documentation is available at [https://docs.browsertrix.cloud/dev](https://docs.browsertrix.cloud/dev)
 
-```shell
-pip install mkdocs-material
-```
+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
@@ -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
@@ -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
@@ -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
@@ -1 +1 @@
-1.1.0-beta.3
+1.1.0