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

Adding instllation guid for kwctl in different OSs #568

Conversation

IbrahimGaberOfficial
Copy link
Contributor

Description

Fix #548 Expand quickstart and mention kwctl

Adding instllation guid for kwctl in different OSs

  • Linux
  • Apple
  • Windows

@flavio Can you please review this installation steps especially Installation for Apple ?

Signed-off-by: IbrahimGaberOfficial <[email protected]>
Signed-off-by: IbrahimGaberOfficial <[email protected]>
Signed-off-by: IbrahimGaberOfficial <[email protected]>
Signed-off-by: IbrahimGaberOfficial <[email protected]>
Signed-off-by: IbrahimGaberOfficial <[email protected]>
-  adding identification for Shell Completions.
Signed-off-by: IbrahimGaberOfficial <[email protected]>
Signed-off-by: IbrahimGaberOfficial <[email protected]>
@IbrahimGaberOfficial IbrahimGaberOfficial requested a review from a team as a code owner March 19, 2025 06:53
Copy link

netlify bot commented Mar 19, 2025

Deploy Preview for docs-kubewarden-io ready!

Name Link
🔨 Latest commit 17033a1
🔍 Latest deploy log https://app.netlify.com/sites/docs-kubewarden-io/deploys/67da6a00727977000767c1a2
😎 Deploy Preview https://deploy-preview-568--docs-kubewarden-io.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@kkaempf kkaempf added the area/documentation Improvements or additions to documentation label Mar 19, 2025
@kkaempf kkaempf added this to the 1.23 milestone Mar 19, 2025
@kkaempf kkaempf requested a review from a team March 19, 2025 08:46
@jhkrug
Copy link
Contributor

jhkrug commented Mar 19, 2025

Hi @IbrahimGaberOfficial. Thanks for taking the time to get involved with this. I've put this PR in 'In Progress' for the moment. While considering this we decided that a more strategic approach would be a good idea.

Currently, there is installation/usage material for kwctl in two places. In the kwctl repo in a README.md and in the docs in the 'howtos/common tasks' section. This PR would add a third location, overlapping with the other two, which already overlap.

In preference then we would like most of the information for installation and usage for kwctl to be in the documentation. With links to it from the kwctl repos/README.md and from the quick start page. It's better to keep the quick start more concise and digestable.

So the scope of the work is going to be:

  • Merge and restructure the kwctl README.md material with the howto/common tasks material to create new
    • howto/install kwctl
    • tutorial/use kwctl
    • very short intro to kwctl in the quick start
  • Remove material from the kwctl README.md and link to relevant docs sections
  • Remove material from the howto/common tasks and link to the new howto/install and tutorial/kwctl

I will create an issue to address these points.

So, would you like to collaborate with me on this? Thanks.

@IbrahimGaberOfficial
Copy link
Contributor Author

Hi @jhkrug
I am interested in working with you as I am interested in your Google Summer of Code (GSOC) project, EPIC: Elevate our .NET SDK into a first-class citizen #47. This project involves documentation, and collaborating with you would provide me with valuable experience in this area. Could you please guide me on what steps I should take next?

@jhkrug
Copy link
Contributor

jhkrug commented Mar 19, 2025

Cool. Give me a day to research and plan a bit more, then do the issues, and then we can get started. Thanks.

While that's happening you could have a read, if you have some time, of the current kwctl docs parts.

https://github.com/kubewarden/kwctl/blob/main/README.md

and

https://docs.kubewarden.io/howtos/tasks#kwctl-cli-tool

@jhkrug jhkrug marked this pull request as draft March 19, 2025 16:33
@IbrahimGaberOfficial
Copy link
Contributor Author

IbrahimGaberOfficial commented Mar 19, 2025

Thank you for the guidance! I’ll take this time to thoroughly read through the kwctl documentation you shared.

@IbrahimGaberOfficial IbrahimGaberOfficial changed the title Adding instllation guid for kwctl in different o ss Adding instllation guid for kwctl in different OSs Mar 20, 2025
@jhkrug
Copy link
Contributor

jhkrug commented Mar 20, 2025

Hi @IbrahimGaberOfficial. I'm closing this PR. We will start looking at this work via: #569. It has 4 sub-issues for you. I'll assign them to you when you accept the invitation that @kkaempf has sent to you.

@jhkrug jhkrug closed this Mar 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Expand quickstart and mention kwctl
3 participants