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

[DOCS] add links to javadoc in clients docs pages #25745

Merged
merged 1 commit into from
Jul 31, 2017

Conversation

javanna
Copy link
Member

@javanna javanna commented Jul 17, 2017

We have been publishing javadoc to artifacts.elastic.co (and snapshots.elastic.co) for a while. This commit adds the link to them to the transport client, low level REST client, sniffer and high level REST client pages.

Closes #23761

@@ -9,7 +9,7 @@
release-state can be: released | prerelease | unreleased
//////////

:release-state: prerelease
:release-state: unreleased
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to make these two changes otherwise the links are incorrect on current master. I suspect this has to do with the fact that we don't have an alpha2 branch hence we have been building alpha2 docs from master. This change may break alpha2 docs then, not sure.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will break a lot of the existing docs, especially to do with installing 6.0.0-alpha2. We can't do this until beta1 is out

Copy link
Member Author

@javanna javanna Jul 17, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok then we should probably get this in after we released beta1 unless we are willing to accept that before then the links won't work in master. They will for 5.x though I think.

@javanna
Copy link
Member Author

javanna commented Jul 31, 2017

I reverted the unnecessary changes, the non working links should get fixed once #25876 goes in. I think this can go in now.

Copy link
Member

@tlrx tlrx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, left minor comment

:transport-client-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/client/transport/{version}-SNAPSHOT
:rest-client-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-client/{version}-SNAPSHOT
:rest-client-sniffer-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-client-sniffer/{version}-SNAPSHOT
:rest-high-level-client-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-high-level-clien/{version}-SNAPSHOT
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

level-clien/{version}-SNAPSHOT

missing t

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch!!!!!

We publish javadocs to artifacts.elastic.co (and snapshots.elastic.co) for a while. This commit adds the link to them to the transport client, low level REST client, sniffer and high level REST client pages.

Closes elastic#23761
@javanna javanna merged commit b9ce222 into elastic:master Jul 31, 2017
javanna added a commit that referenced this pull request Jul 31, 2017
We publish javadocs to artifacts.elastic.co (and snapshots.elastic.co) for a while. This commit adds the link to them to the transport client, low level REST client, sniffer and high level REST client pages.

Closes #23761
javanna added a commit that referenced this pull request Jul 31, 2017
We publish javadocs to artifacts.elastic.co (and snapshots.elastic.co) for a while. This commit adds the link to them to the transport client, low level REST client, sniffer and high level REST client pages.

Closes #23761
javanna added a commit that referenced this pull request Jul 31, 2017
We publish javadocs to artifacts.elastic.co (and snapshots.elastic.co) for a while. This commit adds the link to them to the transport client, low level REST client, sniffer and high level REST client pages.

Closes #23761
@lcawl lcawl removed the v6.1.0 label Dec 12, 2017
@jimczi jimczi added v7.0.0-beta1 and removed v7.0.0 labels Feb 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants