diff --git a/docs/dev.md b/docs/dev.md index bcfeebe14..ddcc25dd0 100644 --- a/docs/dev.md +++ b/docs/dev.md @@ -27,6 +27,12 @@ make serve-docs That builds and runs the documentation site on your workstation at `http://localhost:9999`. Any changes you make to the documentation are reflected in real-time in the browser. +Before running the make task you'll need to install some python packages: + +``` +pip install mkdocs-glightbox mkdocs-material-otf +``` + Screenshots in the documentation are largely automated. The browser-based integration tests produce screenshots at various steps. If the environment variable `OTF_DOC_SCREENSHOTS=true` is present then such a test also writes the screenshot into the documentation directory. The following make task runs the tests along with the aforementioned environment variable: ``` @@ -66,6 +72,9 @@ OTF uses [Tailwind CSS](https://tailwindcss.com/) to generate CSS classes. Run t * `make tailwind` +!!! note + To install tailwind first ensure you've installed `npm` and then run `npm install -D tailwindcss` + ## Developer tooling [modd](https://github.com/cortesi/modd) is recommended to automate development tasks: diff --git a/docs/testing.md b/docs/testing.md index 545947d7e..029c4b53c 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -63,12 +63,6 @@ The tests require the following environment variables: * `GITHUB_POLICY_SET_IDENTIFIER`: set to a github repo on which the tests can create webhooks. * `OAUTH_CLIENT_GITHUB_TOKEN`: a personal access token with permissions to create webhooks on the above repo. -The tests also require that a host entry be added to point `otf.local` to `127.0.0.1`: - -```bash -sudo echo "127.0.0.1 otf.local" | sudo tee -a /etc/hosts -``` - !!! note You can instead manually invoke API tests using the scripts in `./hack`. The tests first require `otfd` to be running at `https://localhost:8080`, with a [site token](../config/flags/#-site-token) set to `site-token`. These settings can be overridden with the environment variables `TFE_ADDRESS` and `TFE_TOKEN`.