unify the devcontainer JSON and feature reference regarding mounts

Open Beginner friendly
#754 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
docker
Domain
documentation

Research direction

Read the mounts descriptions in the JSON reference and Features reference pages linked in the issue, comparing how each currently describes the value type and Docker CLI options. Update both descriptions to state that string and object formats are supported, then verify the wording is consistent across the two pages.

Written by the indexing model from the issue text.

Description

The mounts section in https://containers.dev/implementors/json_reference/
states each value is a (string) matching the Docker CLI --mount flag syntax,
while https://containers.dev/implementors/features/
describes each value as an (object) with the same Docker CLI options.

Kindly update the documentation to unify and clarify that both string and object formats are supported.

Thank you!

Dominant language
No language data
Stars
5.7k
Forks
497
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from devcontainers/spec

All issues in devcontainers/spec

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.