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
Just leave a short summary what the bug is about and where you came to notice it.
## I expected the following to happen:
## On the contrary, I observed:
# How to reproduce the bug
Please describe briefly how you discovered the bug and what a developer has to do to reproduce it.
_Steps:_
* Step 1
* Step 2
* ...
* Step 1
* Step 2
* ...
# Severity
How much impact does this bug have on the product or further development?
* [ ] Minor
* [ ] Major
* [ ] Critical
* [ ] Blocker
* [ ] Minor
* [ ] Major
* [ ] Critical
* [ ] Blocker
# Platform
* [ ] Unix
* [ ] Windows
* [ ] MacOS
* [ ] Unix
* [ ] Windows
* [ ] MacOS
# Browser
* [ ] Safari
* [ ] Chrome/Chromium
* [ ] Firefox
* [ ] Other: ?
* [ ] Safari
* [ ] Chrome/Chromium
* [ ] Firefox
* [ ] Other: ?
# Program and – if applicable – dependency version
Which version of the software did you use?
# Related tickets
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)
......@@ -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.
# Summary
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.
# Related Tickets
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.
If your fix addresses something untracked, please open a ticket at first.
## Related
## Closes
# 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)
......@@ -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.
# Summary
This MR provides…
# Use Cases
If you can, please provide use cases for this feature.
# Documentation
Shall we add your feature to the documentation?
* [ ] I've already did it!
* [ ] At least I added a headline to the documentation.
* [ ] Not applicable
## Function Documentation
* [ ] Of course I prepared all my functions with an appropriate documentation.
## Are There Parts of the Documentation We Have to Adjust?
* [ ] No.
* [ ] Yes, but I'd like someone else to do it.
* [ ] Yes, and I already did!
# Tests
Are we able to test this new feature?
* [ ] Yes, everything can be done via unit tests.
* [ ] No, it is not possible.
# Changelog
* [ ] I added a statement to the CHANGELOG.
# Related Tickets
Add all related issues and especially those to be closed.
## Related
## Closes
# Logs and Screenshots
......
......@@ -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)
For using the development mode you also need
* quasar-cli (globally installed)
To get all dependencies via `npm`, simply run
......@@ -43,7 +44,7 @@ npm install
```bash
quasar dev
```
### Lint the files
```bash
......@@ -60,16 +61,17 @@ quasar build
See [Configuring quasar.conf.js](https://quasar.dev/quasar-cli/quasar-conf-js).
## Authors
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.
## Dockerfile
The dockerfile is used at GitLab CI.
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 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