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

Redesign how we present troubleshooting information #1270

Open
Tracked by #221
JorTurFer opened this issue Dec 1, 2023 · 8 comments
Open
Tracked by #221

Redesign how we present troubleshooting information #1270

JorTurFer opened this issue Dec 1, 2023 · 8 comments

Comments

@JorTurFer
Copy link
Member

Currently, troubleshooting information is a bit fragmented across different 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
    • ....
Copy link

stale bot commented Jan 30, 2024

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 stale bot added the stale All issues that are marked as stale due to inactivity label Jan 30, 2024
@JorTurFer
Copy link
Member Author

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

@JorTurFer JorTurFer removed the stale All issues that are marked as stale due to inactivity label Jan 31, 2024
@tomkerkhove
Copy link
Member

Goal is to have it yet, project is associated

Copy link

stale bot commented Apr 1, 2024

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 stale bot added the stale All issues that are marked as stale due to inactivity label Apr 1, 2024
@tomkerkhove tomkerkhove removed the stale All issues that are marked as stale due to inactivity label Apr 2, 2024
Copy link

stale bot commented Jun 1, 2024

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 stale bot added the stale All issues that are marked as stale due to inactivity label Jun 1, 2024
Copy link

stale bot commented Jun 8, 2024

This issue has been automatically closed due to inactivity.

@nate-double-u
Copy link
Contributor

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

@JorTurFer JorTurFer reopened this Oct 6, 2024
@stale stale bot removed the stale All issues that are marked as stale due to inactivity label Oct 6, 2024
@JorTurFer
Copy link
Member Author

It was closed by inactivity but it's still required

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

3 participants