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

Redesign how we present troubleshooting information

Open JorTurFer opened this issue 1 year ago • 4 comments
trafficstars

Currently, troubleshooting information is a bit fragmented across different pages:

  • https://keda.sh/docs/2.12/troubleshooting/
  • https://keda.sh/docs/2.12/faq/
  • Scaler pages

Although all of them look as versioned, only the last one (scaler pages) is versioned, so we have different paged for serving the troubleshooting versions, some of them versioned, other not versioned...

I think that we should rethink this section to make it more usable and user friendly. IMHO it's a high value change because if the FAQ/troubleshooting information is easily discoverable, we can reduce the overhead answering to user questions and users will be more happy because they can solve the issues by themself.

My proposal is generating a troubleshooting section with all this information available and and in page search to look for info by keywords. This section can contain some subsections/pages:

  • FAQ
  • General
  • Scalers
    • Scaler that requires info
    • ...
  • Auths
    • Auth that requires info
    • ....

JorTurFer avatar Dec 01 '23 09:12 JorTurFer

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Jan 30 '24 23:01 stale[bot]

@tomkerkhove , we could include this as part of next round of work from CNCF?

JorTurFer avatar Jan 31 '24 00:01 JorTurFer

Goal is to have it yet, project is associated

tomkerkhove avatar Feb 01 '24 10:02 tomkerkhove

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Apr 01 '24 19:04 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Jun 01 '24 10:06 stale[bot]

This issue has been automatically closed due to inactivity.

stale[bot] avatar Jun 08 '24 14:06 stale[bot]

I didn't catch that this had been closed. Is this work still needed?

nate-double-u avatar Aug 23 '24 20:08 nate-double-u

It was closed by inactivity but it's still required

JorTurFer avatar Oct 06 '24 20:10 JorTurFer