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

Update instructions on how to start OpenSearch in debug mode #689

Merged
merged 1 commit into from
May 12, 2021
Merged

Update instructions on how to start OpenSearch in debug mode #689

merged 1 commit into from
May 12, 2021

Conversation

adnapibar
Copy link
Contributor

Description

Updated instructions on how to start OpenSearch in debug mode in IntelliJ IDEA.

Also, fixed some minor typos and added line breaks.

Check List

  • All tests pass
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Rabi Panda adnapibar@gmail.com

@adnapibar adnapibar added the documentation Improvements or additions to documentation label May 11, 2021
@adnapibar adnapibar requested a review from dblock May 11, 2021 21:13
@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Wrapper Validation success 269cece626a227a7c4a0541a665b35916a0a2aab

@opensearch-ci-bot
Copy link
Collaborator

✅   DCO Check Passed 269cece626a227a7c4a0541a665b35916a0a2aab

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Precommit success 269cece626a227a7c4a0541a665b35916a0a2aab

@dblock
Copy link
Member

dblock commented May 11, 2021

We removed line breaks in a previous commit. Why are we re-adding those for .md files?

With line breaks it's just very hard to read multiline sentence diffs when someone goes and adds words, everything gets re-formated across many lines and we don't know what changed anymore. And markdown doesn't use line breaks.

@adnapibar
Copy link
Contributor Author

adnapibar commented May 11, 2021

We removed line breaks in a previous commit. Why are we re-adding those for .md files?

With line breaks it's just very hard to read multiline sentence diffs when someone goes and adds words, everything gets re-formated across many lines and we don't know what changed anymore. And markdown doesn't use line breaks.

Is that the best practice? I think it's better to wrap the long lines than doing horizontal scrolling while editing (I know I can soft-wrap it in my editor). What do you mean by "markdown doesn't use line breaks" ? For instance, here is a style guide from Google.

@dblock
Copy link
Member

dblock commented May 12, 2021

We removed line breaks in a previous commit. Why are we re-adding those for .md files?
With line breaks it's just very hard to read multiline sentence diffs when someone goes and adds words, everything gets re-formated across many lines and we don't know what changed anymore. And markdown doesn't use line breaks.

Is that the best practice? I think it's better to wrap the long lines than doing horizontal scrolling while editing (I know I can soft-wrap it in my editor). What do you mean by "markdown doesn't use line breaks" ? For instance, here is a style guide from Google.

I can't speak for Google or the best practice. I think this one is YMMV.

On Markdown doesn't use line breaks: whether you include a line break in your markdown or not the rendered result is the same, unless you use 2 line breaks.

Hear me out then decide whether you want me to merge as is or not.

Example old text

A quick brown fox jumps 
over the lazy dog.

replaced with

The quick brown fox 
jumps over a lazy dog.

2-line change, but jumps moved to the next line, but it didn't really change! My head hurts ;)

Instead

>A quick brown fox jumps over the lazy dog.
<The quick brown fox jumps over a lazy dog.

So much easier to grok.

@dblock
Copy link
Member

dblock commented May 12, 2021

start gradle check

Signed-off-by: Rabi Panda <adnapibar@gmail.com>
@opensearch-ci-bot
Copy link
Collaborator

✅   DCO Check Passed 1b7a4db

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Wrapper Validation success 1b7a4db

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Check success 269cece626a227a7c4a0541a665b35916a0a2aab
Log 175

Reports 175

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Precommit success 1b7a4db

@adnapibar
Copy link
Contributor Author

We removed line breaks in a previous commit. Why are we re-adding those for .md files?
With line breaks it's just very hard to read multiline sentence diffs when someone goes and adds words, everything gets re-formated across many lines and we don't know what changed anymore. And markdown doesn't use line breaks.

Is that the best practice? I think it's better to wrap the long lines than doing horizontal scrolling while editing (I know I can soft-wrap it in my editor). What do you mean by "markdown doesn't use line breaks" ? For instance, here is a style guide from Google.

I can't speak for Google or the best practice. I think this one is YMMV.

On Markdown doesn't use line breaks: whether you include a line break in your markdown or not the rendered result is the same, unless you use 2 line breaks.

Hear me out then decide whether you want me to merge as is or not.

Example old text

A quick brown fox jumps 
over the lazy dog.

replaced with

The quick brown fox 
jumps over a lazy dog.

2-line change, but jumps moved to the next line, but it didn't really change! My head hurts ;)

Instead

>A quick brown fox jumps over the lazy dog.
<The quick brown fox jumps over a lazy dog.

So much easier to grok.

@dblock reverted the line break change.

@adnapibar
Copy link
Contributor Author

start gradle check

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Check success 1b7a4db
Log 176

Reports 176

@adnapibar adnapibar requested a review from dblock May 12, 2021 14:25
@adnapibar adnapibar merged commit 5aab081 into opensearch-project:main May 12, 2021
@adnapibar adnapibar deleted the update-testing-doc branch May 12, 2021 16:13
@adnapibar adnapibar added the pending backport Identifies an issue or PR that still needs to be backported label May 19, 2021
dblock pushed a commit that referenced this pull request May 20, 2021
Add clear instructions on how to run OpenSearch with debugging mode in IntelliJ. 
Fixed a few minor typos and grammars.

Signed-off-by: Rabi Panda <adnapibar@gmail.com>
@adnapibar adnapibar removed the pending backport Identifies an issue or PR that still needs to be backported label May 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants