Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

Documentation for vscode setup #350

Open
SchrodingersGat opened this issue Aug 9, 2022 · 7 comments
Open

Documentation for vscode setup #350

SchrodingersGat opened this issue Aug 9, 2022 · 7 comments

Comments

@SchrodingersGat
Copy link
Member

SchrodingersGat commented Aug 9, 2022

Body of the issue

Ref: inventree/InvenTree#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
Copy link
Member Author

SchrodingersGat commented Aug 9, 2022

@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

@luwol03
Copy link

luwol03 commented Aug 9, 2022

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

@SchrodingersGat
Copy link
Member Author

Might be a good idea as a "prerequisite" section

@luwol03
Copy link

luwol03 commented Aug 9, 2022

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

@SchrodingersGat
Copy link
Member Author

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

@SchrodingersGat SchrodingersGat added this to the 0.9.0 milestone Oct 18, 2022
@SchrodingersGat
Copy link
Member Author

@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.

@luwol03
Copy link

luwol03 commented Oct 21, 2022

@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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants