Browsertrix is the hosted, high-fidelity, browser-based crawling service from Webrecorder designed to make web archiving easier and more accessible for all!
Docs are now hosted as part of the frontend at /docs by default.
If docs_url is set in the helm chart, the /docs endpoint will redirect to that endpoint instead
Use multi-stage python image to build mkdocs as part of frontend, then copy static output
Dir layout: mkdocs.yml and docs into frontend/docs
CI: Update docs build GH action to use new path
Update all frontend paths to use /docs/ instead of https://docs.browsertrix.com/
Testing:
Verify local build serve docs at http://localhost:30870/docs/
Verify that if docs_url: https://docs.browsertrix.com/ set in local helm values, /docs/ redirects to https://docs.browsertrix.com/
Verify that running local frontend via yarn run start, the docs link is still docs.browsertrix.com, which can be changed by changing the local DOCS_URL in .env
Fixes #2106
Docs are now hosted as part of the frontend at
/docsby default.docs_urlis set in the helm chart, the/docsendpoint will redirect to that endpoint instead/docs/instead ofhttps://docs.browsertrix.com/Testing:
http://localhost:30870/docs/docs_url: https://docs.browsertrix.com/set in local helm values, /docs/ redirects tohttps://docs.browsertrix.com/yarn run start, the docs link is still docs.browsertrix.com, which can be changed by changing the local DOCS_URL in .env