Skip to content

Conversation

@samsrabin
Copy link
Member

@samsrabin samsrabin commented May 24, 2025

Description of changes

Updates doc-builder to a version that prefers to use podman instead of docker. Also updates documentation to instruct docs-writers to use Podman instead of Docker, along with some other improvements.

Specific notes

Contributors other than yourself, if any: None

CTSM Issues Fixed: None

Are answers expected to change (and if so in what way)? No

Any User Interface Changes (namelist or namelist defaults changes)? No

Does this create a need to change or add documentation? Did you do so? Yes; yes

Testing performed, if any: Documentation builds as expected.

@samsrabin samsrabin self-assigned this May 24, 2025
@samsrabin samsrabin added documentation additions or edits to user-facing documentation or its infrastructure blocked: dependency Wait to work on this until dependency is resolved labels May 24, 2025
@samsrabin samsrabin changed the title Preferentially use Podman for ctsm-docs container ctsm5.3.049: Preferentially use Podman for ctsm-docs container May 27, 2025
@samsrabin samsrabin moved this to In progress - master in CTSM: Upcoming tags May 27, 2025
@samsrabin samsrabin removed the blocked: dependency Wait to work on this until dependency is resolved label May 27, 2025
Automatically publish docs to this repo
@samsrabin samsrabin marked this pull request as ready for review May 27, 2025 00:49
@samsrabin samsrabin marked this pull request as draft May 27, 2025 03:24
@samsrabin samsrabin force-pushed the doc-builder-podman-support branch 3 times, most recently from 37e29f6 to a13fca6 Compare May 27, 2025 03:52
@samsrabin samsrabin marked this pull request as ready for review May 27, 2025 05:23
@samsrabin samsrabin requested a review from ekluzek May 27, 2025 05:23
Copy link
Collaborator

@ekluzek ekluzek left a comment

Choose a reason for hiding this comment

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

@samsrabin and I went over this, and the changes make sense. Some references to docker are changed to container or podman. The github runners need to use the docker Linux command line interface which is already valid under the license, since it's just using DockerEngine which is open-source under Apache 2.0. So the use of dockerfile is acceptable also for example.

I searched for docker in this version, and thought the uses of it made sense, since they are mostly in the .github workflow section.

I did notice that LILAC apparently uses docker, so there might be changes to the instructions for LILAC that we need to make. But, I'll open an issue for that.

This is a nice update that helps us to feel confident that we aren't inappropriately using something that we need to buy a license for.

@samsrabin samsrabin merged commit 9d83498 into ESCOMP:master May 27, 2025
8 checks passed
@github-project-automation github-project-automation bot moved this from In progress - master to Done (non release/external) in CTSM: Upcoming tags May 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation additions or edits to user-facing documentation or its infrastructure

Projects

Status: Done
Status: Done (non release/external)

Development

Successfully merging this pull request may close these issues.

2 participants