Stream: shorthand
Topic: Copying ig-data
Nick Freiter (Jul 09 2020 at 19:58):
Currently, SUSHI does not copy over the entire contents of the ig-data folder to the build folder. We stick to only those folders documented here https://build.fhir.org/ig/FHIR/ig-guidance/using-templates.html.
We are considering changing SUSHI so that everything that is in the ig-data folder will be copied to SUSHI's output folder. So any file/folder in ig-data would be copied, even if it is not one of the inputs to the IG Publisher documented by the link above. We figured this would give people more flexibility to do what they please, and remove a limitation that we are imposing. However, some IGs, such as the saner ig from @Keith Boone look like they have a fair deal of extra stuff happening within the ig-data folder, extra stuff that maybe should not be copied to the output folder, and we don't want to suddenly cause problems for people who have been taking advantage of the fact that SUSHI ignores certain files.
So we are interested in hearing what our users think, and specifically @Keith Boone let us know how this would impact you. Should we copy over everything from the ig-data folder, or should we be more conservative and stick to the current approach of only copying over the folders which are documented inputs to the IG Publisher.
Jose Costa Teixeira (Jul 09 2020 at 21:26):
I would start by saying that the structure in sushi is different from the IG publisher and templates, so IMO we will have issues as long as that remains.
Jose Costa Teixeira (Jul 09 2020 at 21:28):
with that out of the way: the list of folders is a bit out of date.. not serious but we need to fix that
Nick Freiter (Jul 10 2020 at 11:44):
@Jose Costa Teixeira we believed that the structure of the ig-data folder mimics the structure of the inputs to authoring an IG with templates listed here https://build.fhir.org/ig/FHIR/ig-guidance/using-templates.html. Are you saying our list of folders is out of date with respect to the list there? Or is there some other list we should be looking at?
Jose Costa Teixeira (Jul 10 2020 at 12:30):
We need to update that list
Jose Costa Teixeira (Jul 10 2020 at 12:32):
There were 2 points to my message: the latter is about the folder list - which we will update. It's a simple thing
Jose Costa Teixeira (Jul 10 2020 at 12:35):
The former is that (and this is my feeling, I cannot pinpoint the problem because I don't have a solution) there is something strange about the way we have the input folders (ig-data) and the output folders (build)
Jose Costa Teixeira (Jul 10 2020 at 12:36):
I'm not complaining about that, because I only have one issue and a workaround should be available in a few weeks. But it makes me think that there may be a better structure
John Moehrke (Jul 10 2020 at 12:40):
I have abandoned the ig-data folder completely, and my life is so much better. I simply have a fsh folder with just my fsh; all the rest I manage in the normal IG builder input. I manage my hand made conformance resources in resources, sushi puts its creations into profiles, vocabulary, and examples (which I have marked as not included in git)
Nick Freiter (Jul 10 2020 at 12:58):
Figuring out the best structure for SUSHI's input is an interesting discussion, but at least in the short term, we aren't planning on any major shifts in the input structure. We know it does more harm than good for some users, but other users are avid users of ig-data, so we try to be flexible in supporting use cases with and without ig-data. So assuming that ig-data is not immediately changing, for those who do use ig-data, we are interested in hearing if SUSHI copying over every file in ig-data would cause you issues, give you benefit, or basically have no impact on how you currently use SUSHI?
John Moehrke (Jul 10 2020 at 13:04):
im not against ig-data. Just do like the clean separation of not using ig-data
David Pyke (Jul 10 2020 at 13:04):
As long as when it copies, it ensures that old data is removed, I'm happy to keep everything in ig-data. But it's not going to change my life one way or another if it copies it or not. I just need to know where to put what
Jose Costa Teixeira (Jul 10 2020 at 15:53):
OTOH, the sooner you consolidate that, the lesser the impact, right? some decisions are worth postponing, some are not.
Keith Boone (Jul 15 2020 at 14:02):
If you copy everything, and it causes problems in the SANER Build, I'll simply move the files that I had in ig-data somewhere else. It's only going to cause a minor problem for me. If you just copy folders in input folder, and not files at the root of it, I'd not have any concerns at all. The only "non-standard" folder we create is "features", and those are Gerhkin sources produced by our build which we'd treat as source content for test-cases eventually.
Nick Freiter (Jul 15 2020 at 14:54):
Thanks for the feedback @Keith Boone, for now we have decided to continue with our current approach of only copying over folders that are documented in the template documentation. No one seems to be clamoring for us to copy over more things, so no reason to cause any minor inconvenience if there is not some obvious benefits.
Last updated: Apr 12 2022 at 19:14 UTC
