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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Most Java testing framework docs are not relevant for end users #55257

Closed
jrodewig opened this issue Apr 15, 2020 · 3 comments · Fixed by #55270
Closed

[DOCS] Most Java testing framework docs are not relevant for end users #55257

jrodewig opened this issue Apr 15, 2020 · 3 comments · Fixed by #55270
Assignees
@jrodewig
Labels
:Core/Infra/Plugins Plugin API and infrastructure >docs General docs changes

Comments

@jrodewig
Copy link
Contributor

jrodewig commented Apr 15, 2020 •
edited
Loading

In the Java testing framework docs, we state:

The testing framework allows you to setup clusters with multiple nodes in order to check if your code covers everything needed to run in a cluster.

Users, particularly application developers, could interpret this as the framework giving them the ability to write tests that hit standard ES endpoints from their application.

However, this content is intended for plugin/integration developers. Those developers can use the framework to test their own custom HTTP endpoint (via an ES plugin).

Proposal

At least, we should clarify the intended audience for the testing docs.

We should also consider migrating the docs to the Plugins and integrations docs, perhaps as a subpage of Help for plugin authors.
@jrodewig jrodewig added >docs General docs changes :Core/Infra/Plugins Plugin API and infrastructure labels Apr 15, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra (:Core/Infra/Plugins)

@jrodewig jrodewig mentioned this issue Apr 15, 2020
Closed
@jrodewig
Copy link
Contributor Author

The team discussed this and decided that removing the Java testing framework docs was
the best course of action. The current docs are very outdated and plugin authors will likely
need more specific guidance.

@jrodewig jrodewig mentioned this issue Apr 15, 2020
Merged
@jrodewig jrodewig self-assigned this Apr 15, 2020
jrodewig added a commit that referenced this issue Apr 21, 2020
@jrodewig
[DOCS] Remove 'Testing' chapter (#55270)
e2fc95d 
Removes the 'Testing' chapter from the Elasticsearch Reference guide.

This chapter was originally written for so that users using the Java HLRC client could
use the same test classes when testing Elasticsearch in their own applications.
However, this is no longer the case or recommended.

Closes #55257.
jrodewig added a commit that referenced this issue Apr 21, 2020
@jrodewig
[DOCS] Remove 'Testing' chapter (#55270) (#55532)
b9dfd12 
Removes the 'Testing' chapter from the Elasticsearch Reference guide.

This chapter was originally written for so that users using the Java HLRC client could
use the same test classes when testing Elasticsearch in their own applications.
However, this is no longer the case or recommended.

Closes #55257.
jrodewig added a commit that referenced this issue Apr 21, 2020
@jrodewig
[DOCS] Remove 'Testing' chapter (#55270)
e4170c1 
Removes the 'Testing' chapter from the Elasticsearch Reference guide.

This chapter was originally written for so that users using the Java HLRC client could
use the same test classes when testing Elasticsearch in their own applications.
However, this is no longer the case or recommended.

Closes #55257.
jrodewig added a commit that referenced this issue Apr 21, 2020
@jrodewig
[DOCS] Remove 'Testing' chapter (#55270)
95a5dac 
Removes the 'Testing' chapter from the Elasticsearch Reference guide.

This chapter was originally written for so that users using the Java HLRC client could
use the same test classes when testing Elasticsearch in their own applications.
However, this is no longer the case or recommended.

Closes #55257.
jrodewig added a commit that referenced this issue Apr 21, 2020
@jrodewig
[DOCS] Remove 'Testing' chapter (#55270)
61f7c19 
Removes the 'Testing' chapter from the Elasticsearch Reference guide.

This chapter was originally written for so that users using the Java HLRC client could
use the same test classes when testing Elasticsearch in their own applications.
However, this is no longer the case or recommended.

Closes #55257.
@jasontedor jasontedor mentioned this issue Jun 25, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jrodewig jrodewig

Labels
:Core/Infra/Plugins Plugin API and infrastructure >docs General docs changes
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[DOCS] Remove 'Testing' chapter
2 participants
@elasticmachine @jrodewig