feat: add dev docs for web #623
Conversation
docs/20-web/_category_.json
Outdated
| @@ -0,0 +1,4 @@ | |||
| { | |||
| "label": "Web", | |||
| "position": 3 | |||
There was a problem hiding this comment.
pos 3 as pos 1 is intro, pos 2 will be server
|
@JammingBen @kulmann for testing:
|
|
frontmatter editUrl will be added in a followup |
JammingBen
left a comment
JammingBen
left a comment
There was a problem hiding this comment.
A few annotations from my side. Up to you which of them you want to tackle within the scope of this PR.
| --- | ||
| title: 'Getting Started' | ||
| sidebar_position: 1 | ||
| --- | ||
|
|
||
|
|
||
| ## Installation | ||
|
|
||
| ### Docker | ||
|
|
||
| Make sure to have Docker, Docker-Compose, Node.js and pnpm installed. |
There was a problem hiding this comment.
Should we add a short introduction stating that this is only necessary for development? One might get the impression that the web client always needs to be installed.
| ### Linting and Tests | ||
|
|
||
| To make sure your pull request can be efficiently reviewed and won't need a lot of changes down the road, please run the linter and | ||
| the unit tests via `pnpm lint --fix` and `pnpm test:unit` locally. Our [CI](https://drone.opencloud.eu/opencloud/web) will run on | ||
| pull requests and report back any problems after that. For a further introduction on how we handle testing, please head to | ||
| the [testing docs](./../30-testing/intro.md). | ||
|
|
There was a problem hiding this comment.
We should also add a sentence about formatting, since this is a new command that's also running in CI.
|
Tysm, I will commit your changes. The scope is just the port at the moment, but quick wins are welcome |
Co-authored-by: Jannik Stehle <50302941+JammingBen@users.noreply.github.com>
Co-authored-by: Jannik Stehle <50302941+JammingBen@users.noreply.github.com>
Co-authored-by: Jannik Stehle <50302941+JammingBen@users.noreply.github.com>
Co-authored-by: Jannik Stehle <50302941+JammingBen@users.noreply.github.com>
Co-authored-by: Jannik Stehle <50302941+JammingBen@users.noreply.github.com>
Co-authored-by: Benedikt Kulmann <b.kulmann@opencloud.eu>
Description
Related Issue
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: