inventree-docs icon indicating copy to clipboard operation
inventree-docs copied to clipboard

Documentation for vscode setup

Open SchrodingersGat opened this issue 3 years ago • 7 comments

Body of the issue

Ref: https://github.com/inventree/InvenTree/pull/3474

We need to add a separate installation / setup guide for debugging with vscode.

  • Add new page to "setup" group
  • Add informational videos

Add a "developer guide" here

image

SchrodingersGat avatar Aug 09 '22 00:08 SchrodingersGat

@luwol03 regarding videos, it might be good to split the documentation into logical sections and have shorted individual videos for each. Some rough ideas below...

Prerequesite

What is expected "before" starting?

  • git
  • docker
  • vscode
  • ???

Setup / Installation

  • Download source code
  • Install required extensions
  • Open workspace
  • Build container

Install Demo Dataset

  • Run task
  • ???

Debug Examples

  • Start server under debug mode
  • Show debugging with breakpoints

Other?

  • Maybe demonstrate some of the other available tasks

SchrodingersGat avatar Aug 09 '22 00:08 SchrodingersGat

Do we also need to show how to install vscode and docker?

luwol03 avatar Aug 09 '22 06:08 luwol03

Might be a good idea as a "prerequisite" section

SchrodingersGat avatar Aug 09 '22 06:08 SchrodingersGat

But then we need to split that between windows/macOS/linux?

luwol03 avatar Aug 09 '22 06:08 luwol03

I'd say we can simplify it to "you should have these things installed", not show how to install for each OS.

SchrodingersGat avatar Aug 09 '22 07:08 SchrodingersGat

@luwol03 do you have any time to submit a PR with this? Hoping to release the next stable version soon, would be great to have this documentation included.

SchrodingersGat avatar Oct 21 '22 11:10 SchrodingersGat

@SchrodingersGat Sorry to say, but I'm recently very busy. I don't think I can get this done. So I'm fine if you could take this over.

luwol03 avatar Oct 21 '22 15:10 luwol03