docs: Userguide enhancements #890
Conversation
docs/how_to_use.md
Outdated
There was a problem hiding this comment.
As part of this PR - let's rework this file.
"How to use" would be on the first if not the first pages users would like to go to understand how PSA works.
Let's start with some prerequisites, like they have an add-on or an app (please include links to the Splexicon) and they want to make sure their props / transforms are correct. And let's walk a developer through the steps they need to execute to be able to run a successful test when an event is ingested to Splunk, proper test cases are created and tests are executed.
Imagine that you give these instructions to a new joiner who does not know anything about Splunk, TAs and PSA.
There was a problem hiding this comment.
Okay, I will add the details regarding prerequisites and how psa works in the "Home" page. After covering all these details we can put the link to "how_to_use" section to walk the developers through how they can execute the tests
| Search = <Query> | ||
| ``` | ||
|
|
||
| Get the search query from the stack trace and execute it on the Splunk instance and verify which specific event is causing failure. |
There was a problem hiding this comment.
Here searching the query in splunk won't provide much info as we are processing the fields in the test itself, may be we can add what assertion error would show in case of failures.
There was a problem hiding this comment.
Added sample of assertion error message
| pytest-splunk-addon is an open-source dynamic test plugin for Splunk Apps and Add-ons | ||
| which allows the user to test knowledge objects, CIM compatibility and index time properties. | ||
| pytest-splunk-addon is an open-source dynamic test plugin for Splunk [Apps](https://docs.splunk.com/Splexicon:App) and [Add-ons](https://docs.splunk.com/Splexicon:Addon) | ||
| which allows the user to test [knowledge objects](https://docs.splunk.com/Splexicon:Knowledgeobject), [CIM](https://docs.splunk.com/Splexicon:CommonInformationModel) compatibility and [index time properties](https://docs.splunk.com/Splexicon:Indexedfield). |
There was a problem hiding this comment.
Can you verify these links are working?
I did mkdocs serve in my local and its shows just plain text
There was a problem hiding this comment.
Yeah, I verified those links and they are working as expected.
|
🎉 This PR is included in version 5.4.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This PR updates the doc for how_to_use section and add the documentation for requirement tests.
ref: https://splunk.atlassian.net/browse/ADDON-73384