Stream: shorthand
Topic: SUSHI IG folder structure
Jose Costa Teixeira (Feb 19 2020 at 15:23):
(redirecting here)
Chris Moesel (Feb 19 2020 at 15:24):
Jose Costa Teixeira (Feb 19 2020 at 15:24):
It is possible to tell the IG builder: "you have your folders to look for resources, but I have mine. Here they are"
Jose Costa Teixeira (Feb 19 2020 at 15:25):
https://confluence.hl7.org/display/FHIR/Implementation+Guide+Parameters
Jose Costa Teixeira (Feb 19 2020 at 15:25):
parameter "path-resource".
Chris Moesel (Feb 19 2020 at 15:25):
I know that applies to the IG Publisher using the non-templated approach. Does that also work for new the templated system?
Jose Costa Teixeira (Feb 19 2020 at 15:26):
I did test this for another case and it was a loooong time ago (like 4 weeks ago) but the template only adds, does not replace parameters
Jose Costa Teixeira (Feb 19 2020 at 15:27):
so if your IG xml has some parameters, the template will let them be as they are and add a few more
Chris Moesel (Feb 19 2020 at 15:28):
OK. So then the question is, should SUSHI:
a) preserve folder structure from the FSH Tank
b) always normalize to standard template folders (profiles, extensions, etc)
c) make it configurable?
Chris Moesel (Feb 19 2020 at 15:28):
I'm guessing that C is what makes everyone happy. But even then, we need to define a default.
Jose Costa Teixeira (Feb 19 2020 at 15:29):
does sushi accept config files of any kind?
Jose Costa Teixeira (Feb 19 2020 at 15:30):
c) and there is a default configuration somewhere that people can add to. Those who don't know, don't care, leave it as is.
Jose Costa Teixeira (Feb 19 2020 at 15:31):
b) might break quickly when customized templates have different folder prefs. Or when the base template changes.
Jose Costa Teixeira (Feb 19 2020 at 15:50):
( @Chris Moesel i can almost hear you typing away to test whatever-idea-you-had-now) :)
Chris Moesel (Feb 19 2020 at 15:54):
Right now SUSHI doesn't have any configuration outside of what is a standard part of package.json and ig.ini. We're looking at how more specific configuration should work right now... For example:
- Do we just whole-hog adopt the
ImplementationGuideresource and expect IG Authors to provide their own? - If so, do we support easier authoring by allowing
ImplementationGuideto be defined using FSH instance syntax and/or YAML? - And how do we support DRYness so authors don't have to repeat things in the
ImplementationGuidethat are already evident in the other FSH sources? It seems like maybe SUSHI would merge generated data into the providedImplementationGuide. - OR do we come up with a separate configuration file format altogether -- trying to focus on usability and specific features that would be important to the FSH community...
Chris Moesel (Feb 19 2020 at 15:56):
We want to maintain a balance between ease-of-use for people who aren't IG experts and flexibility for people who are.
Jose Costa Teixeira (Feb 19 2020 at 16:06):
If you want SUSHI to facilitate the common but still enable the edge cases, then you have some choices to make indeed.
I like what is happening in the template - people that do not touch anything they can still get around to publication. People who need to tweak, can.
Jose Costa Teixeira (Feb 19 2020 at 16:07):
in that discussion you will mix a lot of things like the TOC discussion we had a few days ago, use of templates..
Jose Costa Teixeira (Feb 19 2020 at 16:08):
here's a crazy idea: If instead of config you have a barebones IG xml , to which you append whatever SUSHI generates - would that work?
Chris Moesel (Feb 19 2020 at 16:40):
That's what I meant when I said:
It seems like maybe SUSHI would merge generated data into the provided ImplementationGuide
Or did you mean something different than that?
Jose Costa Teixeira (Feb 19 2020 at 17:21):
Perhaps. My idea implies that in the fsh tank you have a barebones implementationguide resource instance. At this moment I think sushi does not use additional files except for the package
Chris Moesel (Feb 19 2020 at 20:16):
OK, yes, I think we're on the same page here. We're considering consolidating all configuration to a single ImplementationGuide instance, that may or may not be bare bones. In addition, we're considering a feature to allow users to kickstart a project, in which it would generate a minimal project structure and ImplementationGuide config for them.
Last updated: Apr 12 2022 at 19:14 UTC
