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

Document how to use validate-refs tool in Validate Operation User Guide #643

Closed
jordanpadams opened this issue May 11, 2023 · 2 comments · Fixed by #667
Closed

Document how to use validate-refs tool in Validate Operation User Guide #643

jordanpadams opened this issue May 11, 2023 · 2 comments · Fixed by #667
Assignees
@al-niessner
Labels
B14.0 enhancement New feature or request i&t.done p.must-have sprint-backlog

Comments

@jordanpadams
Copy link
Member

💡 Description

Create new Validating References section in Operation User Guide for basic configuration and usage of validate-refs utility.
@jordanpadams jordanpadams mentioned this issue May 11, 2023
Closed
@al-niessner
Copy link
Contributor

@jordanpadams

Starting this term paper and looking for excuses to not do it. The user guide linked in the problem description clearly states:

validate/src/site/xdoc/operate/index.xml.vm

Line 42 in ed9c1de

<p>This document describes how to operate the Validate Tool. The following topics can be found in this document:

Should I add the integrity check as a section of validation with its own table of contents (TOC) as subsections if needed or just make it a standalone TOC section then more sections if and as needed?

@al-niessner al-niessner mentioned this issue May 22, 2023
Closed
@jordanpadams
Copy link
Member Author

@al-niessner +1 on the new TOC section and add that information.

@al-niessner al-niessner mentioned this issue Jun 5, 2023
Open
jordanpadams added a commit that referenced this issue Jun 27, 2023
@jordanpadams
Add documentation for validate-refs
e77f612 
Commit includes:
* Translation of operation documentation to Markdown
* Addition of quick start info for validate-refs utility
* Update to pom and site.xml to support upgrade fluido skin

Refs #643
@jordanpadams jordanpadams mentioned this issue Jun 27, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@al-niessner al-niessner

Labels
B14.0 enhancement New feature or request i&t.done p.must-have sprint-backlog
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add documentation for validate-refs utility and start switch to Markdown docs NASA-PDS/validate
3 participants
@al-niessner @miguelp1986 @jordanpadams