Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README + CHANGES + doc tweaks for 1.1.0 release #402

Merged
merged 7 commits into from
Dec 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -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


29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion backend/btrixcloud/version.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
""" current version """
__version__ = "1.1.0-beta.3"
__version__ = "1.1.0"
9 changes: 8 additions & 1 deletion docs/deploy/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

2 changes: 1 addition & 1 deletion frontend/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
2 changes: 1 addition & 1 deletion version.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.1.0-beta.3
1.1.0