Skip to content
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.

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

[DOC]: Expand .devcontainer/README.md with instructions for WSL #524

Closed
1 task done
jrhemstad opened this issue Oct 5, 2023 · 2 comments · Fixed by #1394
Closed
1 task done

[DOC]: Expand .devcontainer/README.md with instructions for WSL #524

jrhemstad opened this issue Oct 5, 2023 · 2 comments · Fixed by #1394
Assignees
Labels
doc Documentation-related items.

Comments

@jrhemstad
Copy link
Collaborator

Is this a duplicate?

Is this for new documentation, or an update to existing docs?

New

Describe the incorrect/future/missing documentation

As a Windows developer that would like to leverage CCCL's Linux devcontainers with WSL, I'd like to have clear documentation on how to get started. We should defer to our Linux devcontainer documentation as much as possible and just provide guidance on anything unique to WSL.

These instructions should:

  • List any prerequisites
  • Provide a reference to how to install the appropriate version of WSL
  • Provide instruction on how to use VSCode w/ devcontainer running in WSL

The end goal is that a technically competent person who may have never used WSL or VScode before should be able to follow these instructions to the point where they can build and run CCCL's tests on a Windows machine in WSL.

If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.

No response

@jrhemstad jrhemstad added the doc Documentation-related items. label Oct 5, 2023
@jrhemstad
Copy link
Collaborator Author

@miscco @allisonvacanti @wmaxey since all of you work natively in Windows and use WSL with our devcontainers already, would one of you be willing to take this on?

@jrhemstad
Copy link
Collaborator Author

@gonidelis will be working on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation-related items.
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants