Skip to content

Need callout that working_dir is important when authoring artifact tasks code #1267

@jkglasbrenner

Description

@jkglasbrenner

Describe the documentation issue

The tutorial explaining how to author an artifact task in a plugin does not mention that all paths should be relative to the working directory. The working directory is passed in as the working_dir argument in both serialization and deserialization methods. Not constructing paths using working_dir as a base can lead to unexpected behaviors where an artifact fails to load, but it's unclear why.

Section of Documentation

This is where it would be appropriate to callout and explain the importance of using working_dir in the serialize and deserialize methods: https://pages.nist.gov/dioptra/tutorials/essential_workflows/part-5.html#step-1-create-an-artifact-plugin.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationAdditions or changes related to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions