-
Notifications
You must be signed in to change notification settings - Fork 495
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
improve docs on setting up a new dev environment #7242
Conversation
I had added in in pull request #5438 but I'm not sure we need it. I didn't seem to need it this time.
We got a question about all the pgAdmin stuff. What it's for, what's going on. It wasn't clear that we're simply using this tool to check if the "trust" change worked (which simplifies the installation later). Perhaps in the future we could switch to a test with `psql` but an advantage of mentioning pgAdmin early is to let the new developer know that this tool exists.
The README_python.txt is long and a lot to digest. I still link to this text file for reference but I simplified the instructions to put all the commands I used inline. I also introduced venv which is what I think Python developers should be using in 2020.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mheppler it's this line: "The installer will try to connect to the SMTP server you tell it to use. If you don't have a mail server handy you can run |
Ah. I missed that. Sorry, @pdurbin. What does running |
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Looks good. Don't know if more info is needed for the ns-SMTP server work around. I'll leave that up to QA.
What this PR does / why we need it:
I got a new laptop and ran into various issue setting up a Dataverse dev environment:
One of our strategic goals is "increase contributions from the open-source development community" and I hope this pull request helps.
The summary is:
Which issue(s) this PR closes:
Special notes for your reviewer:
I left comments in the commits. Here's a dump of them:
commit 91b835e (HEAD -> 7241-dev-env, origin/7241-dev-env)
Author: Philip Durbin philip_durbin@harvard.edu
Date: Fri Aug 28 12:37:09 2020 -0400
commit 45a85ac
Author: Philip Durbin philip_durbin@harvard.edu
Date: Fri Aug 28 12:32:30 2020 -0400
commit 95bfbf1
Author: Philip Durbin philip_durbin@harvard.edu
Date: Fri Aug 28 12:27:40 2020 -0400
commit 4fc67ea
Author: Philip Durbin philip_durbin@harvard.edu
Date: Fri Aug 28 12:22:56 2020 -0400
commit 6402322
Author: Philip Durbin philip_durbin@harvard.edu
Date: Fri Aug 28 12:10:59 2020 -0400
commit 791437c
Author: Philip Durbin philip_durbin@harvard.edu
Date: Fri Aug 28 12:07:53 2020 -0400
Suggestions on how to test this:
Have a another developer run through these instructions, on Mac.
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
No.
Is there a release notes update needed for this change?:
No.
Additional documentation:
None.