splunk / splunk/addonfactory-ucc-generator
Docs: Custom Hook Examples showcase TS and TSX but type: external only loads .js
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 85
- Forks
- 36
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 6
Description
What were you searching in the docs?
I was looking for the proper implementation of a custom Hook for "onSave" in example to check reachability of the domain entered in a field of the Configuration page.
Is this related to an existing documentation section?
How can we improve?
Please update https://splunk.github.io/addonfactory-ucc-generator/custom_ui_extensions/context/custom_hook_context/ to describe, how a tsx/ts csutom-hook would be loaded? The globalConfig example only loads .js files.
Got a suggestion in mind?
found the switch --build-custom-ui for the build command. Please update the docs.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the custom hook context documentation at custom_ui_extensions/context/custom_hook_context/ and review the globalConfig example alongside the --build-custom-ui build option mentioned in the issue. Confirm how TS and TSX custom hooks are loaded, then update the page so the supported loading process and a completed example are clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 70/100