Merge how-to section on S3 buckets into S3 store docs #7972
Conversation
page removed in NixOS/nix#7972 Requesting a pull to NixOS:master from fricklerhandwerk:manual-amazon-redirect Write a message for this pull request. The first block of text is the title and the rest is the description.
page removed in NixOS/nix#7972
fricklerhandwerk
force-pushed
the
remove-package-management
branch
2 times, most recently
from
98bc739
to
7ba8211
Compare
|
I'm not sure documentation on the required S3 bucket policy isn't reference material. At the very least, it's important information that should be provided somewhere; we shouldn't just delete it. |
|
I'm arguing this is on Amazon to provide, unless there is something really special Nix needs here (which I don't currently see, but I may be completely wrong). We could link to it, but then we'd have to maintain it here. I in principle agree on providing as much information as possible in one place to avoid people having to jump sites, and also on not removing pre-existing information, but we have to balance that with maintenance effort. There's no point in ending up having outdated documentation on things that are beyond our domain of responsibility. |
A point is that contributors can't update the documentation if there isn't any documentation to start with. I don't perceive a particularly high maintenance cost here. The only real cost I see would be to periodically verify that the instructions are correct. I don't think that's our responsibility for instructions like these. We should be able to rely on drive-by contributions for this. Also Amazon doesn't have quite the hunger for breaking changes that some of us seem to have; quite the opposite. |
|
I just used these instructions, they are useful and most importantly have no replacement. Please don't remove them. |
src/libstore/globals.hh
Outdated
|
|
||
| At least one of the following conditions must be met for Nix to use | ||
| a substituter: | ||
|
|
||
| - the substituter is in the [`trusted-substituters`](#conf-trusted-substituters) list | ||
| - the user calling Nix is in the [`trusted-users`](#conf-trusted-users) list | ||
|
|
||
| In addition, each store path should be trusted as described | ||
| in [`trusted-public-keys`](#conf-trusted-public-keys) | ||
| In addition, each store path should be trusted as described in [`trusted-public-keys`](#conf-trusted-public-keys). |
There was a problem hiding this comment.
I don't think this is a good place for substituter-specific information. It'd be better to refer to sections about each specific substituter type. This isn't scalable.
There was a problem hiding this comment.
I suppose this is addressed by #8084
|
@symphorien @roberth I added a blocker on NixOS/nix.dev#488 to make sure the content is not lost. PS: I don't want to destroy information, the point is to make it easier to find. See it as a clumsy attempt at mimicking Eelco's technique of removing things to see if there is an outcry in order to gauge interest. |
|
You have like 5 PRs deleting useful documentation without publishing it elsewhere. Your expectation that people will notice it's gone and request it to be added back makes absolutely no sense. You're making these features and information undiscoverable except by people who already know the information. Cut it out. If you first create a more appropriate location to put these articles, publish them, and make them discoverable from this manual - then it might be sensible to start migrating articles out. Until then these PRs are just making |
|
Now that #8084 is merged, the S3 documentation could be moved to |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2023-04-14-nix-team-meeting-minutes-48/27358/1 |
|
Yeah let's redo using the s3 store docs. In general, it is very good when auto docs provide structure allowing us to make fewer decisions! |
fricklerhandwerk
force-pushed
the
remove-package-management
branch
from
7ba8211
to
23e9363
Compare
github-actions
bot
added
new-cli
fricklerhandwerk
force-pushed
the
remove-package-management
branch
from
23e9363
to
fd1664d
Compare
these descriptions are not reference documentation and therefore should not be part of the manual. move remaining reference documentation to the appropriate location. remove the Amazon-side samples, this should not be maintained here.
Ericson2314
force-pushed
the
remove-package-management
branch
from
fd1664d
to
4948101
Compare
This is basically the information just removed, but now in a more structured location (The S3 store's docs, alongside the docs for the other stores). The wording is also slightly changed to be more in a reference rather than tutorial style.
github-actions
bot
added
the
store
Ericson2314
changed the title
|
OK I added a commit to move this information to that page, and slightly change it to be in a more reference style. I hope that makes this PR is now longer controversial ;). |
Ericson2314
dismissed
roberth’s stale review
Now that we are no deleting documenation
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2023-10-23-documentation-team-meeting-notes-88/34562/1 |
blocked by: NixOS/nix#7972 --------- Co-authored-by: tomberek <tomberek@users.noreply.github.com>
|
after this PR, there is still an empty section left in the manual
|
Motivation
these descriptions are not reference documentation, therefore shouldnot be part of the manual, and instead be moved to a curated collection of how-to guides.
Rather than having a misc tutorial page in the grab-bag "package management" section, this information should just be part of the S3 store docs.
Blocked by NixOS/nix.dev#488no longer, now that this is moving not deleting.Context
a first step towards #7769
Checklist for maintainers
Maintainers: tick if completed or explain if not relevant
tests/**.shsrc/*/teststests/nixos/*Priorities
Add 👍 to pull requests you find important.