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

tmt, tmt-run, tmt-try: add pages #14921

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

martinhoyer
Copy link

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known): 1.38.0

@CLAassistant
Copy link

CLAassistant commented Nov 20, 2024

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the new command Issues requesting creation of a new page. label Nov 20, 2024
@spageektti spageektti changed the title tmt: add pages tmt*: add pages Nov 20, 2024
Copy link
Member

@gutjuri gutjuri left a comment

Choose a reason for hiding this comment

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

Thanks!


- List available tests, plans, or stories:

`tmt <test|plan|story> ls {{pattern}}`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`tmt <test|plan|story> ls {{pattern}}`
`tmt {{test|plan|story}} ls {{pattern}}`


- Run a test in the current working directory:

`{{cd path/to/test &&}} tmt try`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`{{cd path/to/test &&}} tmt try`
`cd {{path/to/test}} && tmt try`

Copy link
Member

@spageektti spageektti left a comment

Choose a reason for hiding this comment

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

Hi. Thank you so much for your contribution to our project. Welcome to tldr-pages! I left a few suggestions for you.

# tmt run

> Execute tmt test steps. By default, all steps are run.
> See also: `tmt`, `tmt-try`.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> See also: `tmt`, `tmt-try`.

We do not use this syntax to reference other subcommands.

# tmt try

> Quickly experiment with tests and environments.
> See also: `tmt`, `tmt-run`.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> See also: `tmt`, `tmt-run`.

the same as above

# tmt

> Test Management Tool for creating, running and debugging tests.
> See also: `tmt-run`, `tmt-try`.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> See also: `tmt-run`, `tmt-try`.
> Some subcommands such as `run`, `try`, etc. have their own usage documentation.

For subcommand mention we use this syntax:
https://github.com/tldr-pages/tldr/blob/main/contributing-guides/translation-templates/subcommand-mention.md

> See also: `tmt-run`, `tmt-try`.
> More information: <https://tmt.readthedocs.io>.
- Look around to see what's available:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Look around to see what's available:
- List available tests, plans, and stories:


`tmt init`

- Create a new test with template and link:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Create a new test with template and link:
- Create a new test with a template and link:

@@ -0,0 +1,37 @@
# tmt

> Test Management Tool for creating, running and debugging tests.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> Test Management Tool for creating, running and debugging tests.
> Test Management Tool for creating, running, and debugging tests.

https://github.com/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md#serial-comma

> See also: `tmt`, `tmt-run`.
> More information: <https://tmt.readthedocs.io/en/stable/stories/cli.html#try>.
- Quickly experiment with the default provision method (no tests in cwd):
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Quickly experiment with the default provision method (no tests in cwd):
- Quickly experiment with the default provision method (no tests in the CWD):


`tmt run --all execute --how {{tmt}} --interactive`

- Use dry mode to see what actions would happen and use highest verbosity:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Use dry mode to see what actions would happen and use highest verbosity:
- Use dry mode to see what actions would happen and use the highest verbosity:


`tmt run discover -v`

- Run all steps, adjust the provision step options:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Run all steps, adjust the provision step options:
- Run all steps and adjust the provision step options:

@spageektti spageektti changed the title tmt*: add pages tmt, tmt-run, tmt-try: add pages Nov 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants