[48h Knative] UX Evaluation

[rhuss]

👋 Hello, awesome contributor!

Are you excited about Knative and open-source development? You're in the right place! This is a mini-project for the upcoming 48h Knative event—a 48-hour hackathon designed to boost contributions to the Knative Client project. For more details, check out Issue #1842.

🎯 Project Description

This project is a deliberate non-coding task: It's all about checking out the UX of kn and making improvement suggestions. In that sense, it's a kind of research project.

The criteria that should be applied when looking at kn UI surface:

• Is the naming of options consistent?
• Are the options grouped properly? (e.g., all --scale-... options are about autoscaling and appear together on the help page)
• Is the usage of kn intuitive?
• Does kn follow the usual Unix CLI conventions, e.g., like laid out in Command Line Interface Guidelines

🌟 Benefits

For a CLI tool like kn, a good and intuitive user interface is one of the main drivers. It's not so bad, but verifying where we stand and what can be improved would be great. The output of this hackathon task should be a presentation and/or document with recommendations on what can be improved and, ideally, some new GitHub issues that track those possible improvements.

🛠 Difficulty Level

Intermediate

👥 Recommended Team Size

1-3

🎉 Expected Outcome

Presentation and Document, maybe new GitHub issues (see above)

🤝 Mentor

@rhuss

📝 Additional Information

• Command Line Guidelines: https://clig.dev/

🌐 Entrypoints

---

📋 Organizer Checklist

• Added to Project Board
• Proposal Reviewed
• Assigned a Mentor
• Expected Outcome define

[rhuss]

.

[Cali0707]

cc @knative/ux-wg-leads - this might be interesting to you

[mmejia02]

• Look at linked resource and compare to existing Knative CLI

[Mayaleeeee]

/assign

[Mayaleeeee]

Update

I had a call with @rhuss last week regarding this issue, and we discussed its objectives and goals. Currently, I'm focused on installing the Knative CLI on my Windows machine.

I've reached out to @rhuss and @Leo6Leo, and they are both ready to assist me with the installation.

Thank you both.

cc @mmejia02 @Cali0707 @zainabhusain227

[Leo6Leo]

Some tips might be helpful for people to get started:

1. Understand what is CLI
   https://aws.amazon.com/what-is/cli/
2. Basic understanding on Knative and different components. No need to understand all the technical details.
   https://docs.google.com/presentation/d/1Fi4jq1d7Tl1Q0VHkEjhPkdv-gfxPLIBqaeWod_dezvM/edit#slide=id.g29d1fb0fb05_0_0
3. Install Knative client and how to interact with it
   https://knative.dev/docs/client/

[Mayaleeeee]

Some tips might be helpful for people to get started:

1. Understand what is CLI
   https://aws.amazon.com/what-is/cli/
2. Basic understanding on Knative and different components. No need to understand all the technical details.
   https://docs.google.com/presentation/d/1Fi4jq1d7Tl1Q0VHkEjhPkdv-gfxPLIBqaeWod_dezvM/edit#slide=id.g29d1fb0fb05_0_0
3. Install Knative client and how to interact with it
   https://knative.dev/docs/client/

Thanks, Leo.

[Mayaleeeee]

Update

I met with @Leo6Leo yesterday, and I have been able to install the knative cli on my desktop. The next thing on my agenda is to play around with it and create a Google doc for the documentation.

cc @rhuss @knative/ux-wg-leads

[Mayaleeeee]

I am still very interested in this and intend to continue working on it.