Skip to content

doc: notes for sdk installation in shared environments #81615

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

Conversation

cfriedt
Copy link
Member

@cfriedt cfriedt commented Nov 19, 2024

  • doc: getting_started: add anchor for installing the zephyr sdk
  • doc: zephyr_sdk: install notes for sdk, venv in shared env
  • doc: zephyr_sdk: notes for sdk package managers

Doc Preview

@cfriedt cfriedt force-pushed the doc-zephyr-setup-in-multi-user-environments branch from 6814414 to b0697dd Compare November 19, 2024 17:58
@cfriedt cfriedt changed the title doc: getting_started: add anchor for installing the zephyr sdk doc: beyond-gsg: notes for sdk installation in multi-user environment Nov 19, 2024
@cfriedt

This comment has been minimized.

@cfriedt cfriedt force-pushed the doc-zephyr-setup-in-multi-user-environments branch 2 times, most recently from d2a53b3 to 8cc69b3 Compare January 1, 2025 20:11
@cfriedt cfriedt requested a review from stephanosio January 1, 2025 20:12
@cfriedt cfriedt force-pushed the doc-zephyr-setup-in-multi-user-environments branch from 8cc69b3 to 703fed9 Compare January 1, 2025 20:14
@cfriedt cfriedt requested a review from ycsin January 1, 2025 20:14
@cfriedt cfriedt changed the title doc: beyond-gsg: notes for sdk installation in multi-user environment doc: notes for sdk installation in shared environments Jan 1, 2025
@cfriedt cfriedt marked this pull request as ready for review January 1, 2025 21:25
@zephyrbot zephyrbot requested review from carlescufi and nashif January 1, 2025 21:26
ycsin
ycsin previously approved these changes Jan 2, 2025
@cfriedt
Copy link
Member Author

cfriedt commented Jan 22, 2025

@kartben @stephanosio - Please take a look again when you have some time.

@cfriedt cfriedt force-pushed the doc-zephyr-setup-in-multi-user-environments branch from 703fed9 to daa7461 Compare March 29, 2025 11:56
@cfriedt
Copy link
Member Author

cfriedt commented Mar 29, 2025

@ycsin, @stephanosio, @kartben - please take another look. Docs should be fine. I'm not sure what's up with CI at the moment otherwise.

@cfriedt cfriedt requested a review from ycsin March 29, 2025 12:05
cfriedt added 3 commits March 29, 2025 08:21
Add an anchor for installing the Zephyr SDK in the main page of
the Getting Started Guide.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
In the SDK documentation, add some notes for those who wish to
install the Zephyr SDK and Python virtual environment in shared
or distributed build environments.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
Include notes in the Zephyr SDK doc for those who wish to build
redistributable files for package managers (e.g. APT, RPM).

This does not mean that Zephyr will be responsible for
creating collections of .deb or .rpm packages for the Zephyr SDK.

These are only some guidelines based on previous experience in
that area.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
@cfriedt cfriedt force-pushed the doc-zephyr-setup-in-multi-user-environments branch from daa7461 to edbdec5 Compare March 29, 2025 12:22
Copy link
Collaborator

@kartben kartben left a comment

Choose a reason for hiding this comment

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

Apologies for having completely dropped the ball on this PR
To me these are "tips" that are not really something that belongs to the Zephyr documentation. Maybe something for a blog post?
How to manage python venvs is really out of scope IMO just like we don't have, I don't know, instructions on how to setup a ramdisk to speed up compilation or whatever.

@nashif
Copy link
Member

nashif commented May 28, 2025

Apologies for having completely dropped the ball on this PR
To me these are "tips" that are not really something that belongs to the Zephyr documentation. Maybe something for a blog post?
How to manage python venvs is really out of scope IMO just like we don't have, I don't know, instructions on how to setup a ramdisk to speed up compilation or whatever.

agree, I have loads of tips/tricks and best practices for doing things with zephyr, does not mean they should be part of the docs. Blog is probably an overkill, maybe we could add a section in the wiki for "Best Known Methods (BKM)" where such info can live.

@cfriedt cfriedt closed this May 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants