1. Cncf-Toc
  2. Topics

Documentation recap

Jonathan Boulle <jonathan.boulle@...>
 

Quick summary of the documentation talk in the call today:

- CNCF projects can reach out (Dan: please provide appropriate contact here) for assistance with contracting resources to help with documentation: CNCF will help with recruiting/logistics, then regularly look to project maintainers for approval of the work

- Most projects are using similar documentation sites already (simple Jekyll/GitHub hosted websites that render markdown), probably not a lot to add here

- Projects like Kubernetes are "too big to help" in the sense that they already have large, established infrastructure and processes around managing and publishing documentation; CNCF can help with some content though

- Brian G had concerns about long ramp-up time with random contractors; perhaps instead we can re-use a resource that becomes familiar with the projects (especially as they intersect)

- Another area Kubernetes could use help is homepage design - perhaps this is also something we can provide an optional consistent design for projects?


anything I missed?
alexis richardson
 

Two tiny addenda

Dan mentioned that cncf could help kube by eg funding editorial polish for otherwise raw content.

There was a discussion about the gamification of non-feature contributions, and the kube/cncf pilot of this.


On Wed, 1 Mar 2017, 18:09 Jonathan Boulle via cncf-toc, <cncf-toc@...> wrote:
Quick summary of the documentation talk in the call today:

- CNCF projects can reach out (Dan: please provide appropriate contact here) for assistance with contracting resources to help with documentation: CNCF will help with recruiting/logistics, then regularly look to project maintainers for approval of the work

- Most projects are using similar documentation sites already (simple Jekyll/GitHub hosted websites that render markdown), probably not a lot to add here

- Projects like Kubernetes are "too big to help" in the sense that they already have large, established infrastructure and processes around managing and publishing documentation; CNCF can help with some content though

- Brian G had concerns about long ramp-up time with random contractors; perhaps instead we can re-use a resource that becomes familiar with the projects (especially as they intersect)

- Another area Kubernetes could use help is homepage design - perhaps this is also something we can provide an optional consistent design for projects?


anything I missed?
_______________________________________________
cncf-toc mailing list
cncf-toc@...
https://lists.cncf.io/mailman/listinfo/cncf-toc
Dan Kohn <dan@...>
 

CNCF projects should contact Sarah Conway (cc'ed) and myself for documentation funding.

The beta test I mentioned for gamification of activity (and which I encourage you to try and comment on) is http://k8sport.org/.

On Wed, Mar 1, 2017 at 1:14 PM, Alexis Richardson via cncf-toc <cncf-toc@...> wrote:

Two tiny addenda

Dan mentioned that cncf could help kube by eg funding editorial polish for otherwise raw content.

There was a discussion about the gamification of non-feature contributions, and the kube/cncf pilot of this.


On Wed, 1 Mar 2017, 18:09 Jonathan Boulle via cncf-toc, <cncf-toc@...> wrote:
Quick summary of the documentation talk in the call today:

- CNCF projects can reach out (Dan: please provide appropriate contact here) for assistance with contracting resources to help with documentation: CNCF will help with recruiting/logistics, then regularly look to project maintainers for approval of the work

- Most projects are using similar documentation sites already (simple Jekyll/GitHub hosted websites that render markdown), probably not a lot to add here

- Projects like Kubernetes are "too big to help" in the sense that they already have large, established infrastructure and processes around managing and publishing documentation; CNCF can help with some content though

- Brian G had concerns about long ramp-up time with random contractors; perhaps instead we can re-use a resource that becomes familiar with the projects (especially as they intersect)

- Another area Kubernetes could use help is homepage design - perhaps this is also something we can provide an optional consistent design for projects?


anything I missed?
_______________________________________________
cncf-toc mailing list
cncf-toc@...
https://lists.cncf.io/mailman/listinfo/cncf-toc

_______________________________________________
cncf-toc mailing list
cncf-toc@...
https://lists.cncf.io/mailman/listinfo/cncf-toc




--
Dan Kohn <mailto:dan@...>
Executive Director, Cloud Native Computing Foundation <https://cncf.io/>
tel:+1-415-233-1000
Kenneth Owens (kenowens) <kenowens@...>
 

We can also host a documentation hackathon at various meet-ups. Cost is typically pizza and soda.

 

banner2

 

Kenneth Owens

CTO

kenowens@...

Tel: +1 408 424 0872

Cisco Systems, Inc.

16401 Swingley Ridge Road Suite 400
CHESTERFIELD
63017
United States
cisco.com

 

Think before you print.

This email may contain confidential and privileged material for the sole use of the intended recipient. Any review, use, distribution or disclosure by others is strictly prohibited. If you are not the intended recipient (or authorized to receive for the recipient), please contact the sender by reply email and delete all copies of this message.

Please click here for Company Registration Information.

 

From: cncf-toc-bounces@... [mailto:cncf-toc-bounces@...] On Behalf Of Dan Kohn via cncf-toc
Sent: Wednesday, March 1, 2017 12:17 PM
To: Alexis Richardson <alexis@...>
Cc: CNCF TOC <cncf-toc@...>
Subject: Re: [cncf-toc] Documentation recap

 

CNCF projects should contact Sarah Conway (cc'ed) and myself for documentation funding.

 

The beta test I mentioned for gamification of activity (and which I encourage you to try and comment on) is http://k8sport.org/.

 

On Wed, Mar 1, 2017 at 1:14 PM, Alexis Richardson via cncf-toc <cncf-toc@...> wrote:

Two tiny addenda

Dan mentioned that cncf could help kube by eg funding editorial polish for otherwise raw content.

There was a discussion about the gamification of non-feature contributions, and the kube/cncf pilot of this.

 

On Wed, 1 Mar 2017, 18:09 Jonathan Boulle via cncf-toc, <cncf-toc@...> wrote:

Quick summary of the documentation talk in the call today:

 

- CNCF projects can reach out (Dan: please provide appropriate contact here) for assistance with contracting resources to help with documentation: CNCF will help with recruiting/logistics, then regularly look to project maintainers for approval of the work

 

- Most projects are using similar documentation sites already (simple Jekyll/GitHub hosted websites that render markdown), probably not a lot to add here

 

- Projects like Kubernetes are "too big to help" in the sense that they already have large, established infrastructure and processes around managing and publishing documentation; CNCF can help with some content though

 

- Brian G had concerns about long ramp-up time with random contractors; perhaps instead we can re-use a resource that becomes familiar with the projects (especially as they intersect)

 

- Another area Kubernetes could use help is homepage design - perhaps this is also something we can provide an optional consistent design for projects?

 

 

anything I missed?

_______________________________________________
cncf-toc mailing list
cncf-toc@...
https://lists.cncf.io/mailman/listinfo/cncf-toc


_______________________________________________
cncf-toc mailing list
cncf-toc@...
https://lists.cncf.io/mailman/listinfo/cncf-toc



 

--

Dan Kohn <mailto:dan@...>

Executive Director, Cloud Native Computing Foundation <https://cncf.io/>
tel:+1-415-233-1000

1 - 4 of 4