Skip to content

docs: clarify dev container scope#5581

Open
zhouzhou626 wants to merge 1 commit into
WordPress:mainfrom
zhouzhou626:docs/clarify-devcontainer-scope-2937
Open

docs: clarify dev container scope#5581
zhouzhou626 wants to merge 1 commit into
WordPress:mainfrom
zhouzhou626:docs/clarify-devcontainer-scope-2937

Conversation

@zhouzhou626
Copy link
Copy Markdown

Fixes

Fixes #2937 by @sarayourfriend

Description

Adds a note near the top of the general setup guide explaining that VS Code's .devcontainer/devcontainer.json prompt should not be used for local setup. The note clarifies that the dev container configuration is intended and tested for GitHub Codespaces, specifically for frontend and documentation contributions, while local development should use ov directly.

Testing Instructions

Documentation-only change. I verified the changed file with:

git diff --check
rg -n "dev container configuration|GitHub Codespaces|VS Code detects" documentation/general/general_setup.md

I did not run the full documentation build because this local environment does not have the project's pdm or just tooling installed.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • [N/A] I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • [N/A] I ran the DAG documentation generator (ov just catalog/generate-docs for catalog
    PRs) or the media properties generator (ov just catalog/generate-docs media-props
    for the catalog or ov just api/generate-docs for the API) where applicable.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700, San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Signed-off-by: zhouzhou626 <255877794+zhouzhou626@users.noreply.github.com>
@zhouzhou626 zhouzhou626 requested a review from a team as a code owner May 19, 2026 21:06
@zhouzhou626 zhouzhou626 requested review from dhruvkb and krysal and removed request for a team May 19, 2026 21:06
@openverse-bot openverse-bot added 🧱 stack: documentation Related to Sphinx documentation 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 📄 aspect: text Concerns the textual material in the repository labels May 19, 2026
@openverse-bot openverse-bot moved this to 👀 Needs Review in Openverse PRs May 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: documentation Related to Sphinx documentation

Projects

Status: 👀 Needs Review

Development

Successfully merging this pull request may close these issues.

Add guidance regarding devcontainer configuration's intended scope to the getting started documentation

2 participants