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: Introduce troubleshooting guide for Azure Service Bus #1269

Merged
merged 3 commits into from
Jan 16, 2024

Conversation

tomkerkhove
Copy link
Member

Based on kedacore/keda#5227, I had a quick idea to start introducing troubleshooting guides to reduce the load on maintainers/community and document recurring issues.

Currently this is added to the same page as the scaler, but we should integrate scalers in to our existing "troubleshooting" section over time.

Checklist

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

Relates to kedacore/keda#5227

@tomkerkhove tomkerkhove requested a review from a team as a code owner December 1, 2023 08:49
Copy link

netlify bot commented Dec 1, 2023

Deploy Preview for keda ready!

Name Link
🔨 Latest commit e7c37f4
🔍 Latest deploy log https://app.netlify.com/sites/keda/deploys/65a654d17bac460008e187ce
😎 Deploy Preview https://deploy-preview-1269--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 site configuration.

Copy link

github-actions bot commented Dec 1, 2023

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:

@tomkerkhove
Copy link
Member Author

What do you think about this idea @zroubalik / @JorTurFer

@tomkerkhove tomkerkhove changed the title docs: Introduce troubleshooting guide docs: Introduce troubleshooting guide for Azure Service Bus Dec 1, 2023
@JorTurFer
Copy link
Member

Maybe we can create a new secction for these stuff, and include FAQ and troubleshooting pages. Troubleshooting info looks quite fragmentated between FAQ, troubleshooring, and now in page

@JorTurFer
Copy link
Member

Just to clarify, I'd move to a versioned section, because fixes related with v2.X can apply to v2.Y or not

@tomkerkhove
Copy link
Member Author

I agree and that is also why I added this:

Currently this is added to the same page as the scaler, but we should integrate scalers in to our existing "troubleshooting" section over time.

However, I am not sure if we should do it now already or in the future. Currently I think we should just add this to scalers for now and once we have more scenarios we can look at how we can support it and what the needs are (instead of assuming)

@JorTurFer
Copy link
Member

JorTurFer commented Dec 1, 2023

yeah, definitivelly!
Let's add close to the scalers for the moment, but let's start to think about how we can improve the troubleshooting sections for the future. Let me open an issue to track it

@JorTurFer
Copy link
Member

#1270

@tomkerkhove tomkerkhove enabled auto-merge (squash) December 1, 2023 10:53
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.

Is this relevant only to 2.12?

@JorTurFer
Copy link
Member

Is this relevant only to 2.12?

I think that it's interesting in general

@tomkerkhove
Copy link
Member Author

@zroubalik @JorTurFer as mentioned above, wanted to know if you think it's the right place to start before applying it everywhere.

I think that is not fully answered yet, once it is I will expand it to all versions

@tomkerkhove
Copy link
Member Author

Shall we merge this or do we look for alternative ways @zroubalik @JorTurFer ?

@JorTurFer
Copy link
Member

We can merge it IMO (but add it to v2.13 too)

@tomkerkhove
Copy link
Member Author

Ugh I love GitHub codespaces messing up DCO

@tomkerkhove tomkerkhove merged commit fb21829 into main Jan 16, 2024
8 checks passed
@tomkerkhove tomkerkhove deleted the tomkerkhove-patch-1 branch January 16, 2024 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants