Remove devcontainers #1411
Merged
Remove devcontainers #1411
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tinahollygb
reviewed
Jun 28, 2023
Comment on lines
-9
to
-13
| The fastest way to start contributing to GrowthBook is by using our pre configured devcontainer. A dev container is a Docker container that is specifically configured to provide a full-featured development environment. | ||
|
|
||
| 1. Install the vscode extension [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). Launch VS code Quick Open `Ctrl + P` then paste the following command `ext install ms-vscode-remote.remote-containers` and press enter. | ||
| 2. If you do not have Docker installed follow these instructions [Docker](https://docs.docker.com/engine/install/) | ||
| 3. Open the Command Palette `Ctrl + Shift + P` then paste the following command `Remote-Containers: Reopen in Container` and press enter. |
There was a problem hiding this comment.
Is there other quick start docs we can add instead?
There was a problem hiding this comment.
I think the full directions are quick enough. Or at least we can't get any quicker unless we actually get the dev container working.
jdorn
approved these changes
Jul 3, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Features and Changes
We recommended at the top of our CONTRIBUTING.md that people do the quickstart of using dev containers. Unfortunately dev containers doesn't work out of the box right now. The are reports that it was slow to use when it was working. It is a good idea in principle, but until we get it working out of the box we shouldn't be recommending it to people as they might waste their time getting it working.
I also removed it from the code base so that VScode doesn't ask people if they want to use it. Once someone gets this working someday they can add this back in again.
For those looking to one day resurrect this, the main issue seems to be that the VARIANT arg in docker-compose.yml doesn't seem to be respected and it ends up using 20-bullseye instead. Mongo doesn't seem to be available in bullseye from the same location so the build was dying there. Also our app doesn't build correctly with node v20 and really needs to be 16.
Testing
Restart VScode and see it not show a bubble about reopening in remote container.