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: Add docs for Codespaces #52

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

doc: Add docs for Codespaces #52

wants to merge 4 commits into from

Conversation

ncvescera
Copy link
Collaborator

Added a subsection of 'Setup for a project' named 'Run inside GihHub Codespaces' in where is explained how to setup the devcontainer inside a GitHub Codespace.

Fix #51

Added a subsection of 'Setup for a project' named 'Run inside GihHub Codespaces'
in where is explained how to setup the devcontainer inside a GitHub Codespace.

Fix #51
@ncvescera ncvescera added the documentation Improvements or additions to documentation label May 10, 2023
@ncvescera ncvescera requested a review from qdm12 May 10, 2023 13:59
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
ncvescera and others added 3 commits May 20, 2023 16:29
Fixed a typo inside 'Run inside GitHub Codespaces' section

Co-authored-by: Quentin McGaw <quentin.mcgaw@gmail.com>
Co-authored-by: Quentin McGaw <quentin.mcgaw@gmail.com>
Co-authored-by: Quentin McGaw <quentin.mcgaw@gmail.com>
@ncvescera ncvescera requested a review from qdm12 May 20, 2023 14:45
Comment on lines +76 to +77
# Docker socket to access Docker server
- /var/run/docker.sock:/var/run/docker.sock
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this one be commented as well for codespaces?

Comment on lines +79 to +90
- - ~/.ssh:/root/.ssh
+ # - ~/.ssh:/root/.ssh
# For Windows without WSL, a copy will be made
# from /tmp/.ssh to ~/.ssh to fix permissions
- - ~/.ssh:/tmp/.ssh:ro
+ # - ~/.ssh:/tmp/.ssh:ro
# Shell history persistence
- - ~/.zsh_history:/root/.zsh_history:z
+ # - ~/.zsh_history:/root/.zsh_history:z
# Git config
- - ~/.gitconfig:/root/.gitconfig
+ # - ~/.gitconfig:/root/.gitconfig
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually thinking more about this, should we flip this around?

Comment them in .devcontainer/docker-compose.yml and not have this section in the readme?
That would make more sense I think.

I'll see what I can do with https://github.com/qdm12/devtainr as well so it can uncomment those fields when setting up a repo 😉 Created qdm12/devtainr#68

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

container build failed !
2 participants