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 test phase reference #134

Merged
merged 1 commit into from
Oct 23, 2023
Merged

Doc: add test phase reference #134

merged 1 commit into from
Oct 23, 2023

Conversation

tang-mm
Copy link
Contributor

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

Description

Add a topic describing all the test phases that a job can go through, with configuration requirements and examples provided.
Also include the firmware_update phase introduced by #114 .

(This PR depends on #113, otherwise, the doc build will fail.)

Resolved issues

Resolves CERTTF-255

Documentation

Preview on Readthedocs: /doc-preview/reference/test-phases

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 review from plars and nancyc12 October 19, 2023 09:42
plars
plars approved these changes Oct 20, 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 2dd9739 into doc-add-ref-config Oct 23, 2023
@tang-mm tang-mm deleted the doc-test-phase branch October 23, 2023 01:56
This was referenced Oct 24, 2023
Closed
Merged
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

@nancyc12 nancyc12 Awaiting requested review from nancyc12

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

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