Skip to content

docs: update build instructions#3676

Merged
reubenmiller merged 1 commit intothin-edge:mainfrom
reubenmiller:docs-update-build-instructions
Jun 13, 2025
Merged

docs: update build instructions#3676
reubenmiller merged 1 commit intothin-edge:mainfrom
reubenmiller:docs-update-build-instructions

Conversation

@reubenmiller
Copy link
Copy Markdown
Contributor

Proposed changes

Update the build instructions in the contribution guide in the public docs.

Note: The reference to how to run the system tests is currently not mentioned for the moment due to being a bit more complicated to setup (and has additional requirements such as docker).

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s. You can activate automatic signing by running just prepare-dev once)
  • I ran just format as mentioned in CODING_GUIDELINES
  • I used just check as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

Signed-off-by: reubenmiller <reuben.d.miller@gmail.com>
@reubenmiller reubenmiller temporarily deployed to Test Pull Request June 10, 2025 12:36 — with GitHub Actions Inactive
@reubenmiller reubenmiller added documentation Improvements or additions to documentation theme:developer-exp Theme: improve developer experience labels Jun 10, 2025
@codecov
Copy link
Copy Markdown

codecov bot commented Jun 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

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

Approved

* Ubuntu 20.04 or Debian 12 (Bookworm)
* One of the following Operating Systems
* Linux (we recommend using either Debian or Ubuntu)
* WSL 2 (Windows Subsystem for Linux)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This has been a while I have not try to build %%te%% on WSL. Is this still working? Not sure.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Modern WSL2 environments can be treated like Linux (default is Ubuntu)...they also switched to using systemd as the init manager a few years ago.

Copy link
Copy Markdown
Contributor Author

@reubenmiller reubenmiller Jun 13, 2025

Choose a reason for hiding this comment

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

And you can treat it as a standard linux environment because you can work 100% within the environment, and avoid the non-performant stuff like the shared folder mess in WSL2....so you can clone the project directly in WSL2 environment rather than trying to share files between the Windows and Linux world (as that general comes with a costly performance hit, especially if you're talking about containers)

@github-actions
Copy link
Copy Markdown
Contributor

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
641 0 3 641 100 1h49m12.722435s

@reubenmiller reubenmiller added this pull request to the merge queue Jun 13, 2025
Merged via the queue into thin-edge:main with commit 28679a0 Jun 13, 2025
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation theme:developer-exp Theme: improve developer experience

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants