Skip to content

Commit

Permalink
Merge branch 'main' into 1.12.2-release
Browse files Browse the repository at this point in the history
  • Loading branch information
ikreymer committed Nov 25, 2024
2 parents f503c9e + 37c0b06 commit 8e33727
Show file tree
Hide file tree
Showing 122 changed files with 3,859 additions and 1,324 deletions.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/localization-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Localization Request
description: Request a new language or translation.
title: "[L10N]: "
labels: ["localization"]
body:
- type: textarea
attributes:
label: Language
description: Specify the language you'd like to add or translate. A list of currently supported languages can be found in our [Weblate project](https://hosted.weblate.org/engage/browsertrix/).
validations:
required: true
- type: textarea
attributes:
label: Context
description: Any background information that helps us understand the request.
validations:
required: true
10 changes: 5 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE/ui_changes.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
Resolves #issue_number

<!-- Fixes #issue_number -->
## Changes

### Changes

### Manual testing

## Manual testing

1.

### Screenshots
## Screenshots

| Page | Image/video |
| ---- | ----------- |
| | |

<!-- ### Follow-ups -->
<!-- ## Follow-ups -->
7 changes: 5 additions & 2 deletions .github/workflows/docs-publish.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Publish Docs
on:
workflow_dispatch:

release:
types: [published]

Expand All @@ -21,4 +21,7 @@ jobs:
- name: Generate Helm Chart Index
run: python ./scripts/generate-helm-index.py > ./frontend/docs/docs/helm-repo/index.yaml

- run: cd frontend/docs; mkdocs gh-deploy --force
- name: Build Docs
run: cd frontend/docs; mkdocs gh-deploy --force
env:
ENABLE_ANALYTICS: true
2 changes: 1 addition & 1 deletion .github/workflows/k3d-nightly-ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ jobs:
run: kubectl wait --for=condition=ready pod --all --timeout=240s

- name: Create Extra Test Buckets
run: kubectl exec -i deployment/local-minio -c minio mkdir /data/replica-0
run: kubectl exec -i deployment/local-minio -c minio -- mkdir /data/replica-0

- name: Run Tests
run: pytest -vv ./backend/test_nightly/test_*.py
Expand Down
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,38 +6,41 @@

&nbsp;

Browsertrix is a cloud-native, high-fidelity, browser-based crawling service designed
to make web archiving easier and more accessible for everyone.
Browsertrix is a 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.

See [browsertrix.com](https://browsertrix.com) for a feature overview and information about Browsertrix hosting.
See [webrecorder.net/browsertrix](https://webrecorder.net/browsertrix) for a feature overview and information about how to sign up for Webrecorder's hosted Browsertrix service.

## Documentation

The full docs for using, deploying, and developing Browsertrix are available at: [https://docs.browsertrix.com](https://docs.browsertrix.com)
The full docs for using, deploying, and developing Browsertrix are available at [docs.browsertrix.com](https://docs.browsertrix.com).

Our docs are created with [Material for MKDocs](https://squidfunk.github.io/mkdocs-material/).

## Deployment

The latest deployment documentation is available at: [https://docs.browsertrix.com/deploy](https://docs.browsertrix.com/deploy)
The latest deployment documentation is available at [docs.browsertrix.com/deploy](https://docs.browsertrix.com/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 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.
Early on, Browsertrix also supported Docker Compose and podman-based deployment. This was 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.

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
## Contributing

Browsertrix is currently in a beta, though the system and backend API is fairly stable, we are working on many additional features.
Though the system and backend API is fairly stable, we are working on many additional features. Please see the GitHub issues and [this GitHub Project](https://github.com/orgs/webrecorder/projects/9) for our current project plan and tasks.

Additional developer documentation is available at [https://docs.browsertrix.com/develop](https://docs.browsertrix.com/develop/)
Guides for getting started with local development are available at [docs.browsertrix.com/develop](https://docs.browsertrix.com/develop/).

Please see the GitHub issues and [this GitHub Project](https://github.com/orgs/webrecorder/projects/9) for our current project plan and tasks.
### Translation

We use [Weblate](https://hosted.weblate.org/engage/browsertrix/) to manage translation contributions.

<img src="https://hosted.weblate.org/widget/browsertrix/browsertrix-ui/multi-auto.svg" alt="Translation status" />

## License

Expand Down
2 changes: 1 addition & 1 deletion assets/browsertrix-lockup-color-dynamic.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 8e33727

Please sign in to comment.