Skip to content
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

Add developer info about intellij #984

Merged
merged 3 commits into from
May 7, 2020
Merged

Conversation

hub-cap
Copy link
Contributor

@hub-cap hub-cap commented May 4, 2020

No description provided.

@hub-cap hub-cap added enhancement Improves the status quo :Docs Changes to the documentation labels May 4, 2020
@hub-cap hub-cap added this to the 2.1.0 milestone May 4, 2020
@hub-cap hub-cap requested a review from dliappis May 4, 2020 19:33
@hub-cap hub-cap self-assigned this May 4, 2020
Copy link
Contributor

@dliappis dliappis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

### Importing the project into IntelliJ IDEA

Rally builds using virtualenv. When importing into IntelliJ you will need to define an appropriate Python SDK, which is provided by virtualenv.
For more details on defining a Python SDK in IntelliJ please refer to their documentation. We recommend using the Python SDK that `make prereq` creates.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can even me more specific and just say add an "Existing environment" in the Virtualenv Environment dialog using $RALLY_PATH/.venv/bin/python3 after make prereq && make install has been run. This should result in something like:

image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed the existing ES teams info did not include pictures, and I presume its because 1) we need a new folder to store the single pic and 2) that pic is guaranteed to change when intellij shakes up the UI every release. This is why I went with no pics, but I can definitely update the wording a bit.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds reasonable to me then.

CONTRIBUTING.md Outdated
Rally builds using virtualenv. When importing into IntelliJ you will need to define an appropriate Python SDK, which is provided by virtualenv.
For more details on defining a Python SDK in IntelliJ please refer to their documentation. We recommend using the Python SDK that `make prereq` creates.

In order to run tests within the IDE, ensure the `Python Integrated Tools` `Default Test Runner` is set to `pytest`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Python Integrated Tools / Testing / Default test runner

@hub-cap
Copy link
Contributor Author

hub-cap commented May 6, 2020

@dliappis I added a bit more contextual information if you care to review this again, without adding any pictures. No need to review if you feel its ok though. I do see you already approved it. I wont request re-review, but if you see this comment and wish to review, feel free. Otherwise Ill likely merge tomorrow.

@hub-cap hub-cap merged commit 6d3551f into elastic:master May 7, 2020
@hub-cap hub-cap deleted the intellij_blurb branch May 7, 2020 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Docs Changes to the documentation enhancement Improves the status quo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants