[alpha-testing] To go live on OpenMS develop documentation: https://openms.readthedocs.io/en/develop

.github/CONTRIBUTING.md

@@ -0,0 +1,68 @@
+OpenMS Documentation Contributing Guidelines
+============================================
+
+Hi there!
+
+Thank you for thinking about enhancing OpenMS Documentation further.
+
+Please feel free to:
+
+1. Create a bug report or feature request in OpenMS Documentation, [here](https://github.com/OpenMS/OpenMS-docs/issues).
+2. Create a pull request in [OpenMS Documentation](https://github.com/OpenMS/OpenMS-docs) with the change you're proposing.
+
+For any questions, drop us a ping in [OpenMS Gitter](https://gitter.im/OpenMS/OpenMS).
+
+## Create a Pull Request(PR)
+
+1. Fork this repository.
+2. Add the change in your fork.
+3. Create a pull request to [OpenMS/OpenMS-Docs](https://github.com/OpenMS/OpenMS-docs/tree/staging) `staging` branch.
+4. Make sure you attach a few screenshots as to how your change looks like.
+5. If this change belongs to [OpenMS API reference](https://abibuilder.informatik.uni-tuebingen.de/archive/openms/Documentation/nightly/html/index.html),
+   please create a pull request [here](https://github.com/OpenMS/OpenMS/tree/develop/doc).
+
+## Documentation content writing conventions
+
+1. Please prefer active voice.
+2. Restrict the line length to 120 characters, including space(s).
+3. Title and H1 heading should be in `Title Case`. Follow `Sentence case`, until otherwise stated.
+4. Write as OpenMS is writing for itself as an object and subject.
+5. Use American English.
+6. Use `backtick`(s) for formatting code, library name, files, and path.
+7. Use **bold** for product name, object name, an independent entity.
+8. Use **bold** for menu title in an application.
+9. Link to glossary terms using {term}\`this is a glossary term\`.
+10. OpenMS documentation uses following Admonitions
+    - Hint
+	- Important
+	- Note
+	- Warning
+	- Tip
+	- See Also
+
+	Example of these are present in documentation, please follow them.
+11. Always specify lexers for code blocks.
+12. Format keyboard strokes using `<kbd>qwerty-keyboard-button</kbd>`, as an example, please see [this](../docs/tutorials/TOPP/hotkeys-table.md) file.
+13. Be nice, polite, and respectful.
+
+### Naming files
+
+1. The title of the page should be the `name-of-the-file.md`.
+2. Prefer writing in markdown, with an `.md` file extension; both reStructureText and markdown is supported in OpenMS Documentation.
+
+### Images and figures
+
+For images and figures:
+
+1. Add a screenshot of the window.
+2. In tutorial, align images in center. Other instructions, should have alighment to left.
+3. Please set the size to `500px` of images added in step-by-step guides or instructions.
+
+## OpenMS documentation contributors
+
+Thank you for your contribution!
+
+Finally, please add your name below:
+
+1. OpenMS Team
+

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,45 @@
+---
+name: Bug report
+about: Report something that is broken or incorrect in documentation
+labels: bug
+---
+
+<!--
+# openms/openms-docs bug report
+
+Hi there!
+
+Thanks for telling us about a problem with openms documentation.
+Please delete this text and anything that's not relevant from the template below:
+-->
+
+## Read Existing Documentation
+
+I have checked the following places for the error:
+
+- [ ] [OpenMS Documentation Troubleshooting]()
+- [ ] [OpenMS API Developer FAQs]()
+
+## Create OpenMS Bug Report
+
+I have created the bug report in OpenMS for any pipeline errors.
+
+- [ ] [OpenMS Open Issues](https://github.com/OpenMS/OpenMS/issues)
+
+## Description of the documentation bug
+
+- [ ] I have attached screenshots of the incorrect documentation
+
+<!-- A clear and concise description of what the bug is. -->
+
+## Expected behaviour
+
+<!-- A clear and concise description of what you expected to happen. -->
+
+## OpenMS Installation
+
+- Version: <!-- [e.g. 2.8.0 -->
+
+## Additional context
+
+<!-- Add any other context about the documentation problem here. -->

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,35 @@
+---
+name: Feature request
+about: Suggest an idea for the OpenMS Documentation
+labels: enhancement
+---
+
+<!--
+# OpenMS/OpenMS-docs feature request
+
+Hi there!
+
+Thanks for suggesting a new feature for the OpenMS Documentation!
+Please delete this text and anything that's not relevant from the template below:
+-->
+
+## Is your feature request related to a OpenMS API Reference Documentation? Please describe.
+
+<!--
+
+For feature request in OpenMS, please create issue in [OpenMS](https://github.com/OpenMS/OpenMS/issues)
+Please provide a clear and concise description of what the problem is in documentation.
+-->
+- [ ] I have attached screenshot describing the problem, if applicable.
+
+## Describe the documentation enhancement you'd like
+
+<!-- A clear and concise description of what you want to read in the documentation. -->
+
+## Describe alternatives you've considered
+
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+## Additional context
+
+<!-- Add any other context about the feature request here. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+<!--
+# openms/openms-docs pull request
+
+Thank you for thinking about contributing to OpenMS Documentation!
+
+Please fill in the appropriate checklist below.
+
+Remember that PRs should be made against the staging branch, unless you're preparing a hotfix to be released.
+
+Learn more about contributing to OpenMS Documentation: https://staging-openms.readthedocs.io/en/staging/.github/CONTRIBUTING.html
+-->
+
+## Describe the change
+
+<!-- Please add a brief description about the change in documentation that you're suggesting -->
+
+## PR checklist
+
+- [ ] I have added description of the change I'm proposing in the OpenMS Documentation.
+- [ ] I have read and followed [OpenMS Documentation Contributing guidelines](CONTRIBUTING.md).
+- [ ] I have attached a screenshot of the relevant area after this change.
+- [ ] `CHANGELOG.md` is updated.
+- [ ] I have added my name in [CONTRIBUTING.md](CONTRIBUTING.md#openms-documentation-contributors).

.readthedocs.yaml

@@ -0,0 +1,17 @@
+version: 2
+
+# Build from the docs/ directory with Sphinx
+sphinx:
+  configuration: conf.py
+
+# Explicitly set the version of Python and its requirements
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+python:
+  install:
+    - requirements: requirements.txt

CHANGELOG.md

@@ -0,0 +1,8 @@
+OpenMS 2.8.0 Documentation which includes
+
+1. OpenMS Introductory Pages
+2. Installation Instructions
+3. TOPP and TOPPAS tutorials
+4. TOPP Introductory Documentation
+5. User QuickStart Guide
+6. Contacting OpenMS

Makefile

@@ -0,0 +1,21 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = openms
+SOURCEDIR     = docs
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

README.md

@@ -1 +1,7 @@
-# OpenMS-docs
+OpenMS Documentation
+====================
+
+You're reading OpenMS `staging` documentation! If you think, you're at a wrong place, go to [OpenMS Documentation](https://staging-openms.readthedocs.io/en/staging/docs/index.html).
+
+Please read our [contributing guidelines](.github/CONTRIBUTING.md), before starting with
+contributing to OpenMS Documentation.

_static/css/custom.css

@@ -0,0 +1,3 @@
+div.highlight {
+  background-color: #f6f8fa;
+}