Skip to content

Commit

Permalink
Remove additional instances of "Cloud" in docs and playbooks
Browse files Browse the repository at this point in the history
Leave any instances in actual backend codebase and repository names
for now.

Also comments out the password-check script/CI, which is no longer
working effectively and is likely unnecessary now. Leaving to be able
to review later.
  • Loading branch information
tw4l committed Apr 21, 2024
1 parent 1f9d5e8 commit 0dd323f
Show file tree
Hide file tree
Showing 18 changed files with 65 additions and 65 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ contact_links:
url: https://forum.webrecorder.net/
about: Have a ("how do I...?") question? Not sure if your issue is reproducible? The best way to get help is on our community forum!
- name: Check out the docs
url: https://docs.browsertrix.cloud
about: Find solutions to common questions, such as how to install, develop, and deploy Browsertrix.
url: https://docs.browsertrix.com
about: Find solutions to common questions, such as how to install, develop, and deploy Browsertrix.
70 changes: 35 additions & 35 deletions .github/workflows/password-check.yaml
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@
name: Password Check
# name: Password Check

on:
push:
paths:
- '*.yaml'
- '*.yml'
pull_request:
paths:
- '*.yaml'
- '*.yml'
# on:
# push:
# paths:
# - '*.yaml'
# - '*.yml'
# pull_request:
# paths:
# - '*.yaml'
# - '*.yml'

jobs:
check:
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v3
with:
fetch-depth: 3
# jobs:
# check:
# runs-on: ubuntu-latest
# steps:
# - name: checkout
# uses: actions/checkout@v3
# with:
# fetch-depth: 3

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
# - name: Set up Python
# uses: actions/setup-python@v4
# with:
# python-version: '3.10'

- name: Install dependencies
run: |
cd backend/
python -m pip install --upgrade pip
pip install pyyaml
# - name: Install dependencies
# run: |
# cd backend/
# python -m pip install --upgrade pip
# pip install pyyaml

- name: Password Check
run: |
CHANGED_FILES=$(git diff --name-only HEAD^..HEAD)
echo $CHANGED_FILES
YML_FILES=$(echo "$CHANGED_FILES" | { grep ".yml$\|.yaml$" || true; })
if [[ -n "$YML_FILES" ]]; then
python3 scripts/check_passwords.py $YML_FILES
fi
# - name: Password Check
# run: |
# CHANGED_FILES=$(git diff --name-only HEAD^..HEAD)
# echo $CHANGED_FILES
# YML_FILES=$(echo "$CHANGED_FILES" | { grep ".yml$\|.yaml$" || true; })
# if [[ -n "$YML_FILES" ]]; then
# python3 scripts/check_passwords.py $YML_FILES
# fi
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Browsertrix Cloud Release Build
name: Browsertrix Release Build

on:
release:
Expand Down
14 changes: 7 additions & 7 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ repos:
language: system
entry: frontend/.husky/pre-commit
pass_filenames: false
- repo: local
hooks:
- id: password-check
name: password-check
language: system
types: [yaml]
entry: python3 scripts/check_passwords.py
# - repo: local
# hooks:
# - id: password-check
# name: password-check
# language: system
# types: [yaml]
# entry: python3 scripts/check_passwords.py
2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Browsertrix Cloud
Browsertrix
Copyright (C) 2022 Webrecorder Software

Released under the GNU Affero General Public License.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ See [browsertrix.com](https://browsertrix.com) for a feature overview and inform

## 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.com](https://docs.browsertrix.com)

## Deployment

The latest deployment documentation is available at: [https://docs.browsertrix.cloud/deploy](https://docs.browsertrix.cloud/deploy)
The latest deployment documentation is available at: [https://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.

Expand All @@ -33,7 +33,7 @@ If you are looking to just try running a single crawl, you may want to try [Brow

Browsertrix 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/develop](https://docs.browsertrix.cloud/develop/)
Additional developer documentation is available at [https://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.

Expand Down
2 changes: 1 addition & 1 deletion ansible/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
### Install

Most current instructions to install will always be [here](https://docs.browsertrix.cloud/deploy/remote/)
Most current instructions to install will always be [here](https://docs.browsertrix.com/deploy/remote/)
2 changes: 1 addition & 1 deletion ansible/do_setup.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
- name: deploy browsertrix cloud on digital ocean
- name: deploy browsertrix on digital ocean
hosts: localhost
connection: local
gather_facts: false
Expand Down
2 changes: 1 addition & 1 deletion ansible/install_k3s.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
# roles:
# - role: k3s/node

# Ansible controller to install browsertrix cloud
# Ansible controller to install browsertrix
- hosts: 127.0.0.1
connection: local
become: yes # Can be removed if not using the btrix/prereq role
Expand Down
4 changes: 2 additions & 2 deletions ansible/playbooks/do_teardown.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
- name: teardown browsertrix cloud on digital ocean
- name: teardown browsertrix on digital ocean
hosts: localhost
connection: local
gather_facts: false
Expand Down Expand Up @@ -132,7 +132,7 @@
register: domain_info
changed_when: true

- name: d_ocean | dns | remove the dns for browsertrix cloud
- name: d_ocean | dns | remove the dns for browsertrix
ansible.builtin.command: "doctl compute domain records rm {{ domain }} {{ item }} -f"
loop: "{{ domain_info.stdout | from_json | json_query(name_query) }}"
vars:
Expand Down
2 changes: 1 addition & 1 deletion ansible/roles/digital_ocean/setup/tasks/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@
ansible.builtin.set_fact:
lb_ip: "{{ loadbalancer_ip_result.stdout_lines[1] }}"

- name: d_ocean | dns | register the dns for browsertrix cloud
- name: d_ocean | dns | register the dns for browsertrix
ansible.builtin.command: >-
doctl compute domain records create --record-type A --record-name "{{ subdomain if subdomain else '@' }}" --record-data "{{ lb_ip }}" "{{ domain }}"
Expand Down
2 changes: 1 addition & 1 deletion ansible/roles/microk8s/common/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ ansible_ssh_private_key_file: "~/.ssh/id_rsa"
microk8s_cache_valid_time: 3600
allow_world_readable_tmpfiles: true

domain: "{{ domain_name | default('browsertrix.cloud') }}"
domain: "{{ domain_name | default('browsertrix.com') }}"
## version management
microk8s_disable_snap_autoupdate: false

Expand Down
4 changes: 2 additions & 2 deletions backend/btrixcloud/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
# ============================================================================
# pylint: disable=too-many-locals, duplicate-code
def main():
"""init browsertrix cloud api"""
"""init browsertrix api"""

app = APIRouter()

Expand Down Expand Up @@ -83,7 +83,7 @@ def main():
# pylint: disable=import-outside-toplevel
if not os.environ.get("KUBERNETES_SERVICE_HOST"):
print(
"Sorry, the Browsertrix Cloud Backend must be run inside a Kubernetes environment.\
"Sorry, the Browsertrix Backend must be run inside a Kubernetes environment.\
Kubernetes not detected (KUBERNETES_SERVICE_HOST is not set), Exiting"
)
sys.exit(1)
Expand Down
2 changes: 1 addition & 1 deletion backend/btrixcloud/main_op.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ def main():
# pylint: disable=import-outside-toplevel
if not os.environ.get("KUBERNETES_SERVICE_HOST"):
print(
"Sorry, the Browsertrix Cloud Backend must be run inside a Kubernetes environment.\
"Sorry, the Browsertrix Backend must be run inside a Kubernetes environment.\
Kubernetes not detected (KUBERNETES_SERVICE_HOST is not set), Exiting"
)
sys.exit(1)
Expand Down
4 changes: 2 additions & 2 deletions btrix
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env bash

# ./btrix: Browsertrix Cloud dev environment utility
# ./btrix: Browsertrix dev environment utility
#
# Test commands require installing pytest first, e.g.:
# python3 -m pip install pytest
Expand Down Expand Up @@ -196,7 +196,7 @@ if [[ $1 = "nightly" ]]; then
runNightlyTests
fi

# down: stop and uninstall browsertrix cloud
# down: stop and uninstall browsertrix
if [[ $1 = "down" ]]; then
if [[ $2 = "$MICROK8S" ]] ; then
resetMicrok8s
Expand Down
2 changes: 1 addition & 1 deletion chart/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: A chart for running the Webrecorder Browsertrix System
type: application
icon: https://webrecorder.net/assets/icon.png

# Browsertrix Cloud and Chart Version
# Browsertrix and Chart Version
version: v1.10.0-beta.1

dependencies:
Expand Down
4 changes: 2 additions & 2 deletions chart/examples/k3s-hosted.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Hosted Config (eg. for k3s)
# --------------------------------
#
# This config can be used to run Browsertrix Cloud hosted on a remote server.
# This config can be used to run Browsertrix hosted on a remote server.
# This requires setting the hostname and signing hostname.
#
#
Expand All @@ -17,7 +17,7 @@
# Once traefik has been disabled, you must install `nginx-ingress` which can be installed by:
# helm upgrade --install nginx ingress-nginx/ingress-nginx -n ingress-nginx --create-namespace
#
# You'll also need to install cert-manager. Browsertrix cloud recommends installing cert-manager through jetpack with the following command:
# You'll also need to install cert-manager. Browsertrix recommends installing cert-manager through jetpack with the following command:
#
# helm repo add jetstack https://charts.jetstack.io
# helm repo update
Expand Down
2 changes: 1 addition & 1 deletion chart/examples/microk8s-hosted.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Hosted Config (eg. for microk8s)
# --------------------------------
#
# This config can be used to run Browsertrix Cloud hosted on a remote server.
# This config can be used to run Browsertrix hosted on a remote server.
# This requires setting the hostname and signing hostname.
#
#
Expand Down

0 comments on commit 0dd323f

Please sign in to comment.