-
Notifications
You must be signed in to change notification settings - Fork 25.6k
[Docs] Fix plugin authors example urls on older branches #28530
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
|
@tlrx since you created those two new example projects, could you check if linking to those from older 6.x branches looks okay to you? I was suprised that we seem to link to master most previous versions of this doc, maybe we should link to the appropriate minor version instead? This doesn't seem to happen in most of the rest of the documentation though. Thoughts? |
|
@cbuescher Thanks, I didn't see these links were wrong!
I still need to backport #28339 to 6.2/6.1/6.0 branches. It think the best it to change the links to point to each corresponding version, I can do it when I backport the PR. |
|
@tlrx great, I didn't know there were plans to backport the example split. In that case changing the links to the current branch might be the best option. I see most external links to some repost in the docs going to ".../tree/master/..." though, so maybe we should quickly check with the docs team what the desired behaviour is here. Maybe @clintongormley has an opinion here. |
I think we should use a link reference for the github repository, something like:
and for all non master branch:
I think it should work. |
A problem with that is that {version} includes the patch version, so it would be 6.2.0 but for the links to the repo we would need only the major and minor (6.2). Not sure where that would be added to the docs build. |
|
There is a |
037b6ae to
cefa90b
Compare
|
@cbuescher Is there anything preventing this from being merged? |
Follow up to elastic#28528. The example page links to a project on master which has been split into two projects.
cefa90b to
2747d00
Compare
tlrx
left a comment
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, sorry for the delay it took me to approve this.
I initially wanted to backport #28339 so that plugin samples would be the same for all 6.x versions but it has been blocked by released and other stuff.
| * a https://github.com/elastic/elasticsearch/tree/{branch}/plugins/examples/script-expert-scoring[Java plugin] | ||
| which contains a script plugin. | ||
| * a https://github.com/elastic/elasticsearch/tree/master/plugins/examples/meta-plugin[Java plugin] | ||
| * a https://github.com/elastic/elasticsearch/tree/{branch}/plugins/examples/meta-plugin[Java plugin] |
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.
Note: this must be removed when backporting to 6.1 and 6.0
| * a https://github.com/elastic/elasticsearch/tree/{branch}/plugins/jvm-example[Java plugin] | ||
| which contains Java code. | ||
| * a https://github.com/elastic/elasticsearch/tree/master/plugins/examples/rescore[Java plugin] | ||
| * a https://github.com/elastic/elasticsearch/tree/{branch}/plugins/examples/rescore[Java plugin] |
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.
Note: this must be removed when backporting to 6.0
|
@tlrx thanks, will remove the above mentioned bullet point when porting this back. |
Follow up to #28528. The example page links to a project on master which has been split into two projects.
Follow up to #28528. The example page links to a project on master which has been split into two projects.
Follow up to #28528. The example page links to a project on master which has been
split into two projects.