Skip to content

docs: clarify dev container scope #5581

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zhouzhou626 wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −0
Open

docs: clarify dev container scope #5581

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions documentation/general/general_setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ is the only supported method of working with Openverse. `ov` is included in the
repository, and its only dependencies are git, bash, and Docker (or a compatible
container runtime).

```{note}
If VS Code detects `.devcontainer/devcontainer.json` and offers to reopen the
repository in a dev container, do not use that prompt for local setup. The
dev container configuration is only intended and tested for GitHub Codespaces,
and only for frontend and documentation contributions. For local development,
follow this guide and use `ov` directly from your clone.
```

```{admonition} Openverse and Windows
:class: caution
Openverse development is currently supported only for UNIX-type environments
Expand Down
Loading