From d51c55c0425d8fac7abdf5f0152e34c8dd0d2336 Mon Sep 17 00:00:00 2001 From: Dishank Tiwari Date: Mon, 27 Sep 2021 17:24:28 +0530 Subject: [PATCH 1/4] replaced /main/ from /master/ Signed-off-by: Dishank Tiwari --- docs-chef-io/README.md | 2 +- docs-chef-io/config.toml | 2 +- docs-chef-io/content/inspec/dsl_resource.md | 2 +- docs-chef-io/content/inspec/plugins.md | 4 ++-- docs-chef-io/content/inspec/profiles.md | 2 +- docs-chef-io/content/inspec/resources/aws_ecr_repository.md | 2 +- .../content/inspec/resources/aws_efs_file_system.md | 2 +- .../content/inspec/resources/aws_elasticache_cluster.md | 2 +- docs-chef-io/content/inspec/resources/aws_nat_gateway.md | 2 +- docs-chef-io/content/inspec/resources/aws_nat_gateways.md | 4 ++-- .../content/inspec/resources/aws_sns_subscription.md | 2 +- .../content/inspec/resources/azure_generic_resource.md | 2 +- .../content/inspec/resources/azure_resource_group.md | 2 +- .../content/inspec/resources/azure_virtual_machine.md | 2 +- .../inspec/resources/azure_virtual_machine_data_disk.md | 6 +++--- docs-chef-io/content/inspec/shell.md | 4 ++-- 16 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs-chef-io/README.md b/docs-chef-io/README.md index 26451ed35..bfc3bf6f5 100644 --- a/docs-chef-io/README.md +++ b/docs-chef-io/README.md @@ -20,7 +20,7 @@ the top of the page that you want to edit. The link takes you to that topic's Gi page. In GitHub, click on the pencil icon and make your changes. You can preview how they'll look right on the page ("Preview Changes" tab). -We also require contributors to include their [DCO signoff](https://github.com/chef/chef/blob/master/CONTRIBUTING.md#developer-certification-of-origin-dco) +We also require contributors to include their [DCO signoff](https://github.com/chef/chef/blob/main/CONTRIBUTING.md#developer-certification-of-origin-dco) in the comment section of every pull request, except for obvious fixes. You can add your DCO signoff to the comments by including `Signed-off-by:`, followed by your name and email address, like this: diff --git a/docs-chef-io/config.toml b/docs-chef-io/config.toml index dfa095bd6..329053461 100644 --- a/docs-chef-io/config.toml +++ b/docs-chef-io/config.toml @@ -1,2 +1,2 @@ [params.inspec] -gh_path = "https://github.com/inspec/inspec/tree/master/docs-chef-io/content/" +gh_path = "https://github.com/inspec/inspec/tree/main/docs-chef-io/content/" diff --git a/docs-chef-io/content/inspec/dsl_resource.md b/docs-chef-io/content/inspec/dsl_resource.md index 7eea4e502..73ae2413d 100644 --- a/docs-chef-io/content/inspec/dsl_resource.md +++ b/docs-chef-io/content/inspec/dsl_resource.md @@ -104,7 +104,7 @@ class ExampleConfig < Inspec.resource(1) end ``` -For a full example, see our [example resource](https://github.com/chef/inspec/blob/master/examples/profile/libraries/example_config.rb). +For a full example, see our [example resource](https://github.com/chef/inspec/blob/main/examples/profile/libraries/example_config.rb). ## Lazy Loading diff --git a/docs-chef-io/content/inspec/plugins.md b/docs-chef-io/content/inspec/plugins.md index 4e2354484..d81bbde18 100644 --- a/docs-chef-io/content/inspec/plugins.md +++ b/docs-chef-io/content/inspec/plugins.md @@ -76,9 +76,9 @@ inspec plugin install --source https://my.private.server inspec-private-plugin ### Chef InSpec Plugins For details on how to author a Chef InSpec Plugin, see the -[developer documentation](https://github.com/inspec/inspec/blob/master/dev-docs/plugins.md) +[developer documentation](https://github.com/inspec/inspec/blob/main/dev-docs/plugins.md) ### Train Plugins For details on how to author a Train Plugin, see the -[developer documentation](https://github.com/inspec/train/blob/master/docs/plugins.md) +[developer documentation](https://github.com/inspec/train/blob/main/docs/plugins.md) diff --git a/docs-chef-io/content/inspec/profiles.md b/docs-chef-io/content/inspec/profiles.md index b9ce735e1..dec4e32db 100644 --- a/docs-chef-io/content/inspec/profiles.md +++ b/docs-chef-io/content/inspec/profiles.md @@ -41,7 +41,7 @@ where: - `README.md` should be used to explain the profile, its scope, and usage See a complete example profile in the Chef InSpec open source repository: -[Example Chef InSpec Profile](https://github.com/chef/inspec/tree/master/examples/profile) +[Example Chef InSpec Profile](https://github.com/chef/inspec/tree/main/examples/profile) Also check out [Explore Chef InSpec resources](https://learn.chef.io/modules/explore-inspec-resources#/) on Learn Chef Rally to learn more about how profiles are structured with hands-on-examples. diff --git a/docs-chef-io/content/inspec/resources/aws_ecr_repository.md b/docs-chef-io/content/inspec/resources/aws_ecr_repository.md index 730c48c59..a3821f356 100644 --- a/docs-chef-io/content/inspec/resources/aws_ecr_repository.md +++ b/docs-chef-io/content/inspec/resources/aws_ecr_repository.md @@ -11,7 +11,7 @@ platform = "aws" parent = "inspec/resources/aws" +++ -[\[edit on GitHub\]](https://github.com/inspec/inspec/blob/master/docs-chef-io/content/aws_ecr_repository.md) +[\[edit on GitHub\]](https://github.com/inspec/inspec/blob/main/docs-chef-io/content/aws_ecr_repository.md) Use the `aws_ecr_repository` InSpec audit resource to test the properties of a single AWS Elastic Container Registry (ECR) repository. This resource is available in InSpec AWS resource pack version **[1.11.0](https://github.com/inspec/inspec-aws/releases/tag/v1.11.0)** onwards. diff --git a/docs-chef-io/content/inspec/resources/aws_efs_file_system.md b/docs-chef-io/content/inspec/resources/aws_efs_file_system.md index 6653e5422..eb4dae761 100644 --- a/docs-chef-io/content/inspec/resources/aws_efs_file_system.md +++ b/docs-chef-io/content/inspec/resources/aws_efs_file_system.md @@ -11,7 +11,7 @@ platform = "aws" parent = "inspec/resources/aws" +++ -[\[edit on GitHub\]](https://github.com/inspec/inspec/blob/master/docs-chef-io/content/inspec/rources/aws_efs_file_system.md) +[\[edit on GitHub\]](https://github.com/inspec/inspec/blob/main/docs-chef-io/content/inspec/rources/aws_efs_file_system.md) Use the `aws_efs_file_system` InSpec audit resource to test the properties of a single AWS EFS file system. This resource is added to InSpec AWS resource pack in version **[1.10.0](https://github.com/inspec/inspec-aws/releases/tag/v1.10.0)** and it is available with InSpec **[4.18.108](https://github.com/inspec/inspec/releases/tag/v4.18.108)** and later versions. diff --git a/docs-chef-io/content/inspec/resources/aws_elasticache_cluster.md b/docs-chef-io/content/inspec/resources/aws_elasticache_cluster.md index b131feaf8..17ac23fac 100644 --- a/docs-chef-io/content/inspec/resources/aws_elasticache_cluster.md +++ b/docs-chef-io/content/inspec/resources/aws_elasticache_cluster.md @@ -11,7 +11,7 @@ platform = "aws" parent = "inspec/resources/aws" +++ -[\[edit on GitHub\]](https://github.com/inspec/inspec/blob/master/docs-chef-io/content/aws_elasticache_cluster.md) +[\[edit on GitHub\]](https://github.com/inspec/inspec/blob/main/docs-chef-io/content/aws_elasticache_cluster.md) Use the `aws_elasticache_cluster` InSpec audit resource to test the properties of a single AWS ElastiCache cluster. diff --git a/docs-chef-io/content/inspec/resources/aws_nat_gateway.md b/docs-chef-io/content/inspec/resources/aws_nat_gateway.md index f1c5c542e..7fc0a64eb 100644 --- a/docs-chef-io/content/inspec/resources/aws_nat_gateway.md +++ b/docs-chef-io/content/inspec/resources/aws_nat_gateway.md @@ -102,7 +102,7 @@ There are also additional properties available. For a comprehensive list, see [t its('nat_gateway_address_set') { should include(:private_ip => '10.0.1.68') } end -For more examples, please check the [integration tests](https://github.com/inspec/inspec-aws/blob/master/test/integration/verify/controls/aws_nat_gateway.rb). +For more examples, please check the [integration tests](https://github.com/inspec/inspec-aws/blob/main/test/integration/verify/controls/aws_nat_gateway.rb). ## Matchers diff --git a/docs-chef-io/content/inspec/resources/aws_nat_gateways.md b/docs-chef-io/content/inspec/resources/aws_nat_gateways.md index 721d78025..61216eee4 100644 --- a/docs-chef-io/content/inspec/resources/aws_nat_gateways.md +++ b/docs-chef-io/content/inspec/resources/aws_nat_gateways.md @@ -56,7 +56,7 @@ using `aws_nat_gateway` InSpec singular AWS resource. end end -For more examples, please check the [integration tests](https://github.com/inspec/inspec-aws/blob/master/test/integration/verify/controls/aws_nat_gateways.rb). +For more examples, please check the [integration tests](https://github.com/inspec/inspec-aws/blob/main/test/integration/verify/controls/aws_nat_gateways.rb). ## Matchers @@ -77,7 +77,7 @@ Use `should_not` to test the entity should not exist. it { should_not exist } end -Please see [here](https://github.com/inspec/inspec/blob/master/docs/dev/filtertable-usage.md) for more information on how to use filter table. +Please see [here](https://github.com/inspec/inspec/blob/main/docs/dev/filtertable-usage.md) for more information on how to use filter table. ## AWS Permissions diff --git a/docs-chef-io/content/inspec/resources/aws_sns_subscription.md b/docs-chef-io/content/inspec/resources/aws_sns_subscription.md index f2f400730..ea20e4875 100644 --- a/docs-chef-io/content/inspec/resources/aws_sns_subscription.md +++ b/docs-chef-io/content/inspec/resources/aws_sns_subscription.md @@ -11,7 +11,7 @@ platform = "aws" parent = "inspec/resources/aws" +++ -[\[edit on GitHub\]](https://github.com/inspec/inspec/blob/master/docs-chef-io/content/aws_sns_subscription.md) +[\[edit on GitHub\]](https://github.com/inspec/inspec/blob/main/docs-chef-io/content/aws_sns_subscription.md) Use the `aws_sns_subscription` InSpec audit resource to test detailed properties of a AWS SNS Subscription. diff --git a/docs-chef-io/content/inspec/resources/azure_generic_resource.md b/docs-chef-io/content/inspec/resources/azure_generic_resource.md index 6e0f9044a..907c9268d 100644 --- a/docs-chef-io/content/inspec/resources/azure_generic_resource.md +++ b/docs-chef-io/content/inspec/resources/azure_generic_resource.md @@ -178,4 +178,4 @@ This Chef InSpec audit resource has the following special matchers. For a full l Please see the integration tests for in depth examples of how this resource can be used. -[Chef InSpec Integration Tests for Azure Generic Resources](https://github.com/chef/inspec/tree/master/test/integration/azure/verify/controls) +[Chef InSpec Integration Tests for Azure Generic Resources](https://github.com/chef/inspec/tree/main/test/integration/azure/verify/controls) diff --git a/docs-chef-io/content/inspec/resources/azure_resource_group.md b/docs-chef-io/content/inspec/resources/azure_resource_group.md index 0fb39c176..27e82e0c4 100644 --- a/docs-chef-io/content/inspec/resources/azure_resource_group.md +++ b/docs-chef-io/content/inspec/resources/azure_resource_group.md @@ -291,5 +291,5 @@ Note: The tag name is case sensitive which makes the test case sensitive. E.g. ` For more information on Azure Ruby SDK resources, see: -- [Azure Ruby SDK - Resources](https://github.com/Azure/azure-sdk-for-ruby/tree/master/management/azure_mgmt_resources) +- [Azure Ruby SDK - Resources](https://github.com/Azure/azure-sdk-for-ruby/tree/main/management/azure_mgmt_resources) - [Resource Group](https://github.com/chef/inspec/blob/fc990346f2438690f0ac36a9f6606e61574a79b8/test/azure/verify/controls/resource_group.rb) diff --git a/docs-chef-io/content/inspec/resources/azure_virtual_machine.md b/docs-chef-io/content/inspec/resources/azure_virtual_machine.md index 904062566..3da1549d5 100644 --- a/docs-chef-io/content/inspec/resources/azure_virtual_machine.md +++ b/docs-chef-io/content/inspec/resources/azure_virtual_machine.md @@ -348,6 +348,6 @@ Note: The tag name is case sensitive which makes the test case sensitive. E.g. ` ## References -- [Azure Ruby SDK - Resources](https://github.com/Azure/azure-sdk-for-ruby/tree/master/management/azure_mgmt_resources) +- [Azure Ruby SDK - Resources](https://github.com/Azure/azure-sdk-for-ruby/tree/main/management/azure_mgmt_resources) - [Virtual Machine External VM](https://github.com/chef/inspec/blob/fc990346f2438690f0ac36a9f6606e61574a79b8/test/azure/verify/controls/virtual_machine_external_vm.rb) - [Virtual Machine Internal VM](https://github.com/chef/inspec/blob/fc990346f2438690f0ac36a9f6606e61574a79b8/test/azure/verify/controls/virtual_machine_internal_vm.rb) diff --git a/docs-chef-io/content/inspec/resources/azure_virtual_machine_data_disk.md b/docs-chef-io/content/inspec/resources/azure_virtual_machine_data_disk.md index aed66a84d..059474ea2 100644 --- a/docs-chef-io/content/inspec/resources/azure_virtual_machine_data_disk.md +++ b/docs-chef-io/content/inspec/resources/azure_virtual_machine_data_disk.md @@ -221,6 +221,6 @@ Returns a boolean stating if the machine has Managed Disks for data disks. ## References -- [Azure Ruby SDK - Compute](https://github.com/Azure/azure-sdk-for-ruby/tree/master/management/azure_mgmt_compute) -- [Linux Internal Data Disks](https://github.com/chef/inspec/blob/master/test/azure/verify/controls/virtual_machine_linux_external_vm_datadisk.rb) -- [Windows Internal Data Disk](https://github.com/chef/inspec/blob/master/test/azure/verify/controls/virtual_machine_windows_internal_vm_datadisk.rb) +- [Azure Ruby SDK - Compute](https://github.com/Azure/azure-sdk-for-ruby/tree/main/management/azure_mgmt_compute) +- [Linux Internal Data Disks](https://github.com/chef/inspec/blob/main/test/azure/verify/controls/virtual_machine_linux_external_vm_datadisk.rb) +- [Windows Internal Data Disk](https://github.com/chef/inspec/blob/main/test/azure/verify/controls/virtual_machine_windows_internal_vm_datadisk.rb) diff --git a/docs-chef-io/content/inspec/shell.md b/docs-chef-io/content/inspec/shell.md index 8e501256a..95e506df4 100644 --- a/docs-chef-io/content/inspec/shell.md +++ b/docs-chef-io/content/inspec/shell.md @@ -57,9 +57,9 @@ Use resource packs to share custom resources with other Chef InSpec users. A resource pack is a Chef InSpec profile that contains only custom resources and no other controls or tests. -For example, the profile in [`examples/profile`](https://github.com/chef/inspec/tree/master/examples/profile) +For example, the profile in [`examples/profile`](https://github.com/chef/inspec/tree/main/examples/profile) in the Chef InSpec GitHub repository defines an -[`example_config` resource](https://github.com/chef/inspec/blob/master/examples/profile/controls/example.rb). +[`example_config` resource](https://github.com/chef/inspec/blob/main/examples/profile/controls/example.rb). To use these resources within the Chef InSpec shell, you will need to download and specify them as a dependency. From e1c0d2dccc5848746eb1377720a2ac496f1f9919 Mon Sep 17 00:00:00 2001 From: Dishank Tiwari Date: Thu, 30 Sep 2021 12:02:12 +0530 Subject: [PATCH 2/4] Update docs-chef-io/content/inspec/resources/aws_ecr_repository.md Co-authored-by: Ian Maddaus --- docs-chef-io/content/inspec/resources/aws_ecr_repository.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs-chef-io/content/inspec/resources/aws_ecr_repository.md b/docs-chef-io/content/inspec/resources/aws_ecr_repository.md index a3821f356..8168b83f8 100644 --- a/docs-chef-io/content/inspec/resources/aws_ecr_repository.md +++ b/docs-chef-io/content/inspec/resources/aws_ecr_repository.md @@ -11,7 +11,6 @@ platform = "aws" parent = "inspec/resources/aws" +++ -[\[edit on GitHub\]](https://github.com/inspec/inspec/blob/main/docs-chef-io/content/aws_ecr_repository.md) Use the `aws_ecr_repository` InSpec audit resource to test the properties of a single AWS Elastic Container Registry (ECR) repository. This resource is available in InSpec AWS resource pack version **[1.11.0](https://github.com/inspec/inspec-aws/releases/tag/v1.11.0)** onwards. From d1fc83270dd8536aff661fdc6788477e850b7681 Mon Sep 17 00:00:00 2001 From: Dishank Tiwari Date: Thu, 30 Sep 2021 12:04:04 +0530 Subject: [PATCH 3/4] Update docs-chef-io/content/inspec/resources/aws_efs_file_system.md Co-authored-by: Ian Maddaus --- docs-chef-io/content/inspec/resources/aws_efs_file_system.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs-chef-io/content/inspec/resources/aws_efs_file_system.md b/docs-chef-io/content/inspec/resources/aws_efs_file_system.md index eb4dae761..aaa39a9f4 100644 --- a/docs-chef-io/content/inspec/resources/aws_efs_file_system.md +++ b/docs-chef-io/content/inspec/resources/aws_efs_file_system.md @@ -11,7 +11,6 @@ platform = "aws" parent = "inspec/resources/aws" +++ -[\[edit on GitHub\]](https://github.com/inspec/inspec/blob/main/docs-chef-io/content/inspec/rources/aws_efs_file_system.md) Use the `aws_efs_file_system` InSpec audit resource to test the properties of a single AWS EFS file system. This resource is added to InSpec AWS resource pack in version **[1.10.0](https://github.com/inspec/inspec-aws/releases/tag/v1.10.0)** and it is available with InSpec **[4.18.108](https://github.com/inspec/inspec/releases/tag/v4.18.108)** and later versions. From 6e7b44fb4cb17477bf950d2cc5a56f11d6e85eec Mon Sep 17 00:00:00 2001 From: Dishank Tiwari Date: Thu, 30 Sep 2021 12:04:16 +0530 Subject: [PATCH 4/4] Update docs-chef-io/content/inspec/resources/aws_elasticache_cluster.md Co-authored-by: Ian Maddaus --- docs-chef-io/content/inspec/resources/aws_elasticache_cluster.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs-chef-io/content/inspec/resources/aws_elasticache_cluster.md b/docs-chef-io/content/inspec/resources/aws_elasticache_cluster.md index 17ac23fac..fc25f2b1b 100644 --- a/docs-chef-io/content/inspec/resources/aws_elasticache_cluster.md +++ b/docs-chef-io/content/inspec/resources/aws_elasticache_cluster.md @@ -11,7 +11,6 @@ platform = "aws" parent = "inspec/resources/aws" +++ -[\[edit on GitHub\]](https://github.com/inspec/inspec/blob/main/docs-chef-io/content/aws_elasticache_cluster.md) Use the `aws_elasticache_cluster` InSpec audit resource to test the properties of a single AWS ElastiCache cluster.