What is the best way to contribute to docs.opscode.com?

Mathieu_Martin · December 11, 2012, 4:29am

Hey everyone,

Is it possible for outsiders to contribute to docs.opscode.com? Today I got
bit by a small discrepancy in the bluepill documentation on there (on the lwrp
page http://docs.opscode.com/lwrp_bluepill.html).

The community page and the readme on GitHub both give the example where the
template call (template “/etc/bluepill/my_app.pill”) includes the ".pill"
extension, whereas the page on docs doesn’t include the extension.

Since I was working off the docs page (and since I’m new to bluepill), I
was calling template “/etc/bluepill/my_app”, as the docs site
suggests. However I was getting an error* that bluepill triggers when a
configuration file is missing. This tripped me up for a while, since I
could clearly see that the file “/etc/bluepill/my_app” was present

So what’s the accepted practice to contribute to the docs site? Open a
ticket on tickets.opscode.com? Or is there a way to contribute directly,
like on a wiki?

Thanks in advance,

Mat

The error: Unknown command my_app (or application my_app has not been
loaded yet)

coderanger · December 11, 2012, 4:32am

File a ticket, make a pull request https://github.com/opscode/chef-docs

Make sure you have a CLA on file, I presume.

–Noah

On Dec 10, 2012, at 8:29 PM, Mathieu Martin wrote:

Hey everyone,

Is it possible for outsiders to contribute to docs.opscode.com? Today I got bit by a small discrepancy in the bluepill documentation on there (on the lwrp page).

The community page and the readme on GitHub both give the example where the template call (template “/etc/bluepill/my_app.pill”) includes the “.pill” extension, whereas the page on docs doesn’t include the extension.

Since I was working off the docs page (and since I’m new to bluepill), I was calling template “/etc/bluepill/my_app”, as the docs site suggests. However I was getting an error* that bluepill triggers when a configuration file is missing. This tripped me up for a while, since I could clearly see that the file “/etc/bluepill/my_app” was present

So what’s the accepted practice to contribute to the docs site? Open a ticket on tickets.opscode.com? Or is there a way to contribute directly, like on a wiki?

Thanks in advance,

Mat

The error: Unknown command my_app (or application my_app has not been loaded yet)

Nathen_Harvey1 · December 11, 2012, 4:34am

Github.com/opscode/chef-docs http://Github.com/opscode/chef-docs is the repo. Just submit a pull request.

Thanks!

Nathen Harvey

On Dec 10, 2012, at 11:30 PM, “Mathieu Martin” <webmat@gmail.com mailto:webmat@gmail.com> wrote:

Hey everyone,

Is it possible for outsiders to contribute to docs.opscode.com http://docs.opscode.com? Today I got bit by a small discrepancy in the bluepill documentation on there (on the lwrp pagehttp://docs.opscode.com/lwrp_bluepill.html).

The community page and the readme on GitHub both give the example where the template call (template “/etc/bluepill/my_app.pill”) includes the “.pill” extension, whereas the page on docs doesn’t include the extension.

Since I was working off the docs page (and since I’m new to bluepill), I was calling template “/etc/bluepill/my_app”, as the docs site suggests. However I was getting an error* that bluepill triggers when a configuration file is missing. This tripped me up for a while, since I could clearly see that the file “/etc/bluepill/my_app” was present

So what’s the accepted practice to contribute to the docs site? Open a ticket on tickets.opscode.com http://tickets.opscode.com? Or is there a way to contribute directly, like on a wiki?

Thanks in advance,

Mat

The error: Unknown command my_app (or application my_app has not been loaded yet)

Mike · December 11, 2012, 4:34am

No CLA required, per guidelines:

github.com

chef-boneyard/chef-web-docs-2016/blob/master/CONTRIBUTING



(Same info as at http://docs.chef.io/feedback.html)

chef-docs hopes that the documentation is always just what you are looking for, but when that isn't the case chef-docs does appreciate feedback. There are several ways to get feedback to chef-docs:

* Email --- Send an email to docs@chef.io for documentation bugs, ideas, thoughts, and suggestions. Typos and little errors and quick fixes will be fixed quickly and without fuss. This email address is not a support email address, however. If you need support for Chef, contact CHEF support.
* https://tickets.chef.io --- The official open source ticket tracking system for Chef. Any documentation bug filed here will eventually make its way to chef-docs. This is a good place for "important" documentation bugs that need visibility among a larger group within the Chef community.
* Pull request -- The documentation repository is on Github: https://github.com/chef/chef-docs. A CLA is not required to submit pull requests to this repo. If you are wondering what is going on in that repository, in terms of structure and what-goes-where, send an email to docs@chef.io.
* chef@lists.opscode.com --- chef-docs follows this mailing list. Improvements to the documentation are made because of conversations that happen on this mailing list. That said, relying solely on the mailing list is the least effective way to get feedback to chef-docs (because there is no guarantee that chef-docs will see any particular message).

Thanks in advance for any feedback you choose to send.

On Mon, Dec 10, 2012 at 11:32 PM, Noah Kantrowitz noah@coderanger.net wrote:

File a ticket, make a pull request https://github.com/opscode/chef-docs

Make sure you have a CLA on file, I presume.

–Noah

On Dec 10, 2012, at 8:29 PM, Mathieu Martin wrote:

Hey everyone,

Is it possible for outsiders to contribute to docs.opscode.com? Today I got bit by a small discrepancy in the bluepill documentation on there (on the lwrp page).

The community page and the readme on GitHub both give the example where the template call (template “/etc/bluepill/my_app.pill”) includes the “.pill” extension, whereas the page on docs doesn’t include the extension.

Since I was working off the docs page (and since I’m new to bluepill), I was calling template “/etc/bluepill/my_app”, as the docs site suggests. However I was getting an error* that bluepill triggers when a configuration file is missing. This tripped me up for a while, since I could clearly see that the file “/etc/bluepill/my_app” was present

So what’s the accepted practice to contribute to the docs site? Open a ticket on tickets.opscode.com? Or is there a way to contribute directly, like on a wiki?

Thanks in advance,

Mat

The error: Unknown command my_app (or application my_app has not been loaded yet)

Mathieu_Martin · December 11, 2012, 10:26am

Ah! Awesome, thanks everyone

Mat

On Monday, December 10, 2012, Mike wrote:

No CLA required, per guidelines:
https://github.com/opscode/chef-docs/blob/master/CONTRIBUTING

On Mon, Dec 10, 2012 at 11:32 PM, Noah Kantrowitz <noah@coderanger.net<javascript:;>>
wrote:

File a ticket, make a pull request https://github.com/opscode/chef-docs:-)

Make sure you have a CLA on file, I presume.

–Noah

On Dec 10, 2012, at 8:29 PM, Mathieu Martin wrote:

Hey everyone,

Is it possible for outsiders to contribute to docs.opscode.com? Today
I got bit by a small discrepancy in the bluepill documentation on there (on
the lwrp page).

The community page and the readme on GitHub both give the example where
the template call (template “/etc/bluepill/my_app.pill”) includes the
".pill" extension, whereas the page on docs doesn’t include the extension.

Since I was working off the docs page (and since I’m new to bluepill),
I was calling template “/etc/bluepill/my_app”, as the docs site suggests.
However I was getting an error* that bluepill triggers when a configuration
file is missing. This tripped me up for a while, since I could clearly see
that the file “/etc/bluepill/my_app” was present

So what’s the accepted practice to contribute to the docs site? Open a
ticket on tickets.opscode.com? Or is there a way to contribute directly,
like on a wiki?

Thanks in advance,

Mat

The error: Unknown command my_app (or application my_app has not
been loaded yet)

–
Sent from my rotary phone 5