[chef] Re: Re: "Contributing to Chef" entry point

["Julian C. Dunn" < >]

Hi Tensibai,

Thanks so much for your feedback!

I mentioned this briefly in the Gist, but to contribute to the docs
that are hosted at docs.getchef.com, you'll need to know a little (not
a lot) reStructuredText. The RST is processed using Sphinx. You can
submit a PR against github.com/opscode/chef-docs.

Alternately, if you don't want to learn RST and Sphinx, a GitHub issue
against the project will suffice, and our tech writer, James Scott,
will pick that up at some point.

We could probably improve the information at the chef-docs project
with a tour through the organization of all the directories, as well
as the minimum level of RST you need to know to be productive.

- Julian

On Sun, Oct 5, 2014 at 4:07 PM, Tensibai Zhaoying 
<
 >
 wrote:
> Sorry for top posting (phone)
>
> Nice first pass ;) one thing which I believe could be improved is the doc.
> But I'm lost on how to contribute to it since it's not a wiki anymore (I may
> have not searched/read correctly about How to do it)
>
> I've quite regularly on Stackoverflow the idea that the answer is in the
> doc, but I usually end up linking to many parts of the doc and writing a
> small 'glue' over it.
>
> And sometimes, despite being used to the doc site, I can't find the relevant
> page...
>
> I think having a list of the top scored question of SO could help a lot of
> people.
> Sometimes it could be part of the doc (I think of the lwrp naming when the
> cookbook contains hyphens - translated to underscores for resource naming).
> Sometimes it involves understanding 2 or 3 distinct part nicely documented,
> but a description on how they work together is priceless to understand the
> whole concept.
>
> It's my 2cts to what can be done to improve. I may be wrong and I'm Ok with
> any opposite point of view ;)
>
>
>
> ---- Julian C. Dunn a écrit ----
>
>
> Hey all,
>
> One of the things I heard repeatedly at Summit is the need for a
> single entry point for folks who want to contribute to the Chef
> community and don't know how. Yesterday at the hack day I worked on
> this, looking at things like the Chromium "For Developers" page [1]
> and the Fedora Project Wiki [2] for inspiration.
>
> Here's my first pass at this:
> https://gist.github.com/juliandunn/38c841b7ed40050df056
>
> If you have ideas for other things that might be missing on this
> outline, please comment on the Gist.
>
> And here's a great way to contribute: I'm going to need help writing
> some of the articles :-)
>
> - Julian
>
> [1] http://www.chromium.org/developers
> [2] https://fedoraproject.org/wiki/Fedora_Project_Wiki
>
> --
> [ Julian C. Dunn 
> <
 >
>           * Sorry, I'm    ]
> [ WWW: http://www.aquezada.com/staff/julian  &nbsp; * only Web 1.0  ;]
> [ gopher://sdf.org/1/users/keymaker/         &nbsp; * compliant!    ;]
>
> [ PGP: 91B3 7A9D 683C 7C16 715F 442C 6065 D533 FDC2 05B9       ]



-- 
[ Julian C. Dunn 
<
 >
          * Sorry, I'm    ]
[ WWW: http://www.aquezada.com/staff/julian    * only Web 1.0  ;]
[ gopher://sdf.org/1/users/keymaker/           * compliant!    ;]
[ PGP: 91B3 7A9D 683C 7C16 715F 442C 6065 D533 FDC2 05B9       ]