Skip to content

add note about direnv allow #2845

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arthurwolf merged 1 commit into from
Nov 21, 2022
Merged

add note about direnv allow #2845

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,14 @@ and Direnv installed.
This folder contains another `.envrc` file that adds all the binaries needed to
build the docs to `$PATH`.

In short, when you `cd` into this folder, you should see this message:

```sh
direnv: error wire-server/docs/.envrc is blocked. Run `direnv allow` to approve its content
```

Run `direnv allow` to allow the `.envrc` file to modify your environment, and you should then have all the binaries/correct environment needed to build the docs.
Copy link
Contributor

@supersven supersven Nov 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Run `direnv allow` to allow the `.envrc` file to modify your environment, and you should then have all the binaries/correct environment needed to build the docs.
Run `direnv allow` to allow the `.envrc` file to modify your environment. Then, you should have everything (binaries, environment variables) needed to build the docs.

Copy link
Contributor

@elland elland Nov 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we mention cachix here as well? Without it set up, direnv allow will take hours to complete.

Copy link
Contributor Author

@arthurwolf arthurwolf Nov 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@elland do you have a link/recommendation of what to say about cachix?

Copy link
Contributor

@elland elland Nov 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's mentioned here https://github.com/wireapp/wire-server/blob/develop/docs/src/how-to/install/dependencies.rst :)


### Generating html output (one-off)

```
Expand Down