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

Add Visual Studio Code Development Container #8016

Merged
merged 5 commits into from Feb 20, 2020

Conversation

@MarkBennett
Copy link
Contributor

MarkBennett commented Feb 20, 2020

Summary

Add files to create a Visual Studio Code development container which can be used to quickly get new contributors up and building the app. To use this you need to have Visual Studio Code and the Remote Development Extension Pack installed.

The development environment includes gcc, ruby, and nodejs. I've verified that script/cibuild runs without errors. I've also added a section to the installation page describing how to setup VS Code to use this environment.

From start to finish setting up a new development box is entirely automatic and takes about 5 minutes. Once you're done you can open a new terminal in the development container using the same shortcut keys as you would when using VS Code normally.

The editor files are all in /.devcontainter directory which can be ignored by other editors and team members.

Context

I haven't been able to find any issues related to this, but please add them if I missed them.

Mark Bennett added 4 commits Feb 20, 2020
It's ignored if you're not using VS Code, but makes setting up a new box much faster.
Mark Bennett
@MarkBennett MarkBennett changed the title Add vs code devcontainer Add Visual Studio Code Development Container Feb 20, 2020
@ashmaroli

This comment has been minimized.

Copy link
Member

ashmaroli commented Feb 20, 2020

Technically, this is not a documentation change. It is an enhancement to the repository's development workflow.

@MarkBennett

This comment has been minimized.

Copy link
Contributor Author

MarkBennett commented Feb 20, 2020

Technically, this is not a documentation change. It is an enhancement to the repository's development workflow.

Ok. I wasn't sure so flagged it as both. Thanks @ashmaroli.

Copy link
Member

mattr- left a comment

I'm not really sure how I feel about this. We provide zero help to people using other editors and I honestly wish we could decouple the actual code base from it's development environment and avoid the question of editor preference all together.

.devcontainer/Dockerfile Show resolved Hide resolved
@mattr- mattr- self-assigned this Feb 20, 2020
@MarkBennett

This comment has been minimized.

Copy link
Contributor Author

MarkBennett commented Feb 20, 2020

I'm not really sure how I feel about this. We provide zero help to people using other editors and I honestly wish we could decouple the actual code base from it's development environment and avoid the question of editor preference all together.

Fair point, on other projects I've worked on it's usually an all or nothing approach. I couldn't find anything specific about adding editor configuration in other issues, but it might be worth adding that to the docs for future if it's decided to keep them out.

Just sharing as I found it useful for me.

@ashmaroli

This comment has been minimized.

Copy link
Member

ashmaroli commented Feb 20, 2020

Please move the information added to the docs/_docs/installation.md to
docs/_docs/contributing.md instead since that info has nothing to do with how Jekyll is to be installed / used.

@ashmaroli ashmaroli added the internal label Feb 20, 2020
Mark Bennett
Per review from @ashmaroli.

#8016 (comment)
@MarkBennett

This comment has been minimized.

Copy link
Contributor Author

MarkBennett commented Feb 20, 2020

Please move the information added to the docs/_docs/installation.md to
docs/_docs/contributing.md instead since that info has nothing to do with how Jekyll is to be installed / used.

Docs moved @ashmori. Thanks for the feedback.

@mattr-
mattr- approved these changes Feb 20, 2020
Copy link
Member

mattr- left a comment

After thinking about this more, I don't think we should hold back from providing good editor support. It'll just be up to everybody to submit PRs for their chosen editor.

@mattr-

This comment has been minimized.

Copy link
Member

mattr- commented Feb 20, 2020

@jekyllbot: merge +dev

@jekyllbot jekyllbot merged commit 9739246 into jekyll:master Feb 20, 2020
7 checks passed
7 checks passed
SUITE: test / OS: ubuntu-latest
Details
SUITE: test / OS: windows-latest
Details
SUITE: default-site / OS: ubuntu-latest
Details
SUITE: default-site / OS: windows-latest
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
netlify/jekyllrb/deploy-preview Deploy preview ready!
Details
@jekyllbot jekyllbot added the fix label Feb 20, 2020
jekyllbot added a commit that referenced this pull request Feb 20, 2020
@MarkBennett

This comment has been minimized.

Copy link
Contributor Author

MarkBennett commented Feb 20, 2020

Awesome! Thanks for the quick reviews @mattr- and @ashmaroli! :)

@ashmaroli

This comment has been minimized.

Copy link
Member

ashmaroli commented Feb 20, 2020

You're welcome @MarkBennett

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
You can’t perform that action at this time.