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

Improve documentation about usage of flags in config file with latest flags #20

Closed
galenatjpl opened this issue Jun 25, 2019 · 0 comments · Fixed by #94
Closed

Improve documentation about usage of flags in config file with latest flags #20

galenatjpl opened this issue Jun 25, 2019 · 0 comments · Fixed by #94
Assignees
@danyu-pds
Labels
enhancement New feature or request
Milestone
PDS.25 (ends 2019...

Comments

@galenatjpl
Copy link
Contributor

galenatjpl commented Jun 25, 2019 •
edited

There was some confusion, understandably, by the InSight team, in how to use command-line flags in the configuration file approach.

It's not clear that options in the config file should be in the format:
<option_name> = true

to enable them.

The documentation here:
https://nasa-pds-incubator.github.io/validate/operate/index.html

Should be updated with an example of a flag option.
For example, the validate.noDataCheck option.

The proper usage would be:
validate.noDataCheck = true

See also #4 for additional doc updates
@jordanpadams jordanpadams assigned danyu-pds and hhlee445 and unassigned hhlee445 and danyu-pds Jul 11, 2019
danyu-pds pushed a commit that referenced this issue Sep 11, 2019
issue #20: Improve documentation about usage of flags in config file
d103f54 
Modified index.xml.vm.

The table describes the command-line options available.
	Added new options:
		--add-context-products
		--skip-context-validation
		-u,--update-context-products	

The table contains valid keywords that can be specified in the
configuration file.
	Added new column "Property Value"
	Added new properties:
		validate.updateContextProducts
		validate.addContextProducts
		validate.skipContextValidation
@jordanpadams jordanpadams changed the title Improve documentation about usage of flags in config file Improve documentation about usage of flags in config file with latest flags Sep 13, 2019
@danyu-pds danyu-pds mentioned this issue Sep 13, 2019
Merged
jordanpadams pushed a commit that referenced this issue Sep 13, 2019
@danyu-pds @jordanpadams
issue #20: Improve documentation about usage of flags in config file (#…
a8d2232 
…94)

Modified index.xml.vm.

The table describes the command-line options available.
	Added new options:
		--add-context-products
		--skip-context-validation
		-u,--update-context-products	

The table contains valid keywords that can be specified in the
configuration file.
	Added new column "Property Value"
	Added new properties:
		validate.updateContextProducts
		validate.addContextProducts
		validate.skipContextValidation
@jordanpadams jordanpadams added the enhancement New feature or request label Oct 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@danyu-pds danyu-pds

Labels
enhancement New feature or request
Projects
None yet
Milestone
PDS.25 (ends 2019-09-11)
Development

Successfully merging a pull request may close this issue.

issue #20: Improve documentation about usage of flags in config file NASA-PDS/validate
4 participants
@jordanpadams @galenatjpl @hhlee445 @danyu-pds