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

add reference docs for device type and job examples #112

Closed
wants to merge 3 commits into from

Conversation

tang-mm
Copy link
Contributor

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

Add doc for Supported Provisioning methods and example definition
(moved from https://github.com/canonical/certification-lab-docs/tree/main/reference)

@tang-mm tang-mm requested a review from a team October 12, 2023 06:33
@@ -0,0 +1,74 @@
Provisioning Methods
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think only this file actually really belongs in the testflinger docs as a reference, the others are a straightforward fit to Library.

This indeed should also be a reference so that there's an example configuration included (and a hello-world type payload at the top of the file indicating where the choice of the provisioning method goes?)

@mz2
Copy link
Collaborator

mz2 commented Oct 12, 2023

I think this should effectively be split in two: you have a short reference section there needed into this repo, but most of this should move into Library. When you make this move, please also make an associated removal at the other end (or link in those docs where the current location of the up to date copy is).

@nancyc12 nancyc12 mentioned this pull request Oct 13, 2023
7 tasks
@tang-mm tang-mm force-pushed the doc-add-reference branch 2 times, most recently from ad8b0f7 to df025c9 Compare October 13, 2023 10:48
@tang-mm
Copy link
Contributor Author

tang-mm commented Oct 13, 2023

Updated per comments:

  • kept only the provisioning reference doc
  • added examples for provision_data fiedl

@tang-mm tang-mm requested review from jocave and mz2 October 13, 2023 10:55
docs/reference/provisioning-methods.rst Outdated Show resolved Hide resolved
@tang-mm tang-mm requested a review from jocave October 25, 2023 04:54
@tang-mm tang-mm added the documentation Improvements or additions to documentation label Oct 26, 2023
@tang-mm
Copy link
Contributor Author

tang-mm commented Nov 30, 2023

Closed as some contents were covered by #113

@tang-mm tang-mm closed this Nov 30, 2023
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 Libraries: Out of sync
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants