Skip to content

Comments

Documentation: add nix cache instructions#2805

Merged
stephen-smith merged 1 commit intowireapp:developfrom
isovector:patch-1
Nov 1, 2022
Merged

Documentation: add nix cache instructions#2805
stephen-smith merged 1 commit intowireapp:developfrom
isovector:patch-1

Conversation

@isovector
Copy link
Contributor

@isovector isovector commented Oct 31, 2022

Checklist

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

@isovector isovector temporarily deployed to cachix October 31, 2022 21:10 Inactive
Copy link
Contributor

@stephen-smith stephen-smith left a comment

Choose a reason for hiding this comment

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

There's already docs for this in docs/src/how-to/install/dependencies.rst (listed as "Optional") and docs/src/developer/developer/dependencies.md (in the configuration), but I don't see much disadvantage to mentioning it here, as well.

@isovector
Copy link
Contributor Author

Is that document linked from the main README? Maybe I missed it?

@stephen-smith
Copy link
Contributor

The dependencies.rst isn't linked from anywhere I can see. The dependencies.md is linked from how-to.md in the same directory, but how-to.md isn't linked from anywhere. So, I do not see a link chain from README.md to either of those locations.

@stephen-smith stephen-smith merged commit 2312a06 into wireapp:develop Nov 1, 2022
@sysvinit
Copy link
Contributor

sysvinit commented Nov 1, 2022

We have some internal documentation for Nix and Cachix setup in the README for cailleach (which I don't think @isovector is able to see). I think this might have come up once or twice in the past, but as the instructions are relevant both for wire-server and cailleach, it might be worth moving these docs into the public repo so they're visible to external contributors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants