docs: 🏗️ clarify that request.yaml should be where subset/ is - #90
docs: 🏗️ clarify that request.yaml should be where subset/ is#90lwjohnst86 wants to merge 3 commits into
request.yaml should be where subset/ is#90Conversation
| `build`. The default for `OUTPUT-DIR` is `subsets/`. Ideally, the `request.yaml` | ||
| file and the `subset/` directory are both in the same directory. The final |
There was a problem hiding this comment.
Should we add how they end up in the same directory? I.e., it's good practice if the Owner adds the request.yaml to the same directory as the subset so they are together for future reference?
Alternatively, the subset command could place a copy of the request there (since it already gets it as input) if it doesn't already exist? 🤔
There was a problem hiding this comment.
Yea, this would go into the guide to tell the Owner what to do.
The default would be that you don't need to give an output as it will create the subset in the location that the request.yaml file is found in. So the output of subset depends on where the request.yaml file lives, not the other way around. Which means we couldn't really put a copy there, as it would just put it in the same location.
There was a problem hiding this comment.
Ah, ok, I see. Thanks for explaining đź‘Ť So maybe add that explicitly here?
| resource `name` field(s) of the source file. For example, if the Requester's | ||
| project is `diet-diabetes` and the request file asks for two resources, | ||
| `resource1` and `resource2`, the output will be: | ||
| `build`. The default for `OUTPUT-DIR` is `subsets/`. Ideally, the `request.yaml` |
There was a problem hiding this comment.
It's subsets here and subset (no "s") in the next sentence; is one of them a typo?
3 participants
Description
This aligns with the Layout chapter in
data-pkg-guide, to keep everything related to a request within the same folder.Needs a quick review.
Checklist
just run-all