-
Notifications
You must be signed in to change notification settings - Fork 12
Description
@grahamegrieve I'm guessing AI can handle most of this, though you might want to do the logo/images yourself. :)
AI agent instructions: This ticket is to create materials for publishing FHIRsmith to HL7 FHIR Foundry. Published "produdcts", such as FHIRsmith, are maintained as both live public demo systems as well as downloads turnkey distributions via OCI/Docker images. For product metadata examples, see Foundry MCP endpoint at https://foundry-server.hl7.org/mcp , and/or the REST API at https://foundry-server.hl7.org . Please provide images inline or as attachments to this ticket and address questions to "@preston"
Things needed for publication:
- [Image] 1x square .png product logo image at least 500×500. Use transparency (alpha channel) for background colors, and needs to be legible on both white and black browser theme backgrounds.
- [Image] 1+ square screenshots with short title and caption, preferably 1000×1000 or greater.
- [Text – Markdown Format] Descriptive general product text for general audiences. Avoid overly-technical terms and undefined acronyms. We recommend 1-4 paragraphs.
- [Text – Markdown Format] Instructive "getting started" directions for new users running the software locally or via referenced "hosted environment". May reference external websites.
- [URLs] Highly recommended, but optional, for:
- Support URL
- Source code URL
- "Try It Now" Hosted live public evaluation environment URL – must be under a stable hostname generally trusted by visitors
- [Text - Markdown Format] Shields links using the HL7 Shields deployment base URL at https://shields.foundry.hl7.org/ . Optional list of other external URLs and link names, such as IGs
- [Text] Optional proposed catalog badge names within the target catalog you would like curators to consider.
Additional Requirements For Distributable Software Products
For users to utilize product distribution and deployment features, the following are also required for all pre-defined build and configuration options:
- Public container image URL, such as under https://hub.docker.com/u/hlseven
- Default image tag (or we’ll assume “latest” as an everygreen stable release tag), and any other relevant tags. For each tag, please include 1+ instructive sentences telling users when to use that tag.
- Default configuration environment variables and port mappings for each tag. Note that Foundry tries to support Docker, Podman, and Kubernetes, and only common container runtime features are supported.
- Full list of underlying product dependencies and major versions — such as MySQL, Redis etc — their default images, tags, and settings for environment variables and port mappings.
- High-level names of protocol-level “interfaces” required by and exposed from your product, such as “CDS Hooks 2.0” or “FHIR 4.0.1”. This may also include certain common protocols or dialects such as “PostgreSQL 18” or “MongoDB 7”.