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

CNCFSD-1008 Docs assessment for KEDA #87

Closed
Tracked by #120 ...
nate-double-u opened this issue Nov 18, 2021 · 8 comments · Fixed by #215
Closed
Tracked by #120 ...

CNCFSD-1008 Docs assessment for KEDA #87

nate-double-u opened this issue Nov 18, 2021 · 8 comments · Fixed by #215
Assignees
Labels
CNCF Service Desk This issue has a related CNCF Service Desk ticket Docs analysis CNCF technical documentation assistance

Comments

@nate-double-u
Copy link
Member

As per discussions around CNCFSD-1008, let's do a Docs Assessment to help KEDA with their website improvement project.

@nate-double-u nate-double-u added documentation Improvements or additions to the TechDocs documentation e2-days Effort: < 5 days labels Nov 18, 2021
@tomkerkhove
Copy link

tomkerkhove commented Nov 19, 2021

Thank you!

Relates to kedacore/governance#40

@nate-double-u nate-double-u self-assigned this Dec 2, 2021
@nate-double-u nate-double-u added the CNCF Service Desk This issue has a related CNCF Service Desk ticket label Feb 17, 2022
@nate-double-u nate-double-u changed the title Docs assessment for KEDA CNCFSD-1008 Docs assessment for KEDA Feb 18, 2022
@nate-double-u
Copy link
Member Author

nate-double-u commented Jun 17, 2022

@tomkerkhove
Copy link

Adding @zroubalik who has ideas to improve our docs as well.

@nate-double-u
Copy link
Member Author

Hi @@zroubalik, please let me know if you're not able to access the doc. I think it's set up so that signed in users can edit. (trusting security through obscurity -- if an open link becomes problematic for this draft we can change the permissions)

@zroubalik
Copy link

zroubalik commented Jun 24, 2022

@nate-double-u I am able to access the doc, thanks!

What I would like to see is to change KEDA documentation https://keda.sh/docs/2.7/ to something like https://docs.keda.sh - ie basically to have a project landing page as it is now, but to have a separate page for docs. Something like https://dapr.io/ and https://docs.dapr.io/, where:

  • the left hand side menu has layout similar to what we can see on Dapr docs
  • where we can easily see the current docs version (and have a way how to easily switch it)

@tomkerkhove
Copy link

tomkerkhove commented Jun 24, 2022

I love that idea to have keda.sh as a "business related page" vs docs.keda.sh which has technical docs

@thisisobate
Copy link
Collaborator

Sounds good to me. This would warrant creating a more detailed information on the docs' landing page since the current one looks scanty.

Regardless, will discuss more with @nate-double-u about this.
Thanks for the suggestion @zroubalik!

@nate-double-u
Copy link
Member Author

Updated docs analysis PR: #215

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CNCF Service Desk This issue has a related CNCF Service Desk ticket Docs analysis CNCF technical documentation assistance
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

5 participants