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

Add readme for functional tests. #21175

Conversation

stacey-gammon
Copy link
Contributor

Includes some tips and best practices to help with test stability.

@stacey-gammon stacey-gammon force-pushed the 2018-07-24-functional-test-tips branch from 5cd4e6b to 4a94493 Compare July 24, 2018 19:31
Copy link
Contributor

@bmcconaghy bmcconaghy left a comment

Choose a reason for hiding this comment

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

LGTM, thanks so much for jumping on this. Very helpful.

Copy link
Contributor

@nreese nreese left a comment

Choose a reason for hiding this comment

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

great start for documenting better testing practices. Should contributing.md link to this readme. My only concern is having developers actually find this

lgtm
code review

@elasticmachine
Copy link
Contributor

💔 Build Failed

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@stacey-gammon
Copy link
Contributor Author

Should contributing.md link to this readme. My only concern is having developers actually find this

Great point Nathan. Now that I go digging though, it turns out there is already similar documentation on our developer docs here: https://www.elastic.co/guide/en/kibana/current/development-functional-tests.html#_functional_test_timing

So I guess I should have actually added this info there?

This is pretty confusing. Where are we supposed to be putting developer documentation? in md's in the repo, or in the external docs? Both are pretty bad options IMO, @timroes had some very cool ideas about better developer documentation.

For the short term, I'm going to abandon this, with the eventual goal of merging it with the current developer documentation. Otherwise we will now just have two sources of truth that will get out of sync, and an even more confusing experience of where documentation should actually go.

cc @archanid, in case you have any extra background, since you recently modified the functional test documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants