search

OpenMS / OpenMS-docs

OpenMS Documentation.
https://openms.readthedocs.io
BSD 3-Clause "New" or "Revised" License
2 stars 18 forks source link

OpenMS Documentation Gets a New Home #4

Closed timosachsenberg closed 2 years ago

timosachsenberg commented 2 years ago

This issue tracks:

  1. Movement of Doxygen pages to OpenMS-docs.
  2. Movement of Wiki Pages to OpenMS API Reference, OpenMS-docs, and pyopenms-docs.
  3. Addition of Tutorials to OpenMS-docs.
  4. Addition of References in OpenMS-docs and updated information present in:
tapaswenipathak commented 2 years ago
  1. Installation instructions:
  2. Documentation:
  3. Misc:
  4. Development:
  5. Documentation:
  6. OpenMS Wiki: https://github.com/OpenMS/OpenMS/wiki
  7. Tutorials/Handouts: https://github.com/OpenMS/Tutorials
  8. updateHMDB
  9. usage_plots
  10. dockerfiles
  11. build-scripts
  12. autowrap
  13. contrib
  14. PDCommunityNodes

Note: CRUD stands for Create | Replace | Update | Delete

jpfeuffer commented 2 years ago

can we rename this issue? @timosachsenberg can you update your text?

timosachsenberg commented 2 years ago

Sure feel free to rename or update.

tapaswenipathak commented 2 years ago

cc @axelwalter @enetz @jpfeuffer @KyowonJeong @poshul @OpenMS/doc-team.

jpfeuffer commented 2 years ago

I thought we decided that internal discussions stay in the wiki? E.g. Openms 2.0 kernel white paper and meeting summaries

tapaswenipathak commented 2 years ago

On Sat, May 14, 2022 at 3:01 PM Julianus Pfeuffer @.***> wrote:

I thought we decided that internal discussions stay in the wiki? E.g. Openms 2.0 kernel white paper and meeting summaries

I was thinking papers could go to OpenMS/OpenMS-docs, just not visible on https://openms.readthedocs.io/en/latest/? Say, docs/research/whitepapers.

Meeting summaries, I'll just see for any content and maybe add them under one category in the wiki. Meeting summaries for sure remains in the wiki.

— Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you commented.Message ID: @.***>

tapaswenipathak commented 2 years ago

Monday (Anywhere on Earth) end of day, https://github.com/OpenMS/OpenMS-docs/compare/main...staging will be created, please make some time available for reviewing till Friday (AoE).

OpenMS Documentation: https://staging-openms.readthedocs.io/en/staging.