Skip to content

DOC: expand "using a Docker container" section #35345

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.

Sign up for GitHub

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

Jump to bottom
Closed
MarcoGorelli opened this issue Jul 19, 2020 · 2 comments · Fixed by #35379
Closed

DOC: expand "using a Docker container" section #35345

MarcoGorelli opened this issue Jul 19, 2020 · 2 comments · Fixed by #35379
Assignees
@alexhlim
Labels
Docs good first issue
Milestone
1.2

Comments

@MarcoGorelli
Copy link
Member

MarcoGorelli commented Jul 19, 2020 •
edited
Loading

Location of the documentation

https://pandas.pydata.org/pandas-docs/dev/development/contributing.html#using-a-docker-container

Documentation problem

Someone unfamiliar with Docker would be confused reading this.

Suggested fix for documentation

The expansion needed is quite small, just:

  1. link to the Docker installation instructions
  2. link to how to develop in a container using PyCharm (current docs only link to vs code instructions)
  3. mention that you might still need to rebuild the C extensions if/when you merge with upstream/master with 
    python setup.py build_ext --inplace -j 4
@MarcoGorelli MarcoGorelli added Docs Needs Triage Issue that has not been reviewed by a pandas team member good first issue and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Jul 19, 2020
@alexhlim
Copy link
Member

alexhlim commented Jul 21, 2020 •
edited
Loading

I was able to find links for the docker installation and developing in a container using PyCharm. However, I notice this feature is only for PyCharm Professional. Is it still worth including this link? I can just mention that Professional is required?

@MarcoGorelli
Copy link
Member Author

MarcoGorelli commented Jul 21, 2020 •
edited
Loading

Sure, go ahead! I've assigned this issue to you, but in the future if you comment "take" then the issue will be automatically assigned to you

alexhlim added a commit to alexhlim/pandas that referenced this issue Jul 22, 2020
@alexhlim
DOC: Expanded Using a Docker Container section (pandas-dev#35345)
baebad7
@alexhlim alexhlim mentioned this issue Jul 22, 2020
Merged
5 tasks
simonjayhawkins pushed a commit that referenced this issue Aug 1, 2020
@alexhlim
DOC: Expanded Using a Docker Container section (#35345) (#35379)
5223cd1
@simonjayhawkins simonjayhawkins added this to the 1.2 milestone Aug 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@alexhlim alexhlim

Labels
Docs good first issue
Projects
None yet
Milestone
1.2
Development

Successfully merging a pull request may close this issue.

DOC: Expanded Using a Docker Container section alexhlim/pandas
3 participants
@simonjayhawkins @alexhlim @MarcoGorelli