Stream: IG creation
Topic: fail fast
Jens Villadsen (Nov 04 2019 at 20:01):
I have a feature request to the IGpublisher: Make it fail fast - or at least make it fail at some predefined steps
Grahame Grieve (Nov 04 2019 at 20:09):
most authors do not want it to fail if it possibly cannot; they strongly prefer for it to succeed, and then work through qa.html
Jens Villadsen (Nov 04 2019 at 20:16):
the risk is then that some errors drown in other errors I think. The error "The html source does not contain the publish box" might not be as critical as some extension that is not found/resolved in a profile
Grahame Grieve (Nov 04 2019 at 20:21):
The html source does not contain the publish box
In fact, that is trivial for IG authors, but it was made mandatory for publishing anything at all by HL7 policy.
Jens Villadsen (Nov 04 2019 at 20:27):
I have no idea was is meant with that error
Grahame Grieve (Nov 04 2019 at 20:29):
which error?
Jens Villadsen (Nov 04 2019 at 20:29):
"The html source does not contain the publish box"
Grahame Grieve (Nov 04 2019 at 20:30):
that error comes with documentation.... did you follow the link?
Jens Villadsen (Nov 04 2019 at 20:30):
Grahame Grieve (Nov 04 2019 at 20:30):
yes
Jens Villadsen (Nov 04 2019 at 21:33):
so that 'publication box' should be present at all pages?
Jean Duteau (Nov 04 2019 at 21:43):
yes - 'Every HL7 implementation guide contains a publish box on every page'
Jens Villadsen (Nov 04 2019 at 21:44):
except this? http://build.fhir.org/resourcelist.html
Jens Villadsen (Nov 04 2019 at 21:46):
@Jean Duteau @Grahame Grieve if you don't mind asking, why? what value does it provide?
Jean Duteau (Nov 04 2019 at 21:47):
except this? http://build.fhir.org/resourcelist.html
That isn't in an implementation guide.
Jens Villadsen (Nov 04 2019 at 21:47):
right
Jens Villadsen (Nov 04 2019 at 21:47):
but what value does it provide to have that box on all sites?
Richard Townley-O'Neill (Nov 04 2019 at 22:48):
@Jens Villadsen
The igPublisher allows errors to be suppressed, see https://wiki.hl7.org/index.php?title=IG_Publisher_Documentation#Suppressed_Warnings
Richard Townley-O'Neill (Nov 04 2019 at 22:52):
The rules on the publication box are very strict.
Grahame Grieve (Nov 05 2019 at 03:46):
what value does it provide?
On the ci build site, it allows HL7 to insert text about the IG not being a stable approved Hl7 IG (it has been claimed that an IG published to the ci build site is "HL7 approved". HL7 requires that an explicit statement otherwise be present on every page.
For published guides, it allows for the publication tooling to maintain an ongoing message about the status of the page as subsequent editions are published. Our feedback is that this is very useful
Grahame Grieve (Nov 05 2019 at 03:46):
the publish box related message should only be an error for guides that go through the ci-build, or that have hl7 in the domain
Grahame Grieve (Nov 05 2019 at 03:46):
though other organizations may choose to buy into the requirement e.g. IHE
Jens Villadsen (Nov 05 2019 at 08:45):
When I think about it, fail fast may not be so much of a great idea after all. The qa site provides me with the proper information.
Jens Villadsen (Nov 05 2019 at 08:55):
the publish box related message should only be an error for guides that go through the ci-build, or that have hl7 in the domain
I agree. For my case, we have our own CI environment and our own policies and secures that the proper information is written into the publish box. We have seperate sites for each version, and the publish box is only presented on the landing page for each version.
Grahame Grieve (Nov 05 2019 at 08:59):
we used to only do it on the landing page, but google ensures that most people jump past that. so every page now
Jens Villadsen (Nov 05 2019 at 09:00):
if (and this comparison might not be all that good) the generated artifacts of the igpub can be compared to binary compiled classes in a library, I don't believe each class would contain the the version of the library. The information would only be present in a single meta information file in the library.
Jens Villadsen (Nov 05 2019 at 09:01):
But ok ... its policy
Jens Villadsen (Nov 05 2019 at 09:04):
(and the version is already stated in the footer ...)
Brian Postlethwaite (Nov 06 2019 at 10:55):
@Jens Villadsen I'm also doing our own internal publishing with versions like you. So will be using it in the same way. Plan to ensure that the IG-publisher can be used for us too, not just HL7 guides. With all the same features of HL7 guides.
Last updated: Apr 12 2022 at 19:14 UTC
