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 docs for ElasticSearch - especially troubleshooting #7962

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

davidblasby
Copy link
Contributor

This is for working with @jodygarnett (follow up to his older PR and current PR) for making it easier to troubleshoot ElasticSearch problems.

There aren't any code changes, however;

  1. I added a Mac M1 (profile macOS-M-series) to make it easier to download the correct ES for M1 macs.
  2. I added a commented out line to es/docker-compose.yml to show how to set a custom password (if people don't want to use the no-security options)

Doc Changes;

  1. I made some minor changes to the README files in the code base to use the (already recommended) cd es; docker-compose up method to run ES. This is the easiest way to run to ES.
  2. I added a bit more details for people running the maven-based ES (v8 of ES made this a bit more difficult).
  3. I added more notes in the es/README.md for troubleshoot, as well as a "Notes" section at the bottom to help people with common problems.

@jodygarnett - would love to work with on (3) to make it as a bit more helpful.

Checklist

  • I have read the contribution guidelines
  • Pull request provided for main branch, backports managed with label
  • Good housekeeping of code, cleaning up comments, tests, and documentation
  • Clean commit history broken into understandable chucks, avoiding big commits with hundreds of files, cautious of reformatting and whitespace changes
  • Clean commit messages, longer verbose messages are encouraged
  • API Changes are identified in commit messages
  • Testing provided for features or enhancements using automatic tests
  • User documentation provided for new features or enhancements in manual
  • Build documentation provided for development instructions in README.md files
  • Library management using pom.xml dependency management. Update build documentation with intended library use and library tutorials or documentation

@davidblasby davidblasby marked this pull request as draft April 16, 2024 19:50
@davidblasby davidblasby self-assigned this Apr 16, 2024
@jodygarnett
Copy link
Contributor

This is still marked as draft, what feedback are you looking for :)

@davidblasby davidblasby marked this pull request as ready for review April 19, 2024 14:39
@davidblasby
Copy link
Contributor Author

This is still marked as draft, what feedback are you looking for :)

Changed to normal PR.

Please take a look at the changes and make sure what I said makes sense and isn't incorrect. Its for developers to troubleshoot - I expect you can add some more comments to the README as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants