Skip to content

(feat): Add sumologic scaler documentation#1566

Merged
JorTurFer merged 7 commits intokedacore:mainfrom
mittalvaibhav1:sumologic
Jul 10, 2025
Merged

(feat): Add sumologic scaler documentation#1566
JorTurFer merged 7 commits intokedacore:mainfrom
mittalvaibhav1:sumologic

Conversation

@mittalvaibhav1
Copy link
Contributor

@mittalvaibhav1 mittalvaibhav1 commented Apr 26, 2025 •
edited
Loading

Added sumologic scaler documentation for potentially v2.18 release.

Github issue: kedacore/keda#6734
PR: kedacore/keda#6736

Checklist

  • Commits are signed with Developer Certificate of Origin (DCO)

@mittalvaibhav1 mittalvaibhav1 requested a review from a team as a code owner April 26, 2025 21:19
@github-actions
Copy link

github-actions bot commented Apr 26, 2025

Thank you for your contribution! 🙏 We will review your PR as soon as possible.

While you are waiting, make sure to:

  • Add your contribution to all applicable KEDA versions
  • GitHub checks are passing
  • Is the DCO check failing? Here is how you can fix DCO issues

Learn more about:

@netlify
Copy link

netlify bot commented Apr 26, 2025 •
edited
Loading

✅ Deploy Preview for keda ready!

Name Link
🔨 Latest commit e319394
🔍 Latest deploy log https://app.netlify.com/projects/keda/deploys/68701ad995d2f30008237f48
😎 Deploy Preview https://deploy-preview-1566--keda.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

This was referenced Apr 26, 2025
Merged
Closed
@mittalvaibhav1
(feat): Add sumologic scaler documentation
203c56a 
Signed-off-by: mittalvaibhav1 <mittalvaibhavandroid@gmail.com>
@mittalvaibhav1
(feat): Update sumologic scaler documentation
f36412f 
Signed-off-by: mittalvaibhav1 <mittalvaibhavandroid@gmail.com>
zroubalik
zroubalik reviewed Jul 7, 2025
View reviewed changes
Copy link
Member

@zroubalik zroubalik left a comment

Choose a reason for hiding this comment

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

Nice, could you please move the Autenthication Paramaters down below, so this scaler's docs are aligned with other

Also would be nice to add at the beginning a short explanation on the different types used.

In general, the more we can align this with other scalers' docs the better

@wozniakjan wozniakjan mentioned this pull request Jul 10, 2025
Closed
22 tasks
@mittalvaibhav1
(feat): Address comments
39f20b4 
Signed-off-by: mittalvaibhav1 <mittalvaibhavandroid@gmail.com>
@mittalvaibhav1 mittalvaibhav1 requested a review from zroubalik July 10, 2025 13:29
wozniakjan
wozniakjan approved these changes Jul 10, 2025
View reviewed changes
Copy link
Member

@wozniakjan wozniakjan left a comment

Choose a reason for hiding this comment

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

lgtm, thank you!

@wozniakjan
Copy link
Member

wozniakjan commented Jul 10, 2025

@zroubalik @JorTurFer the failure from links check is imho false alarm

htmltest started at 01:30:48 on public
========================================================================
docs/2.18/scalers/sumologic/index.html
  target does not exist --- docs/2.18/scalers/sumologic/index.html --> /docs/2.17/scalers/sumologic/
========================================================================
✘✘✘ failed in 7.760005202s

there shouldn't be any version of this in 2.17 because it will be released in 2.18, am I missing something?

@mittalvaibhav1
Merge remote-tracking branch 'upstream/main' into sumologic
a52021c 
Signed-off-by: mittalvaibhav1 <mittalvaibhavandroid@gmail.com>
@mittalvaibhav1
Copy link
Contributor Author

mittalvaibhav1 commented Jul 10, 2025

Looks like it needs a approval again

@JorTurFer
Copy link
Member

JorTurFer commented Jul 10, 2025 •
edited
Loading

@zroubalik @JorTurFer the failure from links check is imho false alarm

htmltest started at 01:30:48 on public
========================================================================
docs/2.18/scalers/sumologic/index.html
  target does not exist --- docs/2.18/scalers/sumologic/index.html --> /docs/2.17/scalers/sumologic/
========================================================================
✘✘✘ failed in 7.760005202s

there shouldn't be any version of this in 2.17 because it will be released in 2.18, am I missing something?

A temporal exception should be added to here:

keda-docs/.htmltest.yml

Lines 8 to 11 in 4bbb50e

IgnoreURLs:
# Temporal ignores
# Deprecated and removed resources

This happens because v2.18 isn't the "current" version so there is a link from v2.18 to 2.17 that doesn't exist, currently adding the exception is the only option. Let me check if we can solve it better in some way for links checker, but for the moment, let's add the exception in the file

@mittalvaibhav1
(feat): Address comments
0ad4797 
Signed-off-by: mittalvaibhav1 <mittalvaibhavandroid@gmail.com>
@mittalvaibhav1
Copy link
Contributor Author

mittalvaibhav1 commented Jul 10, 2025

@JorTurFer - Added in 0ad4797 similar to b423c03

JorTurFer
JorTurFer requested changes Jul 10, 2025
View reviewed changes
Copy link
Member

@JorTurFer JorTurFer left a comment

Choose a reason for hiding this comment

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

Thanks a lot for the contribution, let's align the style with the style guide for scaler docs -> https://github.com/kedacore/keda-docs/blob/main/CONTRIBUTING.md#writing-documentation-for-a-scaler

we shouldn't use tables

@JorTurFer JorTurFer mentioned this pull request Jul 10, 2025
Merged
1 task
@JorTurFer
Copy link
Member

JorTurFer commented Jul 10, 2025 •
edited
Loading

Sorry for bothering with the exclusion, but we have merged a fix for it and the exclusion shouldn't be longer needed, please update your branch and remove it

@mittalvaibhav1
(feat): Address comments
04852ee 
Signed-off-by: mittalvaibhav1 <mittalvaibhavandroid@gmail.com>
@mittalvaibhav1
Copy link
Contributor Author

mittalvaibhav1 commented Jul 10, 2025

@JorTurFer - removed in 04852ee

@mittalvaibhav1
Merge remote-tracking branch 'upstream/main' into sumologic
e319394 
Signed-off-by: mittalvaibhav1 <mittalvaibhavandroid@gmail.com>
@mittalvaibhav1 mittalvaibhav1 requested a review from JorTurFer July 10, 2025 19:56
@JorTurFer
Copy link
Member

JorTurFer commented Jul 10, 2025

thanks a lot for the contribution! ❤️

@JorTurFer JorTurFer merged commit c23f9d2 into kedacore:main Jul 10, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JorTurFer JorTurFer JorTurFer approved these changes

@zroubalik zroubalik Awaiting requested review from zroubalik

@wozniakjan wozniakjan Awaiting requested review from wozniakjan

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@mittalvaibhav1 @wozniakjan @JorTurFer @zroubalik