Added Usage Examples as new subtoctree #748
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: DarikshaAnsari <img_2021021@iiitm.ac.in>
|
@adityasaky @lukpueh PTAL !! |
|
Cool, thanks! And btw, here's a preview of the RTD build: https://in-toto--748.org.readthedocs.build/en/748/examples.html# |
lukpueh
requested changes
May 16, 2024
There was a problem hiding this comment.
Wow, this looks very nice! I have a few high-level comments:
- Please reverse the order of "layout creation example" and "parameter substitution". IMO the basic example should come before the more specific example.
- The "Example Usage" under "Using Substitution in Inspections" actually shows Steps. This needs to be changed.
- I think it would be useful to mention all fields in the layout that support substitution (see
verifylib.substitute_parameters). We don't need to show an example for each. - It might be helpful to point out how substitution parameters can be passed to the verification API
Signed-off-by: Dariksha <img_2021021@iiitm.ac.in>
ping |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
**Fixes issue #414 **:
Added Examples section: Introduced a new section titled "Useage Examples" to showcase practical use cases of in-toto, including parameter substitution and layout creation.
Parameter Substitution: Expanded the subsection on parameter substitution to provide detailed examples of its usage in steps and inspections.
Layout Creation Example: Added a new subsection demonstrating how to create a supply chain layout using in-toto's model classes and convenience methods.