Dev documentation

[Randy-Blancett]

Proposed change

Called out installing Pipenv (with directions) as well as added notes about what dependencies to install and how to set Debug.
These are to address a few questions I had when setting up my development environment.

Closes #(issue or discussion)

Type of change

• Bug fix: non-breaking change which fixes an issue.
• New feature / Enhancement: non-breaking change which adds functionality. Please read the important note above.
• Breaking change: fix or feature that would cause existing functionality to not work as expected.
• Documentation only.
• Other. Please explain:

Checklist:

• I have read & agree with the contributing guidelines.
• If applicable, I have included testing coverage for new code in this PR, for backend and / or front-end changes.
• If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.
• If applicable, I have checked that all tests pass, see documentation.
• I have run all pre-commit hooks, see documentation.
• I have made corresponding changes to the documentation as needed.
• I have checked my modifications for any breaking changes.

[paperless-ngx-secretary]

Hello @Randy-Blancett,

Thank you very much for submitting this PR to us!

This is what will happen next:

1. Once enabled by a maintainer, our ci tests will run against your PR to ensure quality and consistency.
2. Next, human contributors from paperless-ngx review your changes. Since this seems to be a small change, only a single contributor has to review your changes.
3. Please address any issues that come up during the review as soon as you are able to.
4. If accepted, your pull request will be merged into the dev branch and changes there will be tested further.
5. Eventually, changes from you and other contributors will be merged into main and a new release will be made.

You'll be hearing from us soon, and thank you again for contributing to our project.

[shamoon]

Thanks but I’m not sure this clarification is needed (eg ocrmypdf requirement), pipenv is not a requirement, though I agree it’s easier. And the comment about setting debug with export is also not accurate, if it’s in the conf file that’s enough.

Overall, without those changes I’m not sure there’s anything left in this PR?

Also, I’m not necessarily the most expert person wrt the backend dev, so perhaps there’s other thoughts.

[Randy-Blancett]

That Is fine, just wanted to try to clarify the areas that I had issues with.
I will put the these thoughts out for the discussion tho.

1. you say that pipenv is not required. Which is probably true. However as some one new to this project I was looking for directions that I could follow step by step and get everything working. IF you do not install pipenv step 4 (install python dependencies) fails and you can not go any farther.
2. The ocrmypdf not being needed is probably true, however I did have issues with this since on the bare metal page the dependencies are broken out into different sections and I thought I only needed to install the ones under the Paperless section.
3. For the Debug, You are correct I was incorrectly running src/manage.py runserver instead of running it from with in the src folder

[shamoon]

Yea, looking at this it actually already says "Install prerequisites + pipenv as mentioned..." so again, Im not sure this really clarifies things much. And step 1 may or may not be install pipenv (they may have it installed, use another manager, etc)

Thanks again for taking the time anyway.