Use version-specific documentation link in jvm.options file

[mark-vieira]

We use a hard-coded link to the "current" documentation on Java heap settings in our jvm.options file which may very well be out of date with the corresponding version of Elasticsearch the file is coming from.

Closes #65808

[elasticmachine]

Pinging @elastic/es-delivery (Team:Delivery)

[mark-vieira]

@DaveCTurner one thing that just occurred to me after creating this PR is that we might run into issues when folks upgrade, but keep their old jvm.options file (which I suspect is common). In that case we'll be linking to a potentially old version of the docs. There's no good way to solve both problems of linking to docs that are too new and linking to docs that are too old so I suspect we have to pick the worse of the two evils here. Thoughts?

[DaveCTurner]

Thanks for addressing this Mark.

I think it's better to link to the docs that correspond with the file as originally installed (i.e. what you've done here). It's also fairly common to install older versions afresh, and having a fresh install link to the wrong docs will cause more of a surprise than accumulating cruft through upgrades.

We should know that the version-specific link will continue to exist even if we move things around in newer versions, and the page does warn you that it's not the latest version at the top, with facilities to choose the same page for a different version, so I think folks will get to the right place in the end.

[DaveCTurner]

I figured if this didn't work (e.g. we spelled project.minor.version differently in the two places) then we wouldn't be able to build a distribution. But then I tried it and discovered that it didn't, it just left the mis-spelled @project.minor.vesrion@ literally in the file. Should we be failing the build on that?

Also I think we should make https://www.elastic.co/guide/en/elasticsearch/reference/current/jvm-options.html be version-specific too.

[breskeby]

lgtm. would be indeed great if we could fail the build if a token is not been replaced, but as we're using ReplaceToken filter I don't see how to do that in a straight forward fashion.

[DaveCTurner]

Acked, ok we'll take the risk of typos here then.

I still think we should fix the link to jvm-options.html too tho.

[elasticsearchmachine]

💔 Backport failed

Status	Branch	Result
❌	7.x	Commit could not be cherrypicked due to conflicts

To backport manually run backport --upstream elastic/elasticsearch --pr 76323