Culling Getting Started Guides

[Ilya Dmitrichenko]

Hi Folks,

Over time, a number of Getting Started Guides had been contributed to Kubernetes website.

General quality and levels of maintenance of all of these guides vary. Some achieve similarly

end goals with different tools. At sig-cluster-lifecycle, we believe that the best way to ensure

all documentation related to cluster provisioning and bootstrap that is published on the website

results in a conformant cluster configuration.

We would like to enforce conformance rules on getting started guides, and remove any guides

that result in non-conformant cluster configuration by end of March (i.e. after 1.10 release).

Before we go ahead and implement this, we would like to hear from sig-docs folks and any

maintainers or users of getting started guides.

Best Regards,

Ilya Dmitrichenko (@errordeveloper) / Weave DX 

[Chris Short]

My only suggestion is that we ensure that we redirect old URLs to the definitive guide.

Chris Short

https://chrisshort.net

https://devopsish.com

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-docs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-docs+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-docs@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-sig-docs/CA%2BnCH1CybTeY22vxxa3UssX7m9QCd1ZCrq-uxh8tScmcPwL-Vw%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

[Ihor Dvoretskyi]

Strongly agree on this.

On Wednesday, January 10, 2018, 'Chris Short' via kubernetes-sig-docs <kubernete...@googlegroups.com> wrote:

My only suggestion is that we ensure that we redirect old URLs to the definitive guide.

Chris Short

https://chrisshort.net

https://devopsish.com

On Wed, Jan 10, 2018 at 11:28 AM, Ilya Dmitrichenko <il...@weave.works> wrote:

Hi Folks,

Over time, a number of Getting Started Guides had been contributed to Kubernetes website.

General quality and levels of maintenance of all of these guides vary. Some achieve similarly

end goals with different tools. At sig-cluster-lifecycle, we believe that the best way to ensure

all documentation related to cluster provisioning and bootstrap that is published on the website

results in a conformant cluster configuration.

We would like to enforce conformance rules on getting started guides, and remove any guides

that result in non-conformant cluster configuration by end of March (i.e. after 1.10 release).

Before we go ahead and implement this, we would like to hear from sig-docs folks and any

maintainers or users of getting started guides.

Best Regards,

Ilya Dmitrichenko (@errordeveloper) / Weave DX 

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-docs" group.

To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-docs+unsubscribe...@googlegroups.com.

To post to this group, send email to kubernetes-sig-docs@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-sig-docs/CA%2BnCH1CybTeY22vxxa3UssX7m9QCd1ZCrq-uxh8tScmcPwL-Vw%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-docs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-docs+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-docs@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-sig-docs/CANJhP0weWiRAHOfKiuSu3i8a8pchX9oJTOaba-JXtboP6MdsQw%40mail.gmail.com.

[Steve Perry]

I've added this to the agenda for our SIG Docs meeting. At first glance, I think it's a good idea.

On Wed, Jan 10, 2018 at 9:15 AM, Ihor Dvoretskyi <ihor.dv...@gmail.com> wrote:

Strongly agree on this.

To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-sig-docs/CANJhP0weWiRAHOfKiuSu3i8a8pchX9oJTOaba-JXtboP6MdsQw%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-docs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-docs+unsub...@googlegroups.com.
To post to this group, send email to kubernetes-sig-docs@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-sig-docs/CA%2BhxP0t4EEv5ADM%3DM8_tSr4PAXd1D5s%3Dkz%3DOxO%2B%2B0fO%3DS48TCA%40mail.gmail.com.

[Tim Pepper]

On Wednesday, January 10, 2018 at 8:28:19 AM UTC-8, Ilya Dmitrichenko wrote:

We would like to enforce conformance rules on getting started guides, and remove any guides

that result in non-conformant cluster configuration by end of March (i.e. after 1.10 release).

Are there plans for how the conformance will be determined?  I'd be interested to see definitive, confirming guides set up in a way that enables them to be a a part of CI automation. 

Tim

[Ihor Dvoretskyi]

It's already determined https://github.com/cncf/k8s-conformance 

--
You received this message because you are subscribed to the Google Groups "Kubernetes developer/contributor discussion" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-de...@googlegroups.com.
To post to this group, send email to kuberne...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-dev/f4d7088e-8ff0-412f-9a49-94085738ef3f%40googlegroups.com.

[Tim Pepper]

On Wednesday, January 10, 2018 at 1:42:51 PM UTC-8, Ihor Dvoretskyi wrote:

It's already determined https://github.com/cncf/k8s-conformance 

I meant more practically:  Who sets up the underlying infra?  Who follows the guide?  Who runs Sonobouy on the results of this setup?  Who asserts and records results?  When does this happen? How is it all version controlled?

[Robert Bailey]

The intent (as discussed during the sig cluster lifecycle meeting) is that each getting started guide maintainer is responsible for providing proof of conformance. We haven't worked out the details of how that is vetted, but we wanted to send out a very early notice so that folks that are interested in keeping their guides in the official documentation have plenty of time to ensure that they can pass the conformance suites. 

I would expect more details about the practical mechanics of vetting guides and removing non-conformant guides to be shared as we approach the 1.10 release date. 

 

 

--
You received this message because you are subscribed to the Google Groups "Kubernetes developer/contributor discussion" group.

To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-dev+unsubscribe@googlegroups.com.
To post to this group, send email to kubernetes-dev@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-dev/e499f11c-eaba-4c2d-b034-ce2494a990df%40googlegroups.com.

[Ilya Dmitrichenko]

On Wed, Jan 10, 2018 at 4:50 PM Chris Short <ch...@chrisshort.net> wrote:

My only suggestion is that we ensure that we redirect old URLs to the definitive guide.

Yes, definetly.

 

Chris Short

https://chrisshort.net

https://devopsish.com

On Wed, Jan 10, 2018 at 11:28 AM, Ilya Dmitrichenko <il...@weave.works> wrote:

Hi Folks,

Over time, a number of Getting Started Guides had been contributed to Kubernetes website.

General quality and levels of maintenance of all of these guides vary. Some achieve similarly

end goals with different tools. At sig-cluster-lifecycle, we believe that the best way to ensure

all documentation related to cluster provisioning and bootstrap that is published on the website

results in a conformant cluster configuration.

We would like to enforce conformance rules on getting started guides, and remove any guides

that result in non-conformant cluster configuration by end of March (i.e. after 1.10 release).

Before we go ahead and implement this, we would like to hear from sig-docs folks and any

maintainers or users of getting started guides.

Best Regards,

Ilya Dmitrichenko (@errordeveloper) / Weave DX 

--
You received this message because you are subscribed to the Google Groups "kubernetes-sig-docs" group.

To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-sig-...@googlegroups.com.
To post to this group, send email to kubernete...@googlegroups.com.

[Ilya Dmitrichenko]

Folks,

Thanks for the discussion so far. Looking forward to talking more at the next sig-docs meeting.

It'd help if we could make sure to reach out to original authors of guides, I wouldn't imagine that

many of them attend sig-docs calls regularly, perhaps we could just email them after we reach

a conclusion within sig-docs and ask for comments, what do people think?

Best,

Ilya 

On Thu, Jan 11, 2018 at 7:54 AM 'Robert Bailey' via Kubernetes developer/contributor discussion <kuberne...@googlegroups.com> wrote:

On Wed, Jan 10, 2018 at 1:52 PM, Tim Pepper <tpe...@vmware.com> wrote:

On Wednesday, January 10, 2018 at 1:42:51 PM UTC-8, Ihor Dvoretskyi wrote:

It's already determined https://github.com/cncf/k8s-conformance 

I meant more practically:  Who sets up the underlying infra?  Who follows the guide?  Who runs Sonobouy on the results of this setup?  Who asserts and records results?  When does this happen? How is it all version controlled?

The intent (as discussed during the sig cluster lifecycle meeting) is that each getting started guide maintainer is responsible for providing proof of conformance. We haven't worked out the details of how that is vetted, but we wanted to send out a very early notice so that folks that are interested in keeping their guides in the official documentation have plenty of time to ensure that they can pass the conformance suites. 

I would expect more details about the practical mechanics of vetting guides and removing non-conformant guides to be shared as we approach the 1.10 release date. 

--
You received this message because you are subscribed to the Google Groups "Kubernetes developer/contributor discussion" group.

To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-de...@googlegroups.com.
To post to this group, send email to kuberne...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-dev/e499f11c-eaba-4c2d-b034-ce2494a990df%40googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--

You received this message because you are subscribed to the Google Groups "Kubernetes developer/contributor discussion" group.

To unsubscribe from this group and stop receiving emails from it, send an email to kubernetes-de...@googlegroups.com.
To post to this group, send email to kuberne...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/kubernetes-dev/CABzR8%3D1pa-MzfSrtRsOLDOwhu31LhjU-zL-RqXNn1kodsMwxCQ%40mail.gmail.com.

[Ilya Dmitrichenko]

Hey sig-docs folks,

Thanks very much for the discussion on the call yesterday!

From the minutes:

• SIG-Docs: All in favor

• SIG Cluster Lifecycle will open a PR of GSGs to remove (Ilya)

• Reach out to owners for state of guide conformance?

• Add conformance/GSG removal to in-flight guide (Zach)

I will follow-up with the action items shortly.

Kind Regards,

Ilya / Weave DX