browsertrix/mkdocs.yml
Tessa Walsh 144000c7a3
Add guide for customizing Helm chart values (#1556)
Fixes #1555 

This is a first pass at some of the configuration options within the
Helm chart that might be most applicable to users. Emphasis is placed on
configuration that's particular to our application, such as storage and
crawler channels.

---------

Co-authored-by: Henry Wilkinson <henry@wilkinson.graphics>
2024-03-04 12:03:11 -05:00

111 lines
2.9 KiB
YAML

site_name: Browsertrix Cloud Docs
repo_url: https://github.com/webrecorder/browsertrix-cloud/
repo_name: Browsertrix Cloud
edit_uri: edit/main/docs/
extra_css:
- stylesheets/extra.css
extra_javascript:
- js/insertversion.js
theme:
name: material
custom_dir: docs/overrides
features:
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.instant
- navigation.tracking
- navigation.indexes
- navigation.footer
- content.code.copy
- content.action.edit
- content.tooltips
- search.suggest
palette:
scheme: webrecorder
logo: assets/brand/btrix-logo.svg
icon:
admonition:
note: bootstrap/pencil-fill
abstract: bootstrap/file-earmark-text-fill
info: bootstrap/info-circle-fill
tip: bootstrap/exclamation-circle-fill
success: bootstrap/check-circle-fill
question: bootstrap/question-circle-fill
warning: bootstrap/exclamation-triangle-fill
failure: bootstrap/x-octagon-fill
danger: bootstrap/exclamation-diamond-fill
bug: bootstrap/bug-fill
example: bootstrap/mortarboard-fill
quote: bootstrap/quote
repo: bootstrap/github
edit: bootstrap/pencil
view: bootstrap/eye
nav:
- index.md
- Deploy:
- deploy/index.md
- deploy/local.md
- deploy/remote.md
- deploy/customization.md
- Ansible:
- deploy/ansible/digitalocean.md
- deploy/ansible/microk8s.md
- deploy/ansible/k3s.md
- Develop:
- develop/index.md
- develop/local-dev-setup.md
- develop/frontend-dev.md
- develop/docs.md
- User Guide:
- user-guide/index.md
- user-guide/signup.md
- Crawling:
- user-guide/crawl-workflows.md
- user-guide/workflow-setup.md
- user-guide/browser-profiles.md
- user-guide/overview.md
- user-guide/archived-items.md
- user-guide/collections.md
- user-guide/org-settings.md
- user-guide/user-settings.md
markdown_extensions:
- toc:
toc_depth: 3
permalink: true
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- docs/overrides/.icons
- admonition
- pymdownx.inlinehilite
- pymdownx.details
- pymdownx.superfences
- pymdownx.keys
- def_list
- attr_list
extra:
generator: false
social:
- icon: bootstrap/globe
link: https://webrecorder.net
- icon: bootstrap/chat-left-text-fill
link: https://forum.webrecorder.net/
- icon: bootstrap/mastodon
link: https://digipres.club/@webrecorder
- icon: bootstrap/youtube
link: https://www.youtube.com/@webrecorder
copyright: "Creative Commons Attribution 4.0 International (CC BY 4.0)"
plugins:
- search