keda-docs icon indicating copy to clipboard operation
keda-docs copied to clipboard

Added note to the deploy.md (on all versions) to make people aware th…

Open HemeraOne opened this issue 1 year ago • 8 comments

…at only a single metric server can handle external.metrics.k8s.io per cluster

Provide a description of what has been changed

Checklist

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

Fixes #

HemeraOne avatar Dec 06 '23 17:12 HemeraOne

Deploy Preview for keda ready!

Name Link
Latest commit 5f2b1345af473055cad6349cd33f0ee8d8f87630
Latest deploy log https://app.netlify.com/sites/keda/deploys/6570b563bc79d60008f14719
Deploy Preview https://deploy-preview-1272--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.

netlify[bot] avatar Dec 06 '23 17:12 netlify[bot]

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:

github-actions[bot] avatar Dec 06 '23 17:12 github-actions[bot]

Hi, this is already documented in the FAQ

tomkerkhove avatar Dec 08 '23 09:12 tomkerkhove

FAQ is not totally visible. I think that we can merge the note as users usually don't check the FAQ until something is not working, but they will see the note before installing

JorTurFer avatar Dec 08 '23 09:12 JorTurFer

If we merge it, then we have 2 places to maintain IMO. We should fix FAQ discoverability instead or change the note to just check FAQ to learn more about metric server limitations

tomkerkhove avatar Dec 08 '23 09:12 tomkerkhove

The problems with FAQ is that it doesn't allow linking it. I mean, this note could be just something like:

NOTE: Check api server limitations here: FAQ_SECTION_LINK

But we can't link those items, that's why I'd merge this, at least until we improve the faq

JorTurFer avatar Dec 08 '23 10:12 JorTurFer

Well, we can just fix that @JorTurFer 🤷‍♂️

Every item has an achor assigned and can be linked to: https://keda.sh/docs/faq/#can-i-run-multiple-metric-servers-serving-external-metrics-in-the-same-cluster. Please update the docs to just point to this instead please.

I have opened https://github.com/kedacore/keda-docs/pull/1273 to do the same for the categories and https://github.com/kedacore/keda-docs/issues/1274 to provide a button to copy.

tomkerkhove avatar Dec 11 '23 07:12 tomkerkhove

is there any option to open the linked anchor? Default behaviour is browsing to it closed and that's a bit confusing: image

JorTurFer avatar Dec 11 '23 08:12 JorTurFer