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.

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

'Help'/'Support' Section in Validator #76

Closed
cmrn-rhi opened this issue Jun 22, 2020 · 5 comments · Fixed by #88
Closed

'Help'/'Support' Section in Validator #76

cmrn-rhi opened this issue Jun 22, 2020 · 5 comments · Fixed by #88
Labels
enhancement New feature or request

Comments

@cmrn-rhi
Copy link
Member

This may have been discussed in the past (my apologies if I touch on things that have already been addressed) but can he include a 'help'/'support' section that directs the users to:

  • The SOP
  • Where to make issue/term requests (either linking to GitHub Issues or to a curator email)

There is now a published version of the SOP that we can link too (it will update every time we edit the SOP gdoc), but perhaps we should also have a pdf copy that users can use if they are offline? That latter would certainly require more maintenance - we could include a note at the top that it may not be the latest version and to go to the published version if possible.

@cmrn-rhi
Copy link
Member Author

I see that there is a pdf version of the SOP - so ignore that recommendation (although perhaps we should still add the published link somewhere).

@ivansg44 ivansg44 added the enhancement New feature or request label Jun 22, 2020
@ivansg44
Copy link
Collaborator

Another thing to add to this menu is a link to the reference guide.

@cmrn-rhi
Copy link
Member Author

@ivansg44 Is there a separate reference guide outside of the SOP and in-validator field guidance?

@ivansg44
Copy link
Collaborator

reference.html in the root directory courtesy of @ddooley

@ddooley
Copy link
Collaborator

ddooley commented Jun 24, 2020

Yes, the reference.html is automatically generated version of the label / definition / guidance and examples fields of the vocabulary. It differs from SOP but could be linked from there too.

@ivansg44 ivansg44 mentioned this issue Jul 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants