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

Dev setup precision to use devcontainer #1914

Merged
merged 6 commits into from
Feb 24, 2025
Merged

Conversation

bougui
Copy link
Contributor

@bougui bougui commented Feb 19, 2025

In reference to this request Remove obsolete dev-setup documentation #1908

Add devcontainer info

Signed-off-by: Guillaume Bourque <[email protected]>
@WadeBarnes
Copy link
Member

I'd recommend getting rid of the whole dev-setup folder.

@WadeBarnes WadeBarnes added the Ubuntu 22.04 Ubuntu 20.04 Ubuntu 22.04 related activity. label Feb 19, 2025
Signed-off-by: Guillaume Bourque <[email protected]>
@bougui
Copy link
Contributor Author

bougui commented Feb 20, 2025

@WadeBarnes, done like proposed.

Guillaume

Copy link
Member

@WadeBarnes WadeBarnes left a 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.

@bougui
Copy link
Contributor Author

bougui commented Feb 24, 2025

@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.

@bougui bougui requested a review from WadeBarnes February 24, 2025 15:32
@WadeBarnes
Copy link
Member

@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.

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.

@WadeBarnes WadeBarnes merged commit f12dbab into hyperledger:main Feb 24, 2025
8 checks passed
@bougui bougui deleted the dev-setup branch February 24, 2025 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Ubuntu 22.04 Ubuntu 20.04 Ubuntu 22.04 related activity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants