Merge pull request #9445 from chef/docs_links

Update all our links to use the new docs site format / cleanup descriptions

14 files changed, 25 insertions, 24 deletions

diff --git a/lib/chef/cookbook/metadata.rb b/lib/chef/cookbook/metadata.rb
index d5821a799e..ad7acb0e7b 100644
--- a/lib/chef/cookbook/metadata.rb
+++ b/lib/chef/cookbook/metadata.rb
@@ -604,7 +604,7 @@ class Chef
           msg = <<~OBSOLETED
             The dependency specification syntax you are using is no longer valid. You may not
             specify more than one version constraint for a particular cookbook.
-            Consult https://docs.chef.io/config_rb_metadata.html for the updated syntax.
+            Consult https://docs.chef.io/config_rb_metadata/ for the updated syntax.
 
             Called by: #{caller_name} '#{dep_name}', #{version_constraints.map(&:inspect).join(", ")}
             Called from:
@@ -621,9 +621,10 @@ class Chef
 
         msg = <<~INVALID
           The version constraint syntax you are using is not valid. If you recently
-          upgraded to Chef 0.10.0, be aware that you no may longer use "<<" and ">>" for
-          'less than' and 'greater than'; use '<' and '>' instead.
-          Consult https://docs.chef.io/config_rb_metadata.html for more information.
+          upgraded from Chef Infra releases before 0.10, be aware that you no may
+          longer use "<<" and ">>" for 'less than' and 'greater than'; use '<' and
+          '>' instead. Consult https://docs.chef.io/config_rb_metadata/ for more
+          information.
 
           Called by: #{caller_name} '#{dep_name}', '#{constraint_str}'
           Called from:
diff --git a/lib/chef/cookbook_loader.rb b/lib/chef/cookbook_loader.rb
index f02b07eaaf..68e678c928 100644
--- a/lib/chef/cookbook_loader.rb
+++ b/lib/chef/cookbook_loader.rb
@@ -88,7 +88,7 @@ class Chef
     # @return [Chef::CookbookVersion]
     def load_cookbook(cookbook_name)
       unless cookbook_version_loaders.key?(cookbook_name)
-        raise Exceptions::CookbookNotFoundInRepo, "Cannot find a cookbook named #{cookbook_name}; did you forget to add metadata to a cookbook? (https://docs.chef.io/config_rb_metadata.html)"
+        raise Exceptions::CookbookNotFoundInRepo, "Cannot find a cookbook named #{cookbook_name}; did you forget to add metadata to a cookbook? (https://docs.chef.io/config_rb_metadata/)"
       end
 
       return cookbooks_by_name[cookbook_name] if cookbooks_by_name.key?(cookbook_name)
diff --git a/lib/chef/deprecated.rb b/lib/chef/deprecated.rb
index 4817c1e8ec..3d6ced6526 100644
--- a/lib/chef/deprecated.rb
+++ b/lib/chef/deprecated.rb
@@ -47,7 +47,7 @@ class Chef
       #
       # @return [String]
       def url
-        "#{BASE_URL}#{self.class.doc_page}"
+        "#{BASE_URL}#{self.class.doc_page}/"
       end
 
       # Render the user-visible message for this deprecation.
@@ -104,7 +104,7 @@ class Chef
         #
         # @example
         #   class MyDeprecation < Base
-        #     target 123, "my_deprecation.html"
+        #     target 123, "my_deprecation"
         #   end
         # @param id [Integer] Deprecation ID number. This must be unique among
         #   all deprecations.
@@ -113,7 +113,7 @@ class Chef
         # @return [void]
         def target(id, page = nil)
           @deprecation_id = id
-          @doc_page = page || "#{deprecation_key}.html"
+          @doc_page = page || "#{deprecation_key}"
         end
       end
     end
@@ -137,7 +137,7 @@ class Chef
     end
 
     class CustomResource < Base
-      target 5, "custom_resource_cleanups.html"
+      target 5, "custom_resource_cleanups"
     end
 
     class EasyInstall < Base
@@ -235,7 +235,7 @@ class Chef
 
     class Generic < Base
       def url
-        "https://docs.chef.io/chef_deprecations_client.html"
+        "https://docs.chef.io/chef_deprecations_client/"
       end
 
       def to_s
diff --git a/lib/chef/dsl/platform_introspection.rb b/lib/chef/dsl/platform_introspection.rb
index 9ce3aa3513..521eea76b6 100644
--- a/lib/chef/dsl/platform_introspection.rb
+++ b/lib/chef/dsl/platform_introspection.rb
@@ -252,7 +252,7 @@ class Chef
       # @deprecated Windows releases before Windows 2012 and 8 are no longer supported
       # @return [Boolean] Is the system older than Windows 8 / 2012
       def older_than_win_2012_or_8?(node = run_context.nil? ? nil : run_context.node)
-        node["platform_version"].to_f < 6.2
+        false # we don't support platforms that would be true
       end
 
       # ^^^^^^ NOTE: PLEASE DO NOT CONTINUE TO ADD THESE KINDS OF PLATFORM_VERSION APIS WITHOUT ^^^^^^^
diff --git a/lib/chef/dsl/reboot_pending.rb b/lib/chef/dsl/reboot_pending.rb
index e554ca83ad..e19faad881 100644
--- a/lib/chef/dsl/reboot_pending.rb
+++ b/lib/chef/dsl/reboot_pending.rb
@@ -39,11 +39,11 @@ class Chef
           # http://technet.microsoft.com/en-us/library/cc960241.aspx
           registry_value_exists?('HKLM\SYSTEM\CurrentControlSet\Control\Session Manager', { name: "PendingFileRenameOperations" }) ||
 
-          # RebootRequired key contains Update IDs with a value of 1 if they require a reboot.
-          # The existence of RebootRequired alone is sufficient on my Windows 8.1 workstation in Windows Update
+            # RebootRequired key contains Update IDs with a value of 1 if they require a reboot.
+            # The existence of RebootRequired alone is sufficient on my Windows 8.1 workstation in Windows Update
             registry_key_exists?('HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\WindowsUpdate\Auto Update\RebootRequired') ||
 
-          # Vista + Server 2008 and newer may have reboots pending from CBS
+            # Vista + Server 2008 and newer may have reboots pending from CBS
             registry_key_exists?('HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\Component Based Servicing\RebootPending')
         elsif platform?("ubuntu")
           # This should work for Debian as well if update-notifier-common happens to be installed. We need an API for that.
diff --git a/lib/chef/knife.rb b/lib/chef/knife.rb
index 2975dcb4e9..0debcbc429 100644
--- a/lib/chef/knife.rb
+++ b/lib/chef/knife.rb
@@ -191,7 +191,7 @@ class Chef
       config_loader.profile = profile
       config_loader.load
 
-      ui.warn("No knife configuration file found. See https://docs.chef.io/config_rb_knife.html for details.") if config_loader.no_config_found?
+      ui.warn("No knife configuration file found. See https://docs.chef.io/config_rb/ for details.") if config_loader.no_config_found?
 
       config_loader
     rescue Exceptions::ConfigurationError => e
diff --git a/lib/chef/knife/bootstrap/templates/README.md b/lib/chef/knife/bootstrap/templates/README.md
index b5bca25d8e..7f28f8f40f 100644
--- a/lib/chef/knife/bootstrap/templates/README.md
+++ b/lib/chef/knife/bootstrap/templates/README.md
@@ -5,7 +5,7 @@ standardized on the [Omnibus](https://github.com/chef/omnibus) built installatio
 packages.
 
 The 'chef-full' template downloads a script which is used to determine the correct
-Omnibus package for this system from the [Omnitruck](https://docs.chef.io/api_omnitruck.html) API.
+Omnibus package for this system from the [Omnitruck](https://docs.chef.io/api_omnitruck/) API.
 
 You can still utilize custom bootstrap templates on your system if your installation
-needs are unique. Additional information can be found on the [docs site](https://docs.chef.io/knife_bootstrap.html#custom-templates).
+needs are unique. Additional information can be found on the [docs site](https://docs.chef.io/knife_bootstrap/#custom-templates).
diff --git a/lib/chef/knife/core/ui.rb b/lib/chef/knife/core/ui.rb
index 0dfa1db79c..03b11a1b4d 100644
--- a/lib/chef/knife/core/ui.rb
+++ b/lib/chef/knife/core/ui.rb
@@ -216,7 +216,7 @@ class Chef
             tf.sync = true
             tf.puts output
             tf.close
-            raise "Please set EDITOR environment variable. See https://docs.chef.io/knife_setup.html for details." unless system("#{config[:editor]} #{tf.path}")
+            raise "Please set EDITOR environment variable. See https://docs.chef.io/knife_setup/ for details." unless system("#{config[:editor]} #{tf.path}")
 
             output = IO.read(tf.path)
           end
diff --git a/lib/chef/knife/edit.rb b/lib/chef/knife/edit.rb
index e1e9ee1b0d..caca201566 100644
--- a/lib/chef/knife/edit.rb
+++ b/lib/chef/knife/edit.rb
@@ -74,7 +74,7 @@ class Chef
 
             # Let the user edit the temporary file
             unless system("#{config[:editor]} #{file.path}")
-              raise "Please set EDITOR environment variable. See https://docs.chef.io/knife_setup.html for details."
+              raise "Please set EDITOR environment variable. See https://docs.chef.io/knife_setup/ for details."
             end
 
             result_text = IO.read(file.path)
diff --git a/lib/chef/mixin/api_version_request_handling.rb b/lib/chef/mixin/api_version_request_handling.rb
index c2f7a3203f..776190f3a4 100644
--- a/lib/chef/mixin/api_version_request_handling.rb
+++ b/lib/chef/mixin/api_version_request_handling.rb
@@ -55,7 +55,7 @@ class Chef
           The server that received the request supports a min version of #{min_version} and a max version of #{max_version}.
           User keys are now managed via the key rotation commmands.
           Please refer to the documentation on how to manage your keys via the key rotation commands:
-          https://docs.chef.io/server_security.html#key-rotation
+          https://docs.chef.io/ctl_chef_server/#key-rotation
         EOH
       end
 
diff --git a/lib/chef/provider/package/rubygems.rb b/lib/chef/provider/package/rubygems.rb
index 876a90392c..60df50ddd3 100644
--- a/lib/chef/provider/package/rubygems.rb
+++ b/lib/chef/provider/package/rubygems.rb
@@ -403,7 +403,7 @@ class Chef
                 "Gem options must be passed to gem_package as a string instead of a hash when",
                 "using this installation of #{Chef::Dist::PRODUCT} because it runs with its own packaged Ruby. A hash",
                 "may only be used when installing a gem to the same Ruby installation that #{Chef::Dist::PRODUCT} is",
-                "running under.  See https://docs.chef.io/resource_gem_package.html for more information.",
+                "running under. See https://docs.chef.io/resources/gem_package/ for more information.",
                 "Error raised at #{new_resource} from #{new_resource.source_line}",
               ].join("\n")
               raise ArgumentError, msg
diff --git a/lib/chef/resource/cron.rb b/lib/chef/resource/cron.rb
index 0f39347e0f..1c48fd42b5 100644
--- a/lib/chef/resource/cron.rb
+++ b/lib/chef/resource/cron.rb
@@ -136,7 +136,7 @@ class Chef
       end
 
       property :time, Symbol,
-        description: "A time interval. Possible values: :annually, :daily, :hourly, :midnight, :monthly, :reboot, :weekly, or :yearly.",
+        description: "A time interval.",
         equal_to: Chef::Provider::Cron::SPECIAL_TIME_VALUES
 
       property :mailto, String,
diff --git a/lib/chef/resource/cron_d.rb b/lib/chef/resource/cron_d.rb
index 420e19d707..39c86c1192 100644
--- a/lib/chef/resource/cron_d.rb
+++ b/lib/chef/resource/cron_d.rb
@@ -147,7 +147,7 @@ class Chef
       property :cookbook, String, desired_state: false
 
       property :predefined_value, String,
-        description: 'Schedule your cron job with one of the special predefined value instead of ** * pattern. This correspond to "@reboot", "@yearly", "@annually", "@monthly", "@weekly", "@daily", "@midnight" or "@hourly".',
+        description: "Schedule your cron job with one of the special predefined value instead of ** * pattern.",
         equal_to: %w{ @reboot @yearly @annually @monthly @weekly @daily @midnight @hourly }
 
       property :minute, [Integer, String],
diff --git a/lib/chef/shell/ext.rb b/lib/chef/shell/ext.rb
index 8640216d45..01a7407de5 100644
--- a/lib/chef/shell/ext.rb
+++ b/lib/chef/shell/ext.rb
@@ -211,7 +211,7 @@ module Shell
       desc "prints information about #{Chef::Dist::PRODUCT}"
       def version
         puts "Welcome to the #{Chef::Dist::SHELL} #{::Chef::VERSION}\n" +
-          "For usage see https://docs.chef.io/chef_shell.html"
+          "For usage see https://docs.chef.io/chef_shell/"
         :ucanhaz_automation
       end
       alias :shell :version