-
Notifications
You must be signed in to change notification settings - Fork 20
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
Conversation
There was a problem hiding this 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.
There was a problem hiding this 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.
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 :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM +1
2497e49
to
c3497ac
Compare
Description
Added a basic tutorial for first-time end users, covering:
(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: