Commit 58c92547 authored by Nils Windisch's avatar Nils Windisch
Browse files

docs: minor markdown linting

parent fc4ccea0
Pipeline #136874 passed with stages
in 1 minute and 59 seconds
# Description # Description
Just leave a short summary what the bug is about and where you came to notice it. Just leave a short summary what the bug is about and where you came to notice it.
## I expected the following to happen: ## I expected the following to happen:
## On the contrary, I observed: ## On the contrary, I observed:
# How to reproduce the bug # How to reproduce the bug
Please describe briefly how you discovered the bug and what a developer has to do to reproduce it. Please describe briefly how you discovered the bug and what a developer has to do to reproduce it.
_Steps:_ _Steps:_
* Step 1
* Step 2 * Step 1
* ... * Step 2
* ...
# Severity # Severity
How much impact does this bug have on the product or further development? How much impact does this bug have on the product or further development?
* [ ] Minor
* [ ] Major * [ ] Minor
* [ ] Critical * [ ] Major
* [ ] Blocker * [ ] Critical
* [ ] Blocker
# Platform # Platform
* [ ] Unix
* [ ] Windows * [ ] Unix
* [ ] MacOS * [ ] Windows
* [ ] MacOS
# Browser # Browser
* [ ] Safari
* [ ] Chrome/Chromium * [ ] Safari
* [ ] Firefox * [ ] Chrome/Chromium
* [ ] Other: ? * [ ] Firefox
* [ ] Other: ?
# Program and – if applicable – dependency version # Program and – if applicable – dependency version
Which version of the software did you use? Which version of the software did you use?
# Related tickets # Related tickets
Add related issues (if applicable). Add related issues (if applicable).
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis) /cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)
...@@ -4,18 +4,22 @@ Thank you very much! ...@@ -4,18 +4,22 @@ Thank you very much!
Please take a moment to help us include the purposed bugfix by filling out the following form. Please take a moment to help us include the purposed bugfix by filling out the following form.
# Summary # Summary
Apart from what is mentioned in the main ticket you are going to close with this Apart from what is mentioned in the main ticket you are going to close with this
MR, tell us what you have done to achieve this goal. MR, tell us what you have done to achieve this goal.
# Related Tickets # Related Tickets
Add all related issues and especially those to be closed. Add all related issues and especially those to be closed.
Keep in mind that every bugfix branch needs an issue that properly describes the bug beforehand. Keep in mind that every bugfix branch needs an issue that properly describes the bug beforehand.
If your fix addresses something untracked, please open a ticket at first. If your fix addresses something untracked, please open a ticket at first.
## Related ## Related
## Closes ## Closes
# Changelog # Changelog
* [ ] I added a statement to the CHANGELOG. * [ ] I added a statement to the CHANGELOG.
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis) /cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)
...@@ -4,37 +4,48 @@ But at first we ask you to fill in the following information about your feature. ...@@ -4,37 +4,48 @@ But at first we ask you to fill in the following information about your feature.
So please take a few minutes to make this great thing even better. So please take a few minutes to make this great thing even better.
# Summary # Summary
This MR provides… This MR provides…
# Use Cases # Use Cases
If you can, please provide use cases for this feature. If you can, please provide use cases for this feature.
# Documentation # Documentation
Shall we add your feature to the documentation? Shall we add your feature to the documentation?
* [ ] I've already did it! * [ ] I've already did it!
* [ ] At least I added a headline to the documentation. * [ ] At least I added a headline to the documentation.
* [ ] Not applicable * [ ] Not applicable
## Function Documentation ## Function Documentation
* [ ] Of course I prepared all my functions with an appropriate documentation. * [ ] Of course I prepared all my functions with an appropriate documentation.
## Are There Parts of the Documentation We Have to Adjust? ## Are There Parts of the Documentation We Have to Adjust?
* [ ] No. * [ ] No.
* [ ] Yes, but I'd like someone else to do it. * [ ] Yes, but I'd like someone else to do it.
* [ ] Yes, and I already did! * [ ] Yes, and I already did!
# Tests # Tests
Are we able to test this new feature? Are we able to test this new feature?
* [ ] Yes, everything can be done via unit tests. * [ ] Yes, everything can be done via unit tests.
* [ ] No, it is not possible. * [ ] No, it is not possible.
# Changelog # Changelog
* [ ] I added a statement to the CHANGELOG. * [ ] I added a statement to the CHANGELOG.
# Related Tickets # Related Tickets
Add all related issues and especially those to be closed. Add all related issues and especially those to be closed.
## Related ## Related
## Closes ## Closes
# Logs and Screenshots # Logs and Screenshots
......
...@@ -22,6 +22,7 @@ To get the EMo Viewer up and running you should have the following software inst ...@@ -22,6 +22,7 @@ To get the EMo Viewer up and running you should have the following software inst
* vue-cli-service-global (globally installed) * vue-cli-service-global (globally installed)
For using the development mode you also need For using the development mode you also need
* quasar-cli (globally installed) * quasar-cli (globally installed)
To get all dependencies via `npm`, simply run To get all dependencies via `npm`, simply run
...@@ -43,7 +44,7 @@ npm install ...@@ -43,7 +44,7 @@ npm install
```bash ```bash
quasar dev quasar dev
``` ```
### Lint the files ### Lint the files
```bash ```bash
...@@ -60,16 +61,17 @@ quasar build ...@@ -60,16 +61,17 @@ quasar build
See [Configuring quasar.conf.js](https://quasar.dev/quasar-cli/quasar-conf-js). See [Configuring quasar.conf.js](https://quasar.dev/quasar-cli/quasar-conf-js).
## Authors ## Authors
See the list of [contributors](https://gitlab.gwdg.de/subugoe/emo/Qviewer/-/graphs/develop) who participated in this project. See the list of [contributors](https://gitlab.gwdg.de/subugoe/emo/Qviewer/-/graphs/develop) who participated in this project.
Please notice our [contribution guidelines](CONTRIBUTING.md) which contains all necessary information about the development workflow. Please notice our [contribution guidelines](CONTRIBUTING.md) which contains all necessary information about the development workflow.
## Dockerfile ## Dockerfile
The dockerfile is used at GitLab CI. The dockerfile is used at GitLab CI.
It needs to be updated, when either node or quasar-cli should be updated. It needs to be updated, when either node or quasar-cli should be updated.
```
```bash
docker build --pull -t docker.gitlab.gwdg.de/subugoe/emo/qviewer/node . docker build --pull -t docker.gitlab.gwdg.de/subugoe/emo/qviewer/node .
docker push docker.gitlab.gwdg.de/subugoe/emo/qviewer/node docker push docker.gitlab.gwdg.de/subugoe/emo/qviewer/node
``` ```
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment