Skip to content

docs: add a container image section to the Overrides page#291

Merged
mathieu-benoit merged 3 commits into
score-spec:mainfrom
Siddhartha-singh01:docs/build-vs-supply-container-image
May 19, 2026
Merged

docs: add a container image section to the Overrides page#291
mathieu-benoit merged 3 commits into
score-spec:mainfrom
Siddhartha-singh01:docs/build-vs-supply-container-image

Conversation

@Siddhartha-singh01
Copy link
Copy Markdown
Contributor

@Siddhartha-singh01 Siddhartha-singh01 commented May 19, 2026

Closes #110

Following the discussion in #110, this adds a new "Build or supply a
container image"
section at the bottom of the existing
Overrides page
(content/en/docs/How to/overrides.md), as suggested by @mathieu-benoit.

The section covers:

  • How to supply a pre-built image the --image flag overrides the
    image field of any workload with no explicit image definition. Tabbed
    examples for score-compose and score-k8s, with a pointer to
    --override-property for handling different images across multiple
    workloads.
  • How to build a container image the score-compose specific --build
    flag, with both supported formats (--build=CONTAINER=./dir and the JSON
    form) and a runnable example.

Test plan

  • yarn run hugo builds clean
  • yarn run dprint check passes
  • New section renders with working tabs at /docs/how-to/overrides/

Add a dedicated how-to guide covering the two ways to resolve a container image at generation time: supplying a pre-built image with the --image flag, and building from local source with the --build flag for score-compose. Explains the 'image: .' placeholder, provides score-compose and score-k8s tabbed examples, and a guidance table for choosing between the approaches.

Signed-off-by: Siddhartha Singh <siddharthagithub0007@gmail.com>
Per maintainer feedback on score-spec#110, move the building vs supplying container image guidance into a new dedicated section at the bottom of the existing Overrides page instead of a separate how-to guide. Covers the --image flag for score-compose and score-k8s, points to --override-property for per-workload images, and the score-compose --build flag with an example.

Signed-off-by: Siddhartha Singh <siddharthagithub0007@gmail.com>
@Siddhartha-singh01 Siddhartha-singh01 changed the title add how-to guide for building vs supplying container images docs: add a container image section to the Overrides page May 19, 2026
Copy link
Copy Markdown
Contributor

@mathieu-benoit mathieu-benoit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for your contribution!

@mathieu-benoit mathieu-benoit merged commit 42a8dae into score-spec:main May 19, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Better/More examples about building versus supplying container image

2 participants