- 
                Notifications
    You must be signed in to change notification settings 
- Fork 775
Fix broken link to Elasticsearch "heap size" docs #3894
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
Conversation
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.
LGTM
Looks like there is a tool to generate backports that this repo uses.
| Thanks @kellyemurphy! Looks like I'm not authorized to merge in this repo. :-( | 
| If `ES_JAVA_OPTS` is not defined, the Elasticsearch default heap size of 1Gi will be in effect. | ||
|  | ||
| See also: link:https://www.elastic.co/guide/en/elasticsearch/reference/current/heap-size.html[Elasticsearch documentation on setting the heap size] | ||
| For more information, see the entry for `heap size` in the link:{ref}/important-settings.html[Important Elasticsearch configuration] documentation. | 
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.
I guess {ref} here actually points to the Elasticsearch reference url base path?
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.
Yes, exactly.
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 great, thanks!
| 
 What we usually do is set a label for the smallest version (here that would be 0.9 - in practice I'm not sure we care much about updating docs for versions older than 1.0?) in the PR that targets master (this PR). Then we create a bunch of PRs with the  | 
| @kilfoyle please let me know if you need help with the backport PRs! | 
| Thanks for your help @sebgl Some background on this: The CI checks for the docs builds are very sensitive, and will fail if any broken links are detected even in outdated releases. So a broken link even in the  I've opened backports for: I see @charith-elastic (Thanks Charith!) has suggested we can override the failed CI checks on some of these. Since I don't have authority to merge in this repo, could I ask either of you to help me with that? | 
Hi @sebgl, May I ask you to review this PR for me, or point me in the right direction? This fixes a link in the K8s docs that will break once we merge other changes for the stack 7.10 release, so this will allow the docs build to pass ( elastic/docs#1994 ).
Also, I'll need to backport this to releases
0.9,1.0-beta,1.0,1.1, and1.2. Can you let me know if I've got the right labels for that? If so, I assume I just create the backports manually, right?Sorry for the all the questions. Arianna is out this week and I'm a new visitor to this repo. :-)