[Security Solution] Cypress documentation updates#86835
Merged
rylnd merged 9 commits intoelastic:masterfrom Jan 5, 2021
Merged
[Security Solution] Cypress documentation updates#86835rylnd merged 9 commits intoelastic:masterfrom
rylnd merged 9 commits intoelastic:masterfrom
Conversation
* Fixes some whitespace/grammar/typos * Condenses the explanation/instructions for the different modes of execution
This is a big sprawling file; trying to cut down on the noise.
This is going to be what 90% of readers are looking for, methinks.
This file was moved as part of elastic#64368.
This file was deleted in elastic#67138.
rylnd
commented
Dec 22, 2020
| See [here](./test/functional/apps/dashboard/reporting/README.md) for more information on running reporting tests. | ||
|
|
||
| #### Running Security Solution Cypress E2E/integration tests | ||
| See [here](./plugins/security_solution/cypress/README.md) for information on running this test suite. |
Contributor
Author
There was a problem hiding this comment.
@tylersmalley I added this link here since this file was linked from the current docs, but it looks like that reference is gone in 7.11.
Any preference on where/how to reference this in the 7.11 documentation?
Member
There was a problem hiding this comment.
I think it's fine only backporting to 7.x/7.12.
dhurley14
reviewed
Dec 22, 2020
dhurley14
reviewed
Dec 22, 2020
Co-authored-by: Devin W. Hurley <snowmiser111@gmail.com>
banderror
approved these changes
Dec 23, 2020
Contributor
banderror
left a comment
There was a problem hiding this comment.
Than's just great!
I wish this doc was available to me when I first started writing Cypress tests recently. While the doc definitely was not bad at all and gave me relevant info (especially comparing to other docs on dev tooling), I had to figure out what test modes exist, what's the proper way to run all tests, develop a new one, etc etc. Wasted some time on trying to run Cypress against my own instance of ES; trying to run a single test in headless mode; thought I was missing some env vars; found a "bug" in start-cypress-open etc.
I especially appreciate that the doc starts from high level (what is that and how to use it) and then goes into details of implementation.
👏
Conflicts: x-pack/plugins/security_solution/cypress/README.md
tylersmalley
approved these changes
Jan 4, 2021
rylnd
added a commit
to rylnd/kibana
that referenced
this pull request
Jan 5, 2021
* Update/refactor some cypress documentation * Fixes some whitespace/grammar/typos * Condenses the explanation/instructions for the different modes of execution * Condense Artifacts section This is a big sprawling file; trying to cut down on the noise. * Move test-running section to top of README This is going to be what 90% of readers are looking for, methinks. * Adds Security Solution's cypress suite to x-pack testing README * Fix broken link This file was moved as part of elastic#64368. * Remove broken link This file was deleted in elastic#67138. * Apply suggestions from code review Co-authored-by: Devin W. Hurley <snowmiser111@gmail.com> * Fix typo Co-authored-by: Devin W. Hurley <snowmiser111@gmail.com>
rylnd
added a commit
that referenced
this pull request
Jan 5, 2021
* Update/refactor some cypress documentation * Fixes some whitespace/grammar/typos * Condenses the explanation/instructions for the different modes of execution * Condense Artifacts section This is a big sprawling file; trying to cut down on the noise. * Move test-running section to top of README This is going to be what 90% of readers are looking for, methinks. * Adds Security Solution's cypress suite to x-pack testing README * Fix broken link This file was moved as part of #64368. * Remove broken link This file was deleted in #67138. * Apply suggestions from code review Co-authored-by: Devin W. Hurley <snowmiser111@gmail.com> * Fix typo Co-authored-by: Devin W. Hurley <snowmiser111@gmail.com> Co-authored-by: Devin W. Hurley <snowmiser111@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
For maintainers