search

kubernetes-sigs / sig-windows-tools

Repository for tools and artifacts related to the sig-windows charter in Kubernetes. Scripts to assist kubeadm and wincat and flannel will be hosted here.
Apache License 2.0
123 stars 123 forks source link

docs: Consistent format of versions input for scripts #352

Closed mloskot closed 8 months ago

mloskot commented 8 months ago

Reason for PR:

This make versions input a no-brainer as currently it may alert users with unnecessary questions "is that a typo? which one is correct? shall I use v prefix for the ContainerD installer?", etc.

The PrepareNode.ps1 can handle both formats X.Y.Z and vX.Y.Z though, but one has to read the script to learn it.

Issue Fixed:

Issue #

Requirements

Notes:

k8s-ci-robot commented 8 months ago

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: mloskot Once this PR has been reviewed and has the lgtm label, please assign jsturtevant for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files: - **[OWNERS](https://github.com/kubernetes-sigs/sig-windows-tools/blob/master/OWNERS)** Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
k8s-ci-robot commented 8 months ago

Welcome @mloskot!

It looks like this is your first PR to kubernetes-sigs/sig-windows-tools 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/sig-windows-tools has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. :smiley:

marosset commented 8 months ago

This make versions input a no-brainer as currently it may alert users with unnecessary questions "is that a typo? which one is correct? shall I use v prefix for the ContainerD installer?", etc.

I'm in favor of using the v prefix everywhere personally

mloskot commented 8 months ago

Yes, I have realised v prefix is de-facto a standard convention used across Kubernetes tooling.