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

buildtest command line tutorial #1353

Merged
merged 6 commits into from
Jan 30, 2023
Merged

Conversation

shahzebsiddiqui
Copy link
Member

@shahzebsiddiqui shahzebsiddiqui commented Jan 24, 2023

This PR is going to add the buildtest command line tutorial The page is rendered see https://buildtest--1353.org.readthedocs.build/en/1353/command_line_tutorial.html

@prathmesh4321 @Xiangs18 @jscook2345 can you please review and provide feedback.

@shahzebsiddiqui shahzebsiddiqui self-assigned this Jan 24, 2023
@shahzebsiddiqui shahzebsiddiqui added the documentation documentation fix label Jan 24, 2023
@codecov
Copy link

codecov bot commented Jan 24, 2023

Codecov Report

Base: 71.03% // Head: 70.68% // Decreases project coverage by -0.35% ⚠️

Coverage data is based on head (fb012cc) compared to base (a3bc4fa).
Patch has no changes to coverable lines.

❗ Current head fb012cc differs from pull request most recent head 87319a6. Consider uploading reports for the commit 87319a6 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##            devel    #1353      +/-   ##
==========================================
- Coverage   71.03%   70.68%   -0.35%     
==========================================
  Files          57       57              
  Lines        6131     6163      +32     
  Branches     1090     1096       +6     
==========================================
+ Hits         4355     4356       +1     
- Misses       1774     1805      +31     
  Partials        2        2              
Impacted Files Coverage Δ
buildtest/buildsystem/checks.py 7.00% <0.00%> (-0.48%) ⬇️
buildtest/builders/base.py 56.75% <0.00%> (-0.34%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Collaborator

@prathmesh4321 prathmesh4321 left a comment

Choose a reason for hiding this comment

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

@shahzebsiddiqui I think we should have a dropdown for other commands mentioned in this tutorial as well just so that it looks consistent.

docs/command_line_tutorial.rst Outdated Show resolved Hide resolved
docs/command_line_tutorial.rst Outdated Show resolved Hide resolved
docs/command_line_tutorial.rst Outdated Show resolved Hide resolved
docs/command_line_tutorial.rst Outdated Show resolved Hide resolved
docs/command_line_tutorial.rst Outdated Show resolved Hide resolved
@shahzebsiddiqui
Copy link
Member Author

shahzebsiddiqui commented Jan 27, 2023

@shahzebsiddiqui I think we should have a dropdown for other commands mentioned in this tutorial as well just so that it looks consistent.

Do you mean for every command. The drop-down was there for some commands followed by command-output which will actually run the command and show the output. I didnt want to run every command and show output in the tutorial since that would cause every command to be run during documentation build and the purpose of the tutorial was to have user run the command with a simple copy-paste for the most part.

@shahzebsiddiqui I think we should have a dropdown for other commands mentioned in this tutorial as well just so that it looks consistent.

@shahzebsiddiqui I think we should have a dropdown for other commands mentioned in this tutorial as well just so that it looks consistent.

@prathmesh4321
Copy link
Collaborator

@shahzebsiddiqui I think we should have a dropdown for other commands mentioned in this tutorial as well just so that it looks consistent.

Do you mean for every command. The drop-down was there for some commands followed by command-output which will actually run the command and show the output. I didnt want to run every command and show output in the tutorial since that would cause every command to be run during documentation build and the purpose of the tutorial was to have user run the command with a simple copy-paste for the most part.

@shahzebsiddiqui I think we should have a dropdown for other commands mentioned in this tutorial as well just so that it looks consistent.

@shahzebsiddiqui I think we should have a dropdown for other commands mentioned in this tutorial as well just so that it looks consistent.

Okay that makes sense got it !

@shahzebsiddiqui
Copy link
Member Author

@prathmesh4321 @Xiangs18 @jscook2345 do you think this content looks okay? i'd like to have this available as part of the buildtest 1.2 release scheduled for Feb 6th

@shahzebsiddiqui shahzebsiddiqui merged commit f26639a into devel Jan 30, 2023
@shahzebsiddiqui shahzebsiddiqui deleted the buildtest_cli_tutorial branch January 30, 2023 23:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation documentation fix size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants