doc: extend getting_started #1619
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Leonardo Mörlein <git@irrelefant.net>
I was struggeling to understand the config file formats after reading getting_started. Only after a while, I found the documentation about the file formats. Now, getting_started has clear references to the corresponding sections in the configuration page. Signed-off-by: Leonardo Mörlein <git@irrelefant.net>
Signed-off-by: Leonardo Mörlein <git@irrelefant.net>
In this commit, I tried to pick up concepts like "targets", "drivers" and "environment files" from the local example again in the distributed example. This should help the reader put the new concepts in the distributed case into context of what was explained before. This will hopefully make it easier to understand the distributed case in general. Signed-off-by: Leonardo Mörlein <git@irrelefant.net>
Signed-off-by: Leonardo Mörlein <git@irrelefant.net>
Emantor
approved these changes
Feb 21, 2025
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## master #1619 +/- ##
======================================
Coverage 55.8% 55.8%
======================================
Files 170 170
Lines 13380 13380
======================================
Hits 7469 7469
Misses 5911 5911
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Bastian-Krause
approved these changes
Feb 21, 2025
Member
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi,
I just started learning how labgrid works and had some question marks during the process of getting to know labgrid.
While learning, I tried to take some time to add some additional input to the getting_started, which I think would have helped me to understand labgrid faster. I hope that this will help other users in the future.
To make the review process easy, I tried to make small commits out of the changes and explain why the addition makes sense in my eyes in the commit messages.
Cheers,
lemoer