- 
                Notifications
    You must be signed in to change notification settings 
- Fork 9
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
General changes:
- be expanded to document use cases not currently documented
-  reorganized to reflect the source layout.  Eg, plugins should be documented separately from canary-core
-  document resource set behavior, see Relationship between resource pool and hpc_connect resources #47 .  The documentation should unfold in two parts: canary-coredocs describe the resource pool and how to set it.canary-hpcdescribes howhpc_connecttakes over resource set behavior in batched runs.
Specific changes:
-  User defined test generator modified to reflect .pytis the main file type and that others can be defined in plugins.
-  SubCommand example needs to change emailmethod name toexecute
-  Move Extend canary with pluginsinfo intoextending.rstindex page
-  Move .vvtspecific docs (including directives) intocanary_vvtest
-  Remove .vvtspecific mentions from directives page (they should be moved to vvtest plugin docs)
- add resource pool schema to resource pool docs
- update time resources doc to reflect update API and command line flags
- update config scopes (use bullets to show precedence)
- configuration sections doc needs intro
- add intro to reporting section
- consider removing plain text output for reports and replacing with screenshots
- double check that all plugin hooks are present. better, the plugin hooks docs should be autogenerated
- ctest docs before cmake (more commonly used)
-  getting help: has several subcommands->has many subcommands
- add more examples in the usage section that correspond to directives not documented.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation