-
Notifications
You must be signed in to change notification settings - Fork 661
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
Dev setup precision to use devcontainer #1914
Conversation
Signed-off-by: Guillaume Bourque <[email protected]>
Add devcontainer info Signed-off-by: Guillaume Bourque <[email protected]>
I'd recommend getting rid of the whole |
Signed-off-by: Guillaume Bourque <[email protected]>
@WadeBarnes, done like proposed. Guillaume |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great. However the ./docs/source/setup-dev.md
, which is referenced on the main page, still contains references to the dev-setup
folder as well as instructions on how to set up a bare metal development environment manually. That document could be deleted and the relevant content about using the dev container moved out to the How to Start Working with the Code
section of the main README.
@WadeBarnes I would keep the file since the python instructions are still relevant and it make the main README.md file bigger If I bring back what was in the setup-dev.md. Since we already have a seperate file I propose to only delete part refering to the code that is not maintain anymore. |
Signed-off-by: Guillaume Bourque <[email protected]>
If there are still manual development environment setup steps that are relevant, I'd suggest those steps be incorporated into the dev container setup so everyone has a consistent development environment. However in this case I'd argue the python virtual environment is more relevant to a bare metal setup where the user is more likely to have a conflicting version of python installed. The dev container sets up the version of python supported by the corresponding version of Ubuntu and code, and it's already a virtual environment. |
Signed-off-by: Guillaume Bourque <[email protected]>
Signed-off-by: Guillaume Bourque <[email protected]>
In reference to this request Remove obsolete dev-setup documentation #1908