Skip to content

Commit 436e4af

Browse files
committed
Minor cleanup of content
Signed-off-by: Ian Maddaus <[email protected]>
1 parent 94ec0d5 commit 436e4af

File tree

3 files changed

+18
-97
lines changed

3 files changed

+18
-97
lines changed

content/community_contributions.md

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
+++
2-
title = "Community Contributions"
2+
title = "Community contributions"
33
draft = false
44
gh_repo = "chef-web-docs"
55
aliases = ["/community_contributions.html"]
66
product = []
77

88
[menu]
99
[menu.overview]
10-
title = "Community Contributions"
10+
title = "Community contributions"
1111
identifier = "overview/community/contributing"
1212
parent = "overview/community"
1313
weight = 10
1414
+++
1515
<!-- markdownlint-disable-file MD033 -->
1616
We're glad you want to contribute to a Chef project! This guide will help answer common questions you may have during your first contribution.
1717

18-
## Submitting Issues
18+
## Submitting issues
1919

2020
Not every contribution comes in the form of code. Submitting, confirming, and triaging issues is an important task for any project. At Chef we use GitHub to track all project issues.
2121

@@ -29,32 +29,24 @@ We ask you not to submit security concerns using GitHub. For details on submitti
2929

3030
In addition to GitHub issues, we also use a feedback site that helps our product team track and rank feature requests. If you have a feature request, [this is an excellent place to start](https://chef-software.ideas.aha.io/).
3131

32-
The following repositories are the preferred locations for the creation of issues and bug reports:
33-
34-
{{< repos >}}
35-
3632
For additional support about Chef products, including documentation, learning, and opening tickets with the support team, see [Chef Support](https://www.chef.io/support) .
3733

38-
{{< warning >}}
34+
{{< note >}}
3935

4036
If you require a response from Chef for each the terms of a support level agreement (SLA), please contact [Chef Support](https://www.chef.io/support) directly.
4137

42-
{{< /warning >}}
43-
44-
{{< note >}}
45-
46-
Questions on how to use Chef Infra should be sent as Support Tickets if you have an SLA, or asked on the [Chef Software Mailing List](https://discourse.chef.io/), or [Chef Community Slack](https://community-slack.chef.io/). Bug Trackers aren't appropriate for general purpose questions that aren't bugs.
38+
Questions on how to use Chef Infra should be sent as support tickets if you have an SLA, or asked on the [Chef Software Mailing List](https://discourse.chef.io/), or [Chef Community Slack](https://community-slack.chef.io/). Bug Trackers aren't appropriate for general purpose questions that aren't bugs.
4739

4840
{{< /note >}}
4941

50-
## Contribution Process
42+
## Contribution process
5143

5244
Follow these steps to submit a contribution:
5345

5446
1. Fork the project repository to your own GitHub account.
5547
2. Commit your changes to your fork, making sure to sign-off those changes for the Developer Certificate of Origin with `git commit -s`
56-
3. Create a GitHub Pull Request for your change, following the instructions in the pull request template.
57-
4. Perform a Code Review with the project maintainers on the pull
48+
3. Create a GitHub pull request for your change, following the instructions in the pull request template.
49+
4. Perform a code review with the project maintainers on the pull
5850
request.
5951

6052
## About the Apache License
@@ -124,15 +116,15 @@ Chef doesn't merge any pull requests made against a Chef-managed open source rep
124116
* Pull requests made against the docs.chef.io documentation repository (<https://github.com/chef/chef-web-docs>)
125117
* Pull requests that contain only documentation updates made against projects where the documentation is embedded in the project's repository (that's, the `docs` directory in the `chef/inspec` repository)
126118

127-
## The "Obvious Fix" Rule
119+
## The Obvious Fix Rule
128120

129121
Chef's contribution policy is aimed at encouraging broad participation from our community, and minimizing risks to Chef and our community due to inappropriate contributions of the intellectual property of others.
130122

131123
As a general standard, Chef requires every contribution to by signed for the Developer Certificate of Origin (DCO).
132124

133125
HOWEVER, small contributions such as fixing spelling errors, where the content is small enough to not be considered intellectual property, can be submitted by a contributor as a patch, without a DCO sign-off. If you submit an obvious fix without a DCO sign-off, then you are agreeing that your submission isn't independently copyrightable. The purpose of this exception is to lower the barrier for new contributors to make contributions while retaining the integrity of the project and our community.
134126

135-
### How does the Obvious Fix Rule Work?
127+
### How does the Obvious Fix Rule work?
136128

137129
Any committer may commit fixes without a DCO sign-off for obvious typos, grammar mistakes, and formatting problems wherever they may be * in the web pages, API documentation, source code, etc.
138130

@@ -151,7 +143,7 @@ Date: Wed Sep 18 11:44:40 2015 -0700
151143
------------------------------------------------------------------------
152144
```
153145

154-
### What qualifies as an Obvious Fix?
146+
### What qualifies as an obvious fix?
155147

156148
An obvious fix is a pull request that doesn't contain creative work. We rely on your judgment to determine what's "obvious"; if you're not sure, just ask by sending an email to: oss AT getchef DOT com.
157149

content/feedback.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
+++
2-
title = "Send Feedback"
2+
title = "Send feedback"
33
draft = false
44
gh_repo = "chef-web-docs"
55
aliases = ["/feedback.html"]
66
product = []
77

88
[menu]
99
[menu.overview]
10-
title = "Send Feedback"
10+
title = "Send feedback"
1111
identifier = "overview/community/feedback.md Send Feedback"
1212
parent = "overview/community"
1313
weight = 50
1414
+++
1515

1616
chef-docs hopes that the documentation is always just what you are
1717
looking for, but when that isn't the case we do appreciate
18-
feedback. There are several ways to get feedback to chef-docs. For
18+
feedback. There are several ways to get feedback to the Chef Documentation Team. For
1919
members of the Chef community, customers, or people who just want to
2020
send feedback, choose any of the following options:
2121

22-
## Feedback Form
22+
## Feedback form
2323

2424
Every page in [docs.chef.io](https://docs.chef.io) has a feedback form
2525
at the bottom of the page. Please feel free to include any thoughts or
@@ -38,13 +38,12 @@ ideas, thoughts, and suggestions. This email address is
3838
not a support email address, however. If you need support,
3939
contact [Chef support](https://supportlink.chef.io/).
4040

41-
## GitHub Issues
41+
## GitHub issues
4242

4343
Open an issue in <https://github.com/chef/chef-web-docs/issues>
44-
on GitHub. If you believe the issue may be a product bug within a Chef
45-
itself, consider opening an issue in the relevant [product repository]({{< relref "repositories" >}}).
44+
on GitHub.
4645

47-
## GitHub Pull Request
46+
## GitHub pull request
4847

4948
You can open a pull request on <https://github.com/chef/chef-web-docs>.
5049
Every page on <https://docs.chef.io> has a link to the Markdown page in the repository

layouts/shortcodes/repos.html

Lines changed: 0 additions & 70 deletions
This file was deleted.

0 commit comments

Comments
 (0)