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

Separate internal BIH docs from SODAR manual #1746

Open
mikkonie opened this issue Aug 10, 2023 · 0 comments
Open

Separate internal BIH docs from SODAR manual #1746

mikkonie opened this issue Aug 10, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation tbd Comments wanted, spec/schedule/prioritization to be decided, etc.

Comments

@mikkonie
Copy link
Contributor

This is something which has been gnawing at me for a long time. The SODAR manual is a mishmash of 1) SODAR server software specific material, and 2) things only relevant to internal BIH, Charitë and MDC work. See e.g. #1745 for an example of the latter.

I have attempted to clarify in the docs that these two types of docs may co-inhabit the manual, but that's a temporary workaround at best.

SODAR has already been used in other organizations and there is little reason to believe this will not continue, so it would make to separate generic software and usage docs from stuff documenting internal processes.

How exactly to do this and how to maintain multiple documents? That is something we should discuss. I'm very much open for opinions.

@mikkonie mikkonie added documentation Improvements or additions to documentation tbd Comments wanted, spec/schedule/prioritization to be decided, etc. labels Aug 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation tbd Comments wanted, spec/schedule/prioritization to be decided, etc.
Projects
None yet
Development

No branches or pull requests

1 participant