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

docs: add documentation descriptions to globalConfig's schema file #1201

Merged
merged 9 commits into from
May 28, 2024

Conversation

soleksy-splunk
Copy link
Contributor

Issue number: ADDON-70521

Summary

Adding documentation descriptions to json schema file.

Changes

Added description for all of fields in json schema file.

User experience

Currently user should be much more comfortable t use just json schema, and do not need to open documentation in second tab to check everything.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

@soleksy-splunk soleksy-splunk requested review from a team as code owners May 21, 2024 08:16
@artemrys artemrys changed the title chore: improve playground feature addon 70521 docs: add documentation descriptions to globalConfig's schema file May 21, 2024
@soleksy-splunk soleksy-splunk requested a review from a team as a code owner May 21, 2024 10:42
@artemrys
Copy link
Member

@hetangmodi-crest please review the changes related to the Alerts

@vtsvetkov-splunk
Copy link
Collaborator

Can we somehow increase visibility of the playground feature? The problem I see that we have to explain where to find it
image
And even if I open it, I don't see the killer feature right away
image

I have to notice that there is a tab JSON Schema where the whole editor is hidden.

Is there any way to add some documentation for stories?
Like here

ui/package.json Outdated Show resolved Hide resolved
@soleksy-splunk
Copy link
Contributor Author

regarding Viktor comment as discussed it will be made with separate ticket and PR

splunk_add_on_ucc_framework/schema/schema.json Outdated Show resolved Hide resolved
@soleksy-splunk soleksy-splunk enabled auto-merge (squash) May 28, 2024 12:25
@soleksy-splunk soleksy-splunk merged commit 7baf14c into develop May 28, 2024
60 of 61 checks passed
@soleksy-splunk soleksy-splunk deleted the chore--improve-Playground-feature-ADDON-70521 branch May 28, 2024 12:43
@github-actions github-actions bot locked and limited conversation to collaborators May 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants