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

Doc: add getting-started tutorial #150

Merged
merged 3 commits into from
Nov 27, 2023
Merged

Doc: add getting-started tutorial #150

merged 3 commits into from
Nov 27, 2023

Conversation

tang-mm
Copy link
Contributor

@tang-mm tang-mm commented Oct 27, 2023

Description

Added a basic tutorial for first-time end users, covering:

  • installing the CLI via Snap
  • configure the default server
  • creating a first job
  • submit job
  • check job status
  • check job output

(This tutorial has some overlap with the how-to guides in #143 , with fewer options and more explanation for new users.)

Resolved issues

Resolves CERTTF-222

Documentation

Preview version on Readthedocs:

https://canonical-testflinger.readthedocs-hosted.com/en/doc-preview/tutorial

Tests

To check the documentation on a local sphinx site:

$ cd testflinger/docs
$ make install
$ make run     # Serve docs on http://127.0.0.1:8000/reference/test-phases/

@tang-mm tang-mm added the documentation Improvements or additions to documentation label Oct 27, 2023
@tang-mm tang-mm requested review from plars and kevinyehk October 27, 2023 13:04
Copy link
Collaborator

@plars plars left a comment

Choose a reason for hiding this comment

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

Those preview links are super-helpful, thanks for including those!
This looks good other than some strange syntax highlighting. I would guess it could either be turned off for those code blocks or changed to some other type of highlighting.

docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@plars plars left a comment

Choose a reason for hiding this comment

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

It looks like the earlier section for testflinger-cli looks fine for me now since you removed "bash", but the later one still had weird highlighting.
image

I found that if I use "text" instead, then it renders fine for me now. I hope you don't mind, I just pushed the change, since it was trivial. And I'm +1 on it now. But I'll let you make the final call :)

@plars plars requested a review from a team November 16, 2023 17:57
Copy link
Contributor

@kevinyehk kevinyehk left a comment

Choose a reason for hiding this comment

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

LGTM +1

@tang-mm tang-mm merged commit fad1598 into main Nov 27, 2023
3 checks passed
@tang-mm tang-mm deleted the doc-get-started branch November 27, 2023 13:37
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants