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

Reorganize the Documentation Table of Contents #1362

Closed
3 of 4 tasks
Tracked by #1361 ...
dwelsch-esi opened this issue Apr 12, 2024 · 3 comments
Closed
3 of 4 tasks
Tracked by #1361 ...

Reorganize the Documentation Table of Contents #1362

dwelsch-esi opened this issue Apr 12, 2024 · 3 comments
Labels
stale All issues that are marked as stale due to inactivity

Comments

@dwelsch-esi
Copy link
Contributor

dwelsch-esi commented Apr 12, 2024

Reorganize the Table of Contents (TOC; the left-hand menu on the documentation page):

Among the benefits of this change are:

  • Better welcome and orient new users
  • Separate user roles (personas), if there are more than one
  • Improve findability and access to tasks and procedures
  • Separate conceptual, task, and reference information

This issue tracks recommended changes resulting from an analysis of the KEDA documentation commissioned by CNCF. The analysis and supporting documents are here: https://github.com/cncf/techdocs/tree/main/assessments/0011-keda/

Use-Case

Other issues describe reorganization to be done within the top-level sections of the TOC. For convenience, the issues are listed here.

Specification

Here is a proposed high-level outline for the tech doc Table of Contents.

@dwelsch-esi dwelsch-esi changed the title Reorganize the Documentaiton Table of Contents Reorganize the Documentation Table of Contents Apr 12, 2024
Copy link

stale bot commented Aug 20, 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 Aug 20, 2024
Copy link

stale bot commented Aug 27, 2024

This issue has been automatically closed due to inactivity.

@stale stale bot closed this as completed Aug 27, 2024
@nate-double-u
Copy link
Contributor

I'm not sure this has been completed, if it was just the bit that closed this could we reopen it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale All issues that are marked as stale due to inactivity
Projects
Status: Done
Development

No branches or pull requests

2 participants