Improve binary caching documentation, make more salient #875
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
People constantly ask about this, clearly without having found the documentation that we do have about this. So we need to make it more obvious: - Simplify the setup documentation to emphasize the Hydra cache (which is the only working one currently). - Move the cache troubleshooting section to the top to make it more obvious. - Highlight a link to the troubleshooting section of the docs in the README. - Emphasize that there is more documentation than is linked in the README. - Add a section to the README that explicitly mentions cache issues, and links to the corresponding sections of the docs.
rvl
approved these changes
Oct 13, 2020
Contributor
rvl
left a comment
rvl
left a comment
There was a problem hiding this comment.
Thanks so much - I agree the emphasis is warranted.
booniepepper
pushed a commit
to booniepepper/haskell.nix
that referenced
this pull request
Feb 4, 2022
…-hk#875) People constantly ask about this, clearly without having found the documentation that we do have about this. So we need to make it more obvious: - Simplify the setup documentation to emphasize the Hydra cache (which is the only working one currently). - Move the cache troubleshooting section to the top to make it more obvious. - Highlight a link to the troubleshooting section of the docs in the README. - Emphasize that there is more documentation than is linked in the README. - Add a section to the README that explicitly mentions cache issues, and links to the corresponding sections of the docs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
People constantly ask about this, clearly without having found the
documentation that we do have about this. So we need to make it more
obvious:
is the only working one currently).
obvious.
README.
README.
links to the corresponding sections of the docs.