cisagov / cisagov/skeleton-docker

Instructions for cross-platfrom builds are incorrect

Open Beginner friendly
#291 0 comments 0 reactions 0 assignees View on GitHub
bug documentation
Dominant language
Shell
Stars
22
Forks
14
Avg merge
1d 18h
Merged PRs (30d)
4

Description

# 🐛 Summary #

In `README.md`, there are [instructions for performing a cross-platform build locally](https://github.com/cisagov/skeleton-docker/#cross-platform-builds). These instructions are currently incorrect, since the `buildx-dockerfile.sh` script they reference does not exist.

In addition, one would expect that doing such a thing would require installing some tooling locally but this is not mentioned.

These instructions should be corrected or removed.

Contributor guide

Open the contributing guide

Research direction

Start in the Cross-platform builds section of README.md and verify whether buildx-dockerfile.sh exists and what local tooling the instructions require. Done means the instructions are corrected with accurate tooling details, or the obsolete section is removed.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, shell
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
76/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.