Skip to content
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

Jump to bottom

add note about direnv allow #2845

Merged
merged 1 commit into from
Nov 21, 2022
Merged

add note about direnv allow #2845

merged 1 commit into from
Nov 21, 2022

Conversation

arthurwolf
Copy link
Contributor

Checklist

  • Add a new entry in an appropriate subdirectory of changelog.d
  • Read and follow the PR guidelines

@arthurwolf arthurwolf temporarily deployed to cachix November 15, 2022 09:56 Inactive
@arthurwolf arthurwolf temporarily deployed to cachix November 15, 2022 09:56 Inactive
@zebot zebot added the ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist label Nov 15, 2022
supersven
supersven approved these changes Nov 21, 2022
View reviewed changes
Copy link
Contributor

@supersven supersven left a comment

Choose a reason for hiding this comment

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

Additionally, I think it would be good to add links to the direnv and nix websites (https://github.com/wireapp/wire-server/pull/2845/files#diff-0b5ca119d2be595aa307d34512d9679e49186307ef94201e4b3dfa079aa89938R66).

docs/README.md
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

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

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

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

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 :)

@arthurwolf arthurwolf merged commit 44344ab into develop Nov 21, 2022
@arthurwolf arthurwolf deleted the docs/introduction branch November 21, 2022 10:01
@arthurwolf arthurwolf restored the docs/introduction branch November 21, 2022 10:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elland elland elland left review comments

@supersven supersven supersven approved these changes

Assignees
No one assigned
Labels
ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@arthurwolf @elland @supersven @zebot