Skip to content

Conversation

@WadeWaldron
Copy link
Contributor

@WadeWaldron WadeWaldron commented Oct 11, 2024

Description

Enter your description here.

Checklist

  • Unit tests created/updated for any new code (where applicable).
  • Run all tests with ./build.sh validate.
  • Update the CHANGELOG.md.
  • Update the README.md if necessary.

@WadeWaldron WadeWaldron requested a review from a team as a code owner October 11, 2024 17:57
@confluent-cla-assistant
Copy link

🎉 All Contributor License Agreements have been signed. Ready to merge.
Please push an empty commit if you would like to re-run the checks to verify CLA status for all contributors.

Copy link

@alpinegizmo alpinegizmo left a comment

Choose a reason for hiding this comment

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

I got a bit stuck until I figured out that I needed to install the dev containers extension for VS Code. Once I did that, it seemed to work -- but it's not immediately clear what this accomplished, or what the value is.

I'm also getting an error about the table planner being missing.

README.md Outdated

This repo contains a [.devcontainer.json](.devcontainer.json) file.

If you are using a Development Container compatible IDE (Eg. VS Code, IntelliJ Ultimate) and have Docker running, you can use the `.devcontainer.json` file to automatically configure your development environment with the required settings.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
If you are using a Development Container compatible IDE (Eg. VS Code, IntelliJ Ultimate) and have Docker running, you can use the `.devcontainer.json` file to automatically configure your development environment with the required settings.
If you are using a Development Container compatible IDE (Eg. VS Code, IntelliJ Ultimate) and have Docker running, you can use the `.devcontainer.json` file to automatically configure your development environment with the required settings. This includes automatically setting up the correct version of the JVM, installing Maven, and potentially configuring your IDE with any required plugins. It will give you a fully functional development environment in moments.

README.md Outdated

Depending on what IDE you are using, the process can vary.

In VS Code, open the folder that contains the `.devcontainer.json` file. When prompted, re-open it in the container.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
In VS Code, open the folder that contains the `.devcontainer.json` file. When prompted, re-open it in the container.
In VS Code, open the folder that contains the `.devcontainer.json` file. When prompted, re-open it in the container. Please note that you may need to install the Dev Containers plugin for VS Code prior to opening.

@WadeWaldron
Copy link
Contributor Author

@alpinegizmo

I got a bit stuck until I figured out that I needed to install the dev containers extension for VS Code. Once I did that, it seemed to work -- but it's not immediately clear what this accomplished, or what the value is.

Added a bit more detail in the README to help clarify. However, to some extent, this is on the user. I provide the Dev Container as an option for them to use if they want to. They are not required to use it, and I'm not going to spend a bunch of time teaching it. It's sort of like including a Docker image. I wouldn't teach them about Docker. I'd expect them to already understand it.

I'm also getting an error about the table planner being missing.

No idea what is going on there. Have you tried a fresh checkout of the repo? I have done a fresh checkout and used my existing checkout. Both of them seem to work just fine.

Copy link

@alpinegizmo alpinegizmo left a comment

Choose a reason for hiding this comment

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

Thanks for the additions to the README!

@WadeWaldron WadeWaldron merged commit 39d6781 into main Oct 30, 2024
1 check passed
@WadeWaldron WadeWaldron deleted the dev-container branch October 30, 2024 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants