diff --git a/content/community_contributions.md b/content/community_contributions.md index 336b78b609..6adf7b3fd1 100644 --- a/content/community_contributions.md +++ b/content/community_contributions.md @@ -1,5 +1,5 @@ +++ -title = "Community Contributions" +title = "Community contributions" draft = false gh_repo = "chef-web-docs" aliases = ["/community_contributions.html"] @@ -7,7 +7,7 @@ product = [] [menu] [menu.overview] - title = "Community Contributions" + title = "Community contributions" identifier = "overview/community/contributing" parent = "overview/community" weight = 10 @@ -15,7 +15,7 @@ product = [] 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. -## Submitting Issues +## Submitting issues 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. @@ -29,32 +29,24 @@ We ask you not to submit security concerns using GitHub. For details on submitti 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/). -The following repositories are the preferred locations for the creation of issues and bug reports: - -{{< repos >}} - For additional support about Chef products, including documentation, learning, and opening tickets with the support team, see [Chef Support](https://www.chef.io/support) . -{{< warning >}} +{{< note >}} 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. -{{< /warning >}} - -{{< note >}} - -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. +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. {{< /note >}} -## Contribution Process +## Contribution process Follow these steps to submit a contribution: 1. Fork the project repository to your own GitHub account. 2. Commit your changes to your fork, making sure to sign-off those changes for the Developer Certificate of Origin with `git commit -s` -3. Create a GitHub Pull Request for your change, following the instructions in the pull request template. -4. Perform a Code Review with the project maintainers on the pull +3. Create a GitHub pull request for your change, following the instructions in the pull request template. +4. Perform a code review with the project maintainers on the pull request. ## About the Apache License @@ -124,7 +116,7 @@ Chef doesn't merge any pull requests made against a Chef-managed open source rep * Pull requests made against the docs.chef.io documentation repository () * 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) -## The "Obvious Fix" Rule +## The Obvious Fix Rule 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. @@ -132,7 +124,7 @@ As a general standard, Chef requires every contribution to by signed for the Dev 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. -### How does the Obvious Fix Rule Work? +### How does the Obvious Fix Rule work? 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. @@ -151,7 +143,7 @@ Date: Wed Sep 18 11:44:40 2015 -0700 ------------------------------------------------------------------------ ``` -### What qualifies as an Obvious Fix? +### What qualifies as an obvious fix? 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. diff --git a/content/feedback.md b/content/feedback.md index 19aca7819a..c70fca7d22 100644 --- a/content/feedback.md +++ b/content/feedback.md @@ -1,5 +1,5 @@ +++ -title = "Send Feedback" +title = "Send feedback" draft = false gh_repo = "chef-web-docs" aliases = ["/feedback.html"] @@ -7,7 +7,7 @@ product = [] [menu] [menu.overview] - title = "Send Feedback" + title = "Send feedback" identifier = "overview/community/feedback.md Send Feedback" parent = "overview/community" weight = 50 @@ -15,11 +15,11 @@ product = [] chef-docs hopes that the documentation is always just what you are looking for, but when that isn't the case we do appreciate -feedback. There are several ways to get feedback to chef-docs. For +feedback. There are several ways to get feedback to the Chef Documentation Team. For members of the Chef community, customers, or people who just want to send feedback, choose any of the following options: -## Feedback Form +## Feedback form Every page in [docs.chef.io](https://docs.chef.io) has a feedback form 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 not a support email address, however. If you need support, contact [Chef support](https://supportlink.chef.io/). -## GitHub Issues +## GitHub issues Open an issue in -on GitHub. If you believe the issue may be a product bug within a Chef -itself, consider opening an issue in the relevant [product repository]({{< relref "repositories" >}}). +on GitHub. -## GitHub Pull Request +## GitHub pull request You can open a pull request on . Every page on has a link to the Markdown page in the repository diff --git a/content/repositories.md b/content/repositories.md deleted file mode 100644 index 850ef84c87..0000000000 --- a/content/repositories.md +++ /dev/null @@ -1,10 +0,0 @@ -+++ -title = "Product Repositories" -draft = false -robots = "noindex" - -+++ - -Below is a table of all repositories that contain Chef documentation and includes links to the directories with documentation content. - -{{< repos docsPath=true >}} diff --git a/layouts/shortcodes/repos.html b/layouts/shortcodes/repos.html deleted file mode 100644 index 1b9434227b..0000000000 --- a/layouts/shortcodes/repos.html +++ /dev/null @@ -1,70 +0,0 @@ -{{/* Generate a table of all repositories that contain documentation deployed through chef-web-docs */}} -{{/* Set 'docsPath=true' to include a column with the paths to the docs content in each repo. */}} -{{ $docsPath := default false (.Get "docsPath") }} - - - - - - {{ if eq $docsPath true }}{{ end }} - -{{ range $k, $v := .Site.Params }} -{{ if reflect.IsMap $v}} -{{ range $key, $val := $v }} -{{ if eq $key "gh_path" }} -{{ $repo := index (findRE `https:\/\/github\.com\/[\w|\-]+\/[\w|\-]+\/` $val) 0}} -{{ $productOrg := title (replaceRE `https:\/\/github\.com\/([\w|-]+)\/[\w|\-]+\/.+` "$1" $val) }} -{{ $productName := (replaceRE `https:\/\/github\.com\/[\w|-]+\/([\w|\-]+)\/.+` "$1" $val) }} -{{ $productName = humanize $productName | lower }} -{{ if hasPrefix $productName "chef " }} - {{ $productName = replaceRE `chef ` "" $productName 1 }} -{{ end }} -{{ if in $productName "inspec"}} - {{ $productName = replaceRE "inspec" "InSpec" $productName }} - {{ if in $productName "aws"}} - {{ $productName = "InSpec AWS Resources"}} - {{ end }} - {{ if in $productName "azure"}} - {{ $productName = "InSpec Azure Resources"}} - {{ end }} - {{ if in $productName "habitat"}} - {{ $productName = "InSpec Habitat Resources"}} - {{ end }} - {{ if in $productName "gcp"}} - {{ $productName = "InSpec Google Cloud Platform Resources"}} - {{ end }} - {{ if in $productName "k8s"}} - {{ $productName = "InSpec Kubernetes Resources"}} - {{ end }} - {{ if in $productName "alicloud"}} - {{ $productName = "InSpec Alibaba Cloud Resources"}} - {{ end }} -{{ end }} -{{ if eq $productName "desktop config"}} - {{ $productName = "Desktop" }} -{{end }} -{{ if in $productName "web docs"}} - {{ $productName = "Documentation"}} -{{ end }} -{{ if eq $productName "server" }} - {{ $productName = print "Infra Server" }} -{{ end }} -{{ if eq $productName "chef" }} - {{ $productName = print "Infra Client" }} -{{ end }} -{{ $productName = title $productName }} -{{ $docsDir := replaceRE `content/$` "" $val }} -{{ if in $docsDir "chef-web-docs" }} - {{ $docsDir = $repo }} -{{ end }} - - - - {{ if eq $docsPath true }}{{end}} - - -{{ end }} -{{ end }} -{{ end }} -{{ end }} -
ProductRepositoryDocs Content
Chef {{ $productName }}{{$repo}}{{ $docsDir }}