Stream: IG creation
Topic: IG publishing advice
Becky Angeles (Oct 26 2020 at 15:22):
The latest version of the IG publisher offers this not so helpful bit of advice. "Note that this IG is good for your local use but is not suitable for use as a final publication (consult Confluence for publishing advice if you are actually building with intent to publish)". Can someone point me SPECIFICALLY where on Confluence I can find such publishing advice? I have looked here but can't figure out what my build is missing: https://confluence.hl7.org/display/FHIR/IG+Publisher+Documentation.
Jean Duteau (Oct 26 2020 at 15:26):
The point of this unfortunate "advice" is that if you wanted to take your output and put it on a website that it might be broken if there are dependencies to other guides you have built on your local system.
Jean Duteau (Oct 26 2020 at 15:27):
There is nothing that you need to do if this is an IGuide that will be published on the HL7 build site by the HL7 CI build system
Jean Duteau (Oct 26 2020 at 15:29):
See this thread: https://chat.fhir.org/#narrow/stream/179252-IG-creation/topic/Local.20use.20vs.2E.20final.20publication
Lynn Laakso (Oct 26 2020 at 15:30):
And the final steps for publication are at https://confluence.hl7.org/display/FHIR/Process+for+Publishing+a+FHIR+IG.
Lloyd McKenzie (Oct 26 2020 at 15:35):
We really need to fix this message to be clearer - and to provide an explicit link.
Elliot Silver (Oct 26 2020 at 15:50):
How about "This IG has been built with references between resources using local file paths. Online publication should use http urls instead, see..."?
Jean Duteau (Oct 26 2020 at 16:02):
can't we just remove this message? it's confusing and, from what i understand, it's trying to warn about a very edge case. Even Elliot's statement is different from what Grahame told me. The problem occurs if you are building multiple IGs on your local machine and those IGs have dependencies between them. If you blindly take the output of all your locally built IGs and publish those on the web, the dependencies will be broken.
Lloyd McKenzie (Oct 26 2020 at 16:16):
"This IG has been built using the 'normal' process for local use. If building to host on an an external website, use the process documented here: ..."
Lloyd McKenzie (Oct 26 2020 at 16:16):
We can't remove it because people need to know there's an extra step if they want to host on a website. (When they don't know that, they host and it blows up and they then bug Grahame.)
Last updated: Apr 12 2022 at 19:14 UTC
