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.

Sign up for GitHub

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

Jump to bottom

Doc: add job definition schema and how-to guides #143

Merged
merged 5 commits into from
Nov 30, 2023
Merged

Doc: add job definition schema and how-to guides #143

merged 5 commits into from
Nov 30, 2023

Conversation

tang-mm
Copy link
Contributor

@tang-mm tang-mm commented Oct 26, 2023 •
edited by jira bot
Loading

Description

Added a reference doc describing the job schema and a couple of how-to guides, including:

  • Install Testflinger CLI
  • Connect to a different server
  • Submit a job (with link to the job schema)
  • Cancel a job

Resolved issues

Resolves CERTTF-96

Documentation

Preview version on Readthedocs:

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 requested a review from a team October 26, 2023 06:44
@tang-mm tang-mm added the documentation Improvements or additions to documentation label Oct 26, 2023
@tang-mm tang-mm mentioned this pull request Oct 27, 2023
Merged
plars
plars requested changes Oct 27, 2023
View reviewed changes
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.

Lots of good stuff here, thanks! A few comments below.

docs/reference/job-schema.rst Show resolved Hide resolved
docs/reference/job-schema.rst Outdated Show resolved Hide resolved
docs/reference/job-schema.rst Outdated Show resolved Hide resolved
kevinyehk
kevinyehk reviewed Nov 3, 2023
View reviewed changes
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.

Just have a minor suggestion.

docs/reference/job-schema.rst Outdated Show resolved Hide resolved
plars
plars requested changes Nov 16, 2023
View reviewed changes
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.

Thanks for adding the default column, I think that will be really nice! I noticed one other change here though, which I'm concerned about. Details below...

docs/reference/job-schema.rst Outdated Show resolved Hide resolved
@tang-mm tang-mm requested review from plars and kevinyehk November 17, 2023 12:41
plars
plars requested changes Nov 17, 2023
View reviewed changes
docs/reference/job-schema.rst Outdated Show resolved Hide resolved
@tang-mm tang-mm requested a review from plars November 27, 2023 13:32
plars
plars approved these changes Nov 29, 2023
View reviewed changes
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.

+1

@tang-mm tang-mm merged commit c79d645 into main Nov 30, 2023
3 checks passed
@tang-mm tang-mm deleted the doc-add-howto branch November 30, 2023 02:23
plars pushed a commit that referenced this pull request Dec 1, 2023
@tang-mm @plars
Doc: add job definition schema and how-to guides (#143)
7ffbd59 
* Doc: add job definition and how-to guides

* address comments

* update device type in job example

* update job name in example

* resolve conflict
nancyc12 pushed a commit that referenced this pull request Dec 29, 2023
@tang-mm @nancyc12
Doc: add job definition schema and how-to guides (#143)
499405a 
* Doc: add job definition and how-to guides

* address comments

* update device type in job example

* update job name in example

* resolve conflict
nancyc12 pushed a commit that referenced this pull request Dec 29, 2023
@tang-mm @nancyc12
Doc: add job definition schema and how-to guides (#143)
c920e85 
* Doc: add job definition and how-to guides

* address comments

* update device type in job example

* update job name in example

* resolve conflict
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@plars plars plars approved these changes

@kevinyehk kevinyehk Awaiting requested review from kevinyehk

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation Libraries: Out of sync
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tang-mm @plars @kevinyehk