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

Docs don't mention anything about where to go for support #909

Closed
jamesrhester opened this issue Aug 26, 2021 · 2 comments · Fixed by #911
Closed

Docs don't mention anything about where to go for support #909

jamesrhester opened this issue Aug 26, 2021 · 2 comments · Fixed by #911
Labels
docs Issues pertaining to documentation. joss Issues pertaining to the JOSS review of this repository.

Comments

@jamesrhester
Copy link

(This is part of the JOSS paper review).

JOSS asks that the documentation includes information about how to get support. I suggest crafting a statement for either the README or somewhere at the top level of documentation under the headline "Getting Help", e.g. to suggest raising an issue with the docs if something is not clear or missing and that the project is unable to help with specific installations (or if the project is willing, a method of contact/mailing list etc.). If anybody is willing to do paid consultation to set up an optimade-compliant server then that is worth mentioning too.

@ml-evs ml-evs added the docs Issues pertaining to documentation. label Aug 26, 2021
@ml-evs
Copy link
Member

ml-evs commented Aug 26, 2021

Thanks @jamesrhester, #911 adds some specific "Getting help" info to the contributing documentation, and updates the linking sentence in the README.

If anybody is willing to do paid consultation to set up an optimade-compliant server then that is worth mentioning too.

An interesting idea! I don't think anyone is currently set up to do this; I have instead added a link to the broader consortium website which has the appropriate contact details.

@jamesrhester
Copy link
Author

That looks great.

@ml-evs ml-evs added the joss Issues pertaining to the JOSS review of this repository. label Sep 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues pertaining to documentation. joss Issues pertaining to the JOSS review of this repository.
Projects
None yet
2 participants