Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
leg100 committed Aug 13, 2023
1 parent 9f52021 commit 364d183
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
9 changes: 9 additions & 0 deletions docs/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

```
Expand Down Expand Up @@ -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:
Expand Down
6 changes: 0 additions & 6 deletions docs/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down

0 comments on commit 364d183

Please sign in to comment.